Skip to content
Filecoin Onchain Cloud Documentation
Search
Ctrl
K
Cancel
Github
X
Select theme
Dark
Light
Auto
Introduction
About Filecoin Onchain Cloud
Why Filecoin Onchain Cloud?
Core Concepts
Foundations & Architecture
Proof of Data Possession (PDP)
Filecoin Pay
Filecoin Warm Storage Service
Retrieval
Filecoin Pin
Storage Provider Tiers
Getting Started
Quick Start with Synapse SDK
Quick Start with Filecoin Pin
Developer Guides
Overview
Synapse SDK
Synapse Core
Synapse React
Payments
Payment Operations
Rails & Settlement
Session Keys
Storage
Storage Operations
Storage Costs
Upload Pipeline
Storage Upgrade
Encryption
Keysmith encryption keys
Encrypt a file
Share encrypted data
Access Control
Coming soon
Preview Packages
Migration Guide
CookBooks
Payments & Storage
Resources
Contract Addresses
Additional Resources
Community Projects
Devnet Configuration
Reference
Documentation
filecoin-encryption-envelope
filecoin-encryption-envelope
functions
decrypt
decryptRange
decryptRangeWith
decryptWith
encrypt
parse
interfaces
ByteRange
ChunkedEncryptOptions
ChunkedEnvelopeParams
RandomAccessSource
RangeResult
namespaces
aesGcm
aesGcm
functions
decrypt
decryptWith
encrypt
interfaces
EncryptOptions
constants
constants
variables
ALG_A256KW
DEFAULT_CHUNK_SIZE
ENVELOPE_TYPE
KEY_SIZE
MAX_AES_GCM_PLAINTEXT_SIZE
MAX_CHUNK_SIZE
MAX_ENCODED_OBJECT_SIZE
MIN_CHUNK_SIZE
cose
cose
functions
decodeEnvelope
interfaces
DecodedEnvelope
DecodedProtectedHeader
DecodedRecipient
type-aliases
Alg
UnprotectedHeaderMap
errors
errors
classes
AuthenticationError
ChunkCountExceededError
CriticalHeaderError
CryptoOperationError
EnvelopeError
InvalidChunkSizeError
InvalidCiphertextLengthError
InvalidKeyError
InvalidNonceError
InvalidPlaintextError
InvalidPlaintextLengthError
InvalidRangeError
InvalidSourceLengthError
KeyResolutionError
MalformedEnvelopeError
NoUsableRecipientError
RecipientAttemptLimitError
RecipientUnwrapError
UnsupportedSchemeError
recipients
recipients
functions
createA256KWUnwrapper
interfaces
A256KWKey
A256KWRecipient
A256KWUnwrapperOptions
RecipientInfo
type-aliases
Recipient
Unwrapper
type-aliases
AppMetadata
CborValue
EnvelopeInfo
KeyResolver
@filoz
keysmith
@filoz/keysmith
functions
authorizationHeader
commitment
decodeDelivery
decodeGrant
decodePresentation
delegateClaim
encodeDelivery
encodeGrant
encodePresentation
grantDescriptor
holdingOf
keyCommitmentOf
keyForEnvelope
keyResolver
keyspaceId
keyspaceKeyMessage
keyspaceKeys
lowSrs
matchesCommitment
newKeyspace
newSalt
openDelivery
pickGrant
pieceKey
pieceMetadata
pieceNode
publicKeyOf
reaches
rootClaim
scopeKey
scopeName
scopePath
signRequest
unwrapWith
verifyChain
verifyPresentation
wrapTo
writeTarget
interfaces
Claim
ClaimChain
ClaimSigner
Grant
GrantDescriptor
KeyspaceKeys
KeyspaceKeysOptions
KeyspaceRef
PieceLabels
ReadRequest
TypedDataSigner
VerifiedClaim
WriteTarget
type-aliases
GrantNode
GrantTarget
Holding
KeyspaceKeyMessage
PieceMetadata
variables
COMMITMENT_KEY
DOMAIN
KEYSPACE_ID_KEY
KEYSPACE_KEY_TYPES
MAX_CHAIN_LENGTH
MAX_REQUEST_LIFETIME
READ_GRANT_TYPES
READ_REQUEST_TYPES
synapse-core
@filoz/synapse-core
abis
abis
namespaces
generated
generated
variables
errorsAbi
errorsAddress
errorsConfig
filecoinPayV1Abi
filecoinPayV1Address
filecoinPayV1Config
filecoinWarmStorageServiceAbi
filecoinWarmStorageServiceAddress
filecoinWarmStorageServiceConfig
filecoinWarmStorageServiceStateViewAbi
filecoinWarmStorageServiceStateViewAddress
filecoinWarmStorageServiceStateViewConfig
pdpVerifierAbi
pdpVerifierAddress
pdpVerifierConfig
providerIdSetAbi
providerIdSetAddress
providerIdSetConfig
serviceProviderRegistryAbi
serviceProviderRegistryAddress
serviceProviderRegistryConfig
sessionKeyRegistryAbi
sessionKeyRegistryAddress
sessionKeyRegistryConfig
variables
erc20
erc20WithPermit
fwss
fwssView
serviceProviderRegistry
auction
auction
functions
auctionFunds
auctionInfo
auctionPriceAt
type-aliases
AuctionInfo
variables
HALVING_SECONDS
chains
chains
functions
asChain
getChain
interfaces
FilecoinChain
namespaces
asChain
asChain
type-aliases
ErrorType
getChain
getChain
type-aliases
ErrorType
variables
calibration
devnet
mainnet
core
core
functions
pageFromLookahead
paginate
resolvePagination
namespaces
paginate
paginate
type-aliases
ErrorType
GetPage
OptionsType
OutputType
resolvePagination
resolvePagination
type-aliases
ErrorType
type-aliases
AccountClient
ActionCallChain
ActionSyncCallback
ActionSyncOutput
Extended
Page
PageWithTotal
PaginatedActionCallOptions
PaginationOptions
ReadClient
SessionKeyClient
endorsements
endorsements
functions
getEndorsedProviderIds
getEndorsedProviderIdsCall
parseGetEndorsedProviderIds
namespaces
getEndorsedProviderIds
getEndorsedProviderIds
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
getEndorsedProviderIdsCall
getEndorsedProviderIdsCall
type-aliases
ErrorType
OptionsType
OutputType
erc20
erc20
functions
approve
approveCall
approveSync
balance
balanceForPermit
extractApproveEvent
namespaces
approve
approve
type-aliases
ErrorType
OptionsType
OutputType
approveCall
approveCall
type-aliases
ErrorType
OptionsType
OutputType
approveSync
approveSync
type-aliases
ErrorType
OptionsType
OutputType
balance
balance
type-aliases
ErrorType
OptionsType
OutputType
balanceForPermit
balanceForPermit
type-aliases
ErrorType
OptionsType
OutputType
errors
errors
classes
AddPiecesBatchTooLargeError
AddPiecesError
AddPiecesFlushError
AllowanceAmountError
AtLeastOnePieceRequiredError
CreateDataSetError
DataSetNotFoundError
DeletePieceError
DepositAmountError
DownloadPieceError
FindPieceError
GetDataSetError
InsufficientAllowanceError
InsufficientAvailableFundsError
InsufficientBalanceError
InvalidPieceCIDError
InvalidUploadSizeError
LimitMustBeGreaterThanZeroError
LocationHeaderError
NoEndorsedProviderError
PDPProviderUnavailableError
PostPieceError
PullError
ServiceAlreadyTerminatedError
SynapseError
TerminateServiceError
TerminateServiceNotSupportedError
TerminateServicePendingError
TooManyPiecesError
TransactionNotAppliedError
UnsupportedChainError
UploadPieceError
UploadRedirectError
ValidationError
WaitForTerminateServiceError
WaitForTerminateServiceNotFoundError
WaitForTerminateServiceRejectedError
WithdrawAmountError
ZodValidationError
functions
isSynapseError
interfaces
FindPieceErrorOptions
SynapseErrorOptions
UnreachableProvider
mocks
mocks
classes
MockRpcError
functions
dataSetCreatedLog
JSONRPC
landedLogs
landedTransactions
mockServiceProviderRegistry
pieceAddedLog
piecesScheduledForRemovalLog
PING
serviceProviderRegistryCallHandler
interfaces
EndorsementsOptions
ERC20Options
JSONRPCHooks
JSONRPCOptions
PaymentsOptions
PDPVerifierOptions
PingMockOptions
ProviderDecoded
ServiceRegistryOptions
SessionKeyRegistryOptions
WarmStorageOptions
WarmStorageViewOptions
namespaces
pdp
pdp
functions
addPiecesWithMetadataCapture
createAndAddPiecesHandler
createDataSetWithMetadataCapture
createPullResponse
decodeMetadataFromCreateDataSetExtraData
decodePieceMetadataFromExtraData
finalizePieceUploadHandler
findAnyPieceHandler
findPieceHandler
postPieceHandler
postPieceUploadsHandler
pullPiecesErrorHandler
pullPiecesHandler
pullPiecesPerPieceHandler
pullPiecesPollingHandler
pullPiecesProgressionHandler
pullPiecesWithCaptureHandler
streamingUploadHandlers
uploadPieceHandler
uploadPieceStreamingHandler
interfaces
MetadataCapture
PDPMockOptions
PieceMetadataCapture
PullRequestCapture
type-aliases
AbiToType
activeProviderCount
addProduct
ErrorResult
getProvider
getProviderByAddress
getProviderCount
getProviderIdByAddress
getProvidersByProductType
getProviderWithProduct
isProviderActive
isRegisteredProvider
LandedTransaction
ProviderWithProduct
registerProvider
removeProduct
removeProvider
RpcLog
RpcRequest
RpcResponse
Subscription
SuccessResult
updateProduct
updateProviderInfo
variables
ADDRESSES
presets
PRIVATE_KEYS
PROVIDERS
SP_SENDER
pay
pay
functions
accounts
accountsCall
calculateAccountDebt
deposit
depositAndApprove
depositCall
depositSync
depositWithPermit
depositWithPermitSync
extractDepositEvent
extractDepositWithPermitEvent
extractSetOperatorApprovalEvent
extractSettleRailEvent
extractSettleTerminatedRailWithoutValidationEvent
extractWithdrawEvent
fund
fundSync
getAccountSummary
getRail
getRailCall
getRailsForPayeeAndToken
getRailsForPayeeAndTokenCall
getRailsForPayerAndToken
getRailsForPayerAndTokenCall
isFwssMaxApproved
operatorApprovals
operatorApprovalsCall
parseAccounts
parseGetRailsForPayeeAndToken
parseGetRailsForPayerAndToken
parseOperatorApprovals
resolveAccountState
setOperatorApproval
setOperatorApprovalCall
setOperatorApprovalSync
settleRail
settleRailCall
settleRailSync
settleTerminatedRailWithoutValidation
settleTerminatedRailWithoutValidationCall
settleTerminatedRailWithoutValidationSync
totalAccountFixedLockup
withdraw
withdrawCall
withdrawSync
namespaces
accounts
accounts
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
accountsCall
accountsCall
type-aliases
ErrorType
OptionsType
OutputType
calculateAccountDebt
calculateAccountDebt
type-aliases
ParamsType
deposit
deposit
type-aliases
ErrorType
OptionsType
depositCall
depositCall
type-aliases
ErrorType
OptionsType
OutputType
depositSync
depositSync
type-aliases
ErrorType
OptionsType
OutputType
depositWithPermit
depositWithPermit
type-aliases
ErrorType
OptionsType
depositWithPermitSync
depositWithPermitSync
type-aliases
ErrorType
OptionsType
OutputType
fund
fund
type-aliases
ErrorType
OptionsType
fundSync
fundSync
type-aliases
ErrorType
OptionsType
OutputType
getAccountSummary
getAccountSummary
type-aliases
ErrorType
OptionsType
OutputType
getRail
getRail
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
getRailCall
getRailCall
type-aliases
ErrorType
OptionsType
OutputType
getRailsForPayeeAndToken
getRailsForPayeeAndToken
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
getRailsForPayeeAndTokenCall
getRailsForPayeeAndTokenCall
type-aliases
ErrorType
OptionsType
OutputType
getRailsForPayerAndToken
getRailsForPayerAndToken
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
getRailsForPayerAndTokenCall
getRailsForPayerAndTokenCall
type-aliases
ErrorType
OptionsType
OutputType
isFwssMaxApproved
isFwssMaxApproved
type-aliases
ErrorType
OptionsType
operatorApprovals
operatorApprovals
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
operatorApprovalsCall
operatorApprovalsCall
type-aliases
ErrorType
OptionsType
OutputType
resolveAccountState
resolveAccountState
type-aliases
OutputType
ParamsType
setOperatorApproval
setOperatorApproval
type-aliases
ErrorType
OptionsType
setOperatorApprovalCall
setOperatorApprovalCall
type-aliases
ErrorType
OptionsType
OutputType
setOperatorApprovalSync
setOperatorApprovalSync
type-aliases
ErrorType
OptionsType
OutputType
settleRail
settleRail
type-aliases
ErrorType
OptionsType
settleRailCall
settleRailCall
type-aliases
ErrorType
OptionsType
OutputType
settleRailSync
settleRailSync
type-aliases
ErrorType
OptionsType
OutputType
settleTerminatedRailWithoutValidation
settleTerminatedRailWithoutValidation
type-aliases
ErrorType
OptionsType
settleTerminatedRailWithoutValidationCall
settleTerminatedRailWithoutValidationCall
type-aliases
ErrorType
OptionsType
OutputType
settleTerminatedRailWithoutValidationSync
settleTerminatedRailWithoutValidationSync
type-aliases
ErrorType
OptionsType
OutputType
totalAccountFixedLockup
totalAccountFixedLockup
type-aliases
ErrorType
OptionsType
OutputType
withdraw
withdraw
type-aliases
ErrorType
OptionsType
withdrawCall
withdrawCall
type-aliases
ErrorType
OptionsType
OutputType
withdrawSync
withdrawSync
type-aliases
ErrorType
OptionsType
OutputType
type-aliases
AccountState
DepositAndApproveOptions
RailInfo
pdp-verifier
pdp-verifier
functions
dataSetLive
dataSetLiveCall
findPieceIdsByCid
findPieceIdsByCidCall
getActivePieceCount
getActivePieceCountCall
getActivePiecesByCursor
getActivePiecesByCursorCall
getContract
getDataSetLeafCount
getDataSetLeafCountCall
getDataSetLeafCounts
getDataSetListener
getDataSetListenerCall
getDataSetStorageProvider
getDataSetStorageProviderCall
getNextChallengeEpoch
getNextChallengeEpochCall
getNextPieceId
getNextPieceIdCall
getPieces
getScheduledRemovals
getScheduledRemovalsCall
parseDataSetListener
parseDataSetStorageProvider
parseGetActivePiecesByCursor
parseNextChallengeEpoch
parseScheduledRemovals
namespaces
dataSetLive
dataSetLive
type-aliases
ErrorType
OptionsType
OutputType
dataSetLiveCall
dataSetLiveCall
type-aliases
ErrorType
OptionsType
OutputType
findPieceIdsByCid
findPieceIdsByCid
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
findPieceIdsByCidCall
findPieceIdsByCidCall
type-aliases
ErrorType
OptionsType
OutputType
getActivePieceCount
getActivePieceCount
type-aliases
ErrorType
OptionsType
OutputType
getActivePieceCountCall
getActivePieceCountCall
type-aliases
ErrorType
OptionsType
OutputType
getActivePiecesByCursor
getActivePiecesByCursor
type-aliases
ContractOutputType
ErrorType
Item
OptionsType
OutputType
getActivePiecesByCursorCall
getActivePiecesByCursorCall
type-aliases
ErrorType
OptionsType
OutputType
getContract
getContract
type-aliases
ErrorType
OptionsType
OutputType
getDataSetLeafCount
getDataSetLeafCount
type-aliases
ErrorType
OptionsType
OutputType
getDataSetLeafCountCall
getDataSetLeafCountCall
type-aliases
ErrorType
OptionsType
OutputType
getDataSetLeafCounts
getDataSetLeafCounts
type-aliases
ErrorType
OptionsType
OutputType
getDataSetListener
getDataSetListener
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
getDataSetListenerCall
getDataSetListenerCall
type-aliases
ErrorType
OptionsType
OutputType
getDataSetStorageProvider
getDataSetStorageProvider
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
getDataSetStorageProviderCall
getDataSetStorageProviderCall
type-aliases
ErrorType
OptionsType
OutputType
getNextChallengeEpoch
getNextChallengeEpoch
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
getNextChallengeEpochCall
getNextChallengeEpochCall
type-aliases
ErrorType
OptionsType
OutputType
getNextPieceId
getNextPieceId
type-aliases
ErrorType
OptionsType
OutputType
getNextPieceIdCall
getNextPieceIdCall
type-aliases
ErrorType
OptionsType
OutputType
getPieces
getPieces
type-aliases
ErrorType
OptionsType
OutputType
getScheduledRemovals
getScheduledRemovals
type-aliases
ErrorType
OptionsType
OutputType
getScheduledRemovalsCall
getScheduledRemovalsCall
type-aliases
ErrorType
OptionsType
OutputType
piece
piece
classes
PieceCID
functions
calculate
chainResolver
download
downloadAndValidate
downloadStream
equals
filbeamResolver
findPieceOnProviders
from
hasher
heightFor
is
paddedSizeAtHeight
paddedSizeFor
providersResolver
resolvePieceUrl
transformStream
tryFrom
interfaces
PieceCIDTransform
PieceHasher
namespaces
download
download
type-aliases
ErrorType
OptionsType
ReturnType
downloadAndValidate
downloadAndValidate
type-aliases
ErrorType
OptionsType
ReturnType
downloadStream
downloadStream
type-aliases
ErrorType
OptionsType
ReturnType
fr32
fr32
functions
expand
reduce
merkle
merkle
functions
computeNode
truncate
zeroRoot
resolvePieceUrl
resolvePieceUrl
type-aliases
ErrorType
OptionsType
OutputType
ResolverFnOptionsType
ResolverFnType
type-aliases
CalculateInput
PieceCIDInput
variables
BYTES_PER_QUAD
CODEC_CODE
defaultResolvers
MAX_HEIGHT
MAX_SIZE
MIN_SIZE
MULTIHASH_CODE
MULTIHASH_NAME
session-key
session-key
functions
accountFromSecp256k1
authorizationExpiry
authorizationExpiryCall
extractLoginEvent
findAuthorizers
fromSecp256k1
getExpirations
isExpired
isFwssPermissionId
login
loginCall
loginSync
revoke
revokeCall
revokeSync
interfaces
AccountFromSecp256k1Options
FromSecp256k1Options
SessionKey
namespaces
authorizationExpiry
authorizationExpiry
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
authorizationExpiryCall
authorizationExpiryCall
type-aliases
ErrorType
OptionsType
OutputType
findAuthorizers
findAuthorizers
type-aliases
Authorizer
ErrorType
OptionsType
OutputType
getExpirations
getExpirations
type-aliases
ErrorType
OptionsType
OutputType
isExpired
isExpired
type-aliases
ErrorType
OptionsType
OutputType
login
login
type-aliases
ErrorType
OptionsType
OutputType
loginCall
loginCall
type-aliases
ErrorType
OptionsType
OutputType
loginSync
loginSync
type-aliases
ErrorType
OptionsType
OutputType
revoke
revoke
type-aliases
ErrorType
OptionsType
OutputType
revokeCall
revokeCall
type-aliases
ErrorType
OptionsType
OutputType
revokeSync
revokeSync
type-aliases
ErrorType
OptionsType
OutputType
type-aliases
AddPiecesPermission
CreateDataSetPermission
Expirations
FwssPermissionId
Permission
SchedulePieceRemovalsPermission
SessionKeyAccount
SessionKeyEvents
SessionKeyType
TerminateServicePermission
variables
AddPiecesPermission
CreateDataSetPermission
DEFAULT_FIND_AUTHORIZERS_BLOCK_RANGE
DefaultEmptyExpirations
DefaultFwssPermissions
extractRevokeEvent
FwssPermissions
PermissionNames
SchedulePieceRemovalsPermission
TerminateServicePermission
sp
sp
classes
AbortError
NetworkError
TimeoutError
functions
addPieces
addPiecesApiRequest
createDataSet
createDataSetAndAddPieces
createDataSetAndAddPiecesApiRequest
createDataSetApiRequest
createPieceBatcher
deletePiece
deletePieces
findPiece
getDataSet
hasPiece
isReachable
ping
prepareAddPieces
prepareCreateDataSetAndAddPieces
pullPieces
pullPiecesApiRequest
schedulePieceDeletion
schedulePieceDeletions
submitCommit
terminateService
terminateServiceApiRequest
terminateServiceStatusUrl
upload
uploadPiece
uploadPieces
uploadPieceStreaming
validateDeletePiecesBatch
waitForAddPieces
waitForCreateDataSet
waitForCreateDataSetAddPieces
waitForDeletePieces
waitForFlushReceipt
waitForPullPieces
waitForPullPiecesApiRequest
waitForTerminateService
namespaces
addPieces
addPieces
type-aliases
ErrorType
OptionsType
OutputType
PieceType
addPiecesApiRequest
addPiecesApiRequest
type-aliases
ErrorType
OptionsType
OutputType
RequestBody
createDataSet
createDataSet
type-aliases
ErrorType
OptionsType
ReturnType
createDataSetAndAddPieces
createDataSetAndAddPieces
type-aliases
ErrorType
OptionsType
ReturnType
createDataSetAndAddPiecesApiRequest
createDataSetAndAddPiecesApiRequest
type-aliases
ErrorType
OptionsType
OutputType
RequestBody
createDataSetApiRequest
createDataSetApiRequest
type-aliases
ErrorType
OptionsType
OutputType
RequestBody
createPieceBatcher
createPieceBatcher
type-aliases
OptionsType
ReturnType
deletePiece
deletePiece
type-aliases
ErrorType
OptionsType
OutputType
deletePieces
deletePieces
type-aliases
ErrorType
OptionsType
OutputType
findPiece
findPiece
type-aliases
ErrorType
OptionsType
OutputType
getDataSet
getDataSet
type-aliases
ErrorType
OptionsType
OutputType
hasPiece
hasPiece
type-aliases
ErrorType
OptionsType
OutputType
isReachable
isReachable
type-aliases
ErrorType
OptionsType
OutputType
ping
ping
type-aliases
ErrorType
OptionsType
OutputType
prepareAddPieces
prepareAddPieces
type-aliases
ErrorType
OptionsType
OutputType
prepareCreateDataSetAndAddPieces
prepareCreateDataSetAndAddPieces
type-aliases
ErrorType
OptionsType
OutputType
pullPieces
pullPieces
type-aliases
ErrorType
OptionsType
ReturnType
pullPiecesApiRequest
pullPiecesApiRequest
type-aliases
ErrorType
OptionsType
PullPieceInput
PullPieceStatus
PullStatus
RequestBody
ReturnType
schedulePieceDeletion
schedulePieceDeletion
type-aliases
ErrorType
OptionsType
OutputType
schedulePieceDeletions
schedulePieceDeletions
type-aliases
ErrorType
OptionsType
OutputType
submitCommit
submitCommit
type-aliases
ErrorType
OptionsType
OutputType
terminateService
terminateService
type-aliases
ErrorType
OptionsType
OutputType
terminateServiceApiRequest
terminateServiceApiRequest
type-aliases
ErrorType
OptionsType
OutputType
RequestBody
upload
upload
type-aliases
ErrorType
Events
OptionsType
OutputType
uploadPiece
uploadPiece
type-aliases
ErrorType
OptionsType
uploadPieces
uploadPieces
type-aliases
InputPiece
OptionsType
OutputType
UploadedPiece
uploadPieceStreaming
uploadPieceStreaming
type-aliases
ErrorType
OptionsType
OutputType
waitForAddPieces
waitForAddPieces
type-aliases
ErrorType
OptionsType
OutputType
waitForCreateDataSet
waitForCreateDataSet
type-aliases
ErrorType
OptionsType
OutputType
waitForCreateDataSetAddPieces
waitForCreateDataSetAddPieces
type-aliases
ErrorType
OptionsType
OutputType
waitForDeletePieces
waitForDeletePieces
type-aliases
ErrorType
OptionsType
OutputType
waitForFlushReceipt
waitForFlushReceipt
type-aliases
ErrorType
OptionsType
OutputType
waitForPullPieces
waitForPullPieces
type-aliases
ErrorType
OptionsType
ReturnType
waitForPullPiecesApiRequest
waitForPullPiecesApiRequest
type-aliases
ErrorType
OptionsType
ReturnType
waitForSubmission
waitForSubmission
type-aliases
ErrorType
OptionsType
OutputType
waitForTerminateService
waitForTerminateService
type-aliases
ErrorType
OptionsType
OutputType
type-aliases
AddPiecesCommit
BasePullPiecesOptions
Commit
CommitPiece
CreateDataSetAndAddPiecesCommit
CreateDataSetAndAddPiecesOptions
DataSet
EnqueuePiece
FlushResult
OnParked
OnSubmitted
PieceBatcher
PieceBatcherWait
PieceResult
PullInput
PullPieceInput
PullPieceResult
PullToExistingDataSetOptions
PullToNewDataSetOptions
PullWaitOptions
SubmittedBatch
SubmittedPiece
TerminateServiceStatusPending
TerminateServiceStatusResponse
TerminateServiceStatusSuccess
UploadInput
UploadPieceStreamingData
UploadResult
variables
DataSetSchema
TerminateServiceStatusPendingSchema
TerminateServiceStatusSuccessSchema
sp-registry
sp-registry
functions
activeProviderCount
activeProviderCountCall
addProduct
addProductCall
addProductSync
extractAddProductEvent
extractRegisterProviderEvent
extractRemoveProductEvent
extractRemoveProviderEvent
extractUpdateProductEvent
extractUpdateProviderInfoEvent
getApprovedPDPProviders
getPDPProvider
getPDPProviderByAddress
getPDPProviderCall
getPDPProviders
getPDPProvidersByIds
getPDPProvidersCall
getProviderCount
getProviderCountCall
getProviderIdByAddress
getProviderIdByAddressCall
getProvidersByProductType
getProvidersByProductTypeCall
getProviderWithProduct
getProviderWithProductCall
hasActivePDPProduct
isProviderActive
isProviderActiveCall
isRegisteredProvider
isRegisteredProviderCall
parsePDPProvider
parsePDPProviders
registerProvider
registerProviderCall
registerProviderSync
removeProduct
removeProductCall
removeProductSync
removeProvider
removeProviderCall
removeProviderSync
updateProduct
updateProductCall
updateProductSync
updateProviderInfo
updateProviderInfoCall
updateProviderInfoSync
validateCapabilities
validateLocation
validatePayee
validateProductType
validateProviderInfo
validateRegistrationFee
interfaces
PDPOffering
PDPProvider
namespaces
activeProviderCount
activeProviderCount
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
activeProviderCountCall
activeProviderCountCall
type-aliases
ErrorType
OptionsType
OutputType
addProduct
addProduct
type-aliases
ErrorType
OptionsType
OutputType
addProductCall
addProductCall
type-aliases
ErrorType
OptionsType
OutputType
addProductSync
addProductSync
type-aliases
ErrorType
OptionsType
OutputType
getApprovedPDPProviders
getApprovedPDPProviders
type-aliases
ErrorType
OptionsType
OutputType
getPDPProvider
getPDPProvider
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
getPDPProviderByAddress
getPDPProviderByAddress
type-aliases
ErrorType
OptionsType
OutputType
getPDPProviderCall
getPDPProviderCall
type-aliases
ErrorType
OptionsType
OutputType
getPDPProviders
getPDPProviders
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
getPDPProvidersByIds
getPDPProvidersByIds
type-aliases
ErrorType
OptionsType
OutputType
getPDPProvidersCall
getPDPProvidersCall
type-aliases
ErrorType
OptionsType
OutputType
getProviderCount
getProviderCount
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
getProviderCountCall
getProviderCountCall
type-aliases
ErrorType
OptionsType
OutputType
getProviderIdByAddress
getProviderIdByAddress
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
getProviderIdByAddressCall
getProviderIdByAddressCall
type-aliases
ErrorType
OptionsType
OutputType
getProvidersByProductType
getProvidersByProductType
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
getProvidersByProductTypeCall
getProvidersByProductTypeCall
type-aliases
ErrorType
OptionsType
OutputType
getProviderWithProduct
getProviderWithProduct
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
getProviderWithProductCall
getProviderWithProductCall
type-aliases
ErrorType
OptionsType
OutputType
isProviderActive
isProviderActive
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
isProviderActiveCall
isProviderActiveCall
type-aliases
ErrorType
OptionsType
OutputType
isRegisteredProvider
isRegisteredProvider
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
isRegisteredProviderCall
isRegisteredProviderCall
type-aliases
ErrorType
OptionsType
OutputType
registerProvider
registerProvider
type-aliases
ErrorType
OptionsType
OutputType
registerProviderCall
registerProviderCall
type-aliases
ErrorType
OptionsType
OutputType
registerProviderSync
registerProviderSync
type-aliases
ErrorType
OptionsType
OutputType
removeProduct
removeProduct
type-aliases
ErrorType
OptionsType
OutputType
removeProductCall
removeProductCall
type-aliases
ErrorType
OptionsType
OutputType
removeProductSync
removeProductSync
type-aliases
ErrorType
OptionsType
OutputType
removeProvider
removeProvider
type-aliases
ErrorType
OptionsType
OutputType
removeProviderCall
removeProviderCall
type-aliases
ErrorType
OptionsType
OutputType
removeProviderSync
removeProviderSync
type-aliases
ErrorType
OptionsType
OutputType
updateProduct
updateProduct
type-aliases
ErrorType
OptionsType
OutputType
updateProductCall
updateProductCall
type-aliases
ErrorType
OptionsType
OutputType
updateProductSync
updateProductSync
type-aliases
ErrorType
OptionsType
OutputType
updateProviderInfo
updateProviderInfo
type-aliases
ErrorType
OptionsType
OutputType
updateProviderInfoCall
updateProviderInfoCall
type-aliases
ErrorType
OptionsType
OutputType
updateProviderInfoSync
updateProviderInfoSync
type-aliases
ErrorType
OptionsType
OutputType
type-aliases
getProviderWithProductType
ProductType
ProviderInfo
ProviderWithProduct
variables
PRODUCTS
typed-data
typed-data
functions
getStorageDomain
signAddPieces
signCreateDataSet
signCreateDataSetAndAddPieces
signErc20Permit
signSchedulePieceRemovals
signTerminateService
interfaces
GetStorageDomainOptions
namespaces
signAddPieces
signAddPieces
type-aliases
ErrorType
OptionsType
ReturnType
signCreateDataSet
signCreateDataSet
type-aliases
ErrorType
OptionsType
ReturnType
signCreateDataSetAndAddPieces
signCreateDataSetAndAddPieces
type-aliases
ErrorType
OptionsType
ReturnType
type-aliases
MetadataEntry
SignAddPiecesOptions
signCreateDataSetOptions
SignErc20PermitOptions
SignSchedulePieceRemovalsOptions
SignTerminateServiceOptions
TypedDataType
variables
EIP712Types
signAddPiecesAbiParameters
signCreateDataSetAbiParameters
signcreateDataSetAndAddPiecesAbiParameters
usdfc
usdfc
functions
watchUsdfc
utils
utils
functions
abortable
addPiecesFits
assertAddPiecesFit
assertPieceCidSize
assertPieceValid
calculateBufferAmountFromState
calculateLastProofDate
calculateRunwayAmountFromState
calculateUploadCosts
capabilitiesListToObject
checkAddPiecesFit
claimTokens
clientFromTransport
createLimit
createPieceUrl
createPieceUrlFilBeam
createPieceUrlPDP
datasetMetadataObjectToEntry
dateToEpoch
decodeAddressCapability
decodePDPCapabilities
decodePDPError
decodePDPOffering
dedupePieces
encodePDPCapabilities
epochsToDays
epochsToHours
epochToDate
estimateAddPiecesCalldataSize
fallbackRandIndex
fallbackRandU256
formatBalance
formatFraction
formatUnits
getPayerAddress
isAsyncIterable
isNullRoundError
isProviderExistsRevert
isReadableStream
isUint8Array
isViemError
leafCountToRawSize
mapWithLimit
maxFittingPieces
metadataArrayToObject
parseUnits
pieceMetadataObjectToEntry
pieceSizesToLeafCount
randIndex
randU256
rawSizeToLeafCount
readableStreamFromAsyncIterable
readAllBytes
stringErrorEquals
supportsStreamingFetchBody
throwIfAborted
timeUntilEpoch
transportFromTransportConfig
validatePieceSizes
waitForTransactionReceipt
withSignal
interfaces
MetadataDataSetInternal
MetadataPieceInternal
namespaces
addPiecesFits
addPiecesFits
type-aliases
ErrorType
OptionsType
OutputType
assertAddPiecesFit
assertAddPiecesFit
type-aliases
ErrorType
OptionsType
assertPieceCidSize
assertPieceCidSize
type-aliases
ErrorType
assertPieceValid
assertPieceValid
type-aliases
ErrorType
calculateUploadCosts
calculateUploadCosts
type-aliases
AccountType
ContextType
OptionsType
OutputType
checkAddPiecesFit
checkAddPiecesFit
type-aliases
ErrorType
OptionsType
OutputType
createPieceUrl
createPieceUrl
type-aliases
OptionsType
OutputType
createPieceUrlFilBeam
createPieceUrlFilBeam
type-aliases
OptionsType
OutputType
createPieceUrlPDP
createPieceUrlPDP
type-aliases
OptionsType
OutputType
dedupePieces
dedupePieces
type-aliases
ReturnType
estimateAddPiecesCalldataSize
estimateAddPiecesCalldataSize
type-aliases
ErrorType
OptionsType
OutputType
maxFittingPieces
maxFittingPieces
type-aliases
ErrorType
OptionsType
OutputType
type-aliases
AddPiecesFitResult
CalculateBufferAmountFromStateOptions
CalculateRunwayAmountFromStateOptions
ClaimTokenResponse
ClaimTokenResponseError
ClaimTokensOptions
DroppedPiece
FormatUnitsOptions
Limit
Limiter
LimiterOptions
LimiterPiece
MetadataArray
MetadataEntry
MetadataObject
StringErrorType
variables
DEFAULT_BUFFER_EPOCHS
DEFAULT_RUNWAY_EPOCHS
METADATA_LIMITS
PDP_OFFERING_KEYS
PDP_OFFERING_KEYS_SET
PDPOfferingSchema
RETRY_CONSTANTS
SERVICE_PROVIDER_REGISTRY
SIZE_CONSTANTS
STRING_ERRORS
TIME_CONSTANTS
zAddress
zAddressLoose
zHex
zNumberToBigInt
zPieceCid
zPieceCidString
zStringToCid
warm-storage
warm-storage
functions
addApprovedProvider
addApprovedProviderCall
addApprovedProviderSync
calculateAdditionalLockupRequired
calculateDepositNeeded
calculateEffectiveRate
calculateLifecycleReserveFunding
calculateUploadFees
estimateOnboardingCost
estimateStorageCost
extractAddApprovedProviderEvent
extractPDPPaymentTerminatedEvent
extractRemoveApprovedProviderEvent
extractTerminateServiceEvent
fetchProviderSelectionInput
findMatchingDataSets
getAccountTotalStorageSize
getAddPiecesResult
getAllDataSetMetadata
getAllDataSetMetadataCall
getApprovedProviderIds
getApprovedProviderIdsCall
getClientDataSetIds
getClientDataSetIdsCall
getClientDataSets
getClientDataSetsCall
getClientDataSetsLength
getClientDataSetsLengthCall
getClientNonce
getClientNonceCall
getCreateDataSetAndAddPiecesResult
getCreateDataSetResult
getDataSet
getDataSetCall
getDataSetsById
getPdpDataSet
getPdpDataSets
getPriceList
getPriceListCall
getUploadCosts
metadataMatches
parseAllDataSetMetadata
parseGetDataSet
readAddresses
readPdpDataSetInfo
removeApprovedProvider
removeApprovedProviderCall
removeApprovedProviderSync
resolveProviderLocations
selectProviders
selectReachableProviders
terminateService
terminateServiceCall
terminateServiceSync
interfaces
PdpDataSet
Piece
ProviderSelectionInput
ProviderSelectionOptions
ResolvedLocation
SelectionDataSet
namespaces
addApprovedProvider
addApprovedProvider
type-aliases
ErrorType
OptionsType
OutputType
addApprovedProviderCall
addApprovedProviderCall
type-aliases
ErrorType
OptionsType
OutputType
addApprovedProviderSync
addApprovedProviderSync
type-aliases
ErrorType
OptionsType
OutputType
calculateAdditionalLockupRequired
calculateAdditionalLockupRequired
type-aliases
OutputType
ParamsType
calculateDepositNeeded
calculateDepositNeeded
type-aliases
OutputType
ParamsType
calculateEffectiveRate
calculateEffectiveRate
type-aliases
OutputType
ParamsType
calculateLifecycleReserveFunding
calculateLifecycleReserveFunding
type-aliases
OutputType
ParamsType
calculateUploadFees
calculateUploadFees
type-aliases
OutputType
ParamsType
estimateOnboardingCost
estimateOnboardingCost
type-aliases
OutputType
ParamsType
estimateStorageCost
estimateStorageCost
type-aliases
OutputType
ParamsType
fetchProviderSelectionInput
fetchProviderSelectionInput
type-aliases
ErrorType
OptionsType
OutputType
getAccountTotalStorageSize
getAccountTotalStorageSize
type-aliases
ErrorType
OptionsType
OutputType
getAddPiecesResult
getAddPiecesResult
type-aliases
ErrorType
OptionsType
OutputType
getAllDataSetMetadata
getAllDataSetMetadata
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
getAllDataSetMetadataCall
getAllDataSetMetadataCall
type-aliases
ErrorType
OptionsType
OutputType
getApprovedProviderIds
getApprovedProviderIds
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
getApprovedProviderIdsCall
getApprovedProviderIdsCall
type-aliases
ErrorType
OptionsType
OutputType
getClientDataSetIds
getClientDataSetIds
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
getClientDataSetIdsCall
getClientDataSetIdsCall
type-aliases
ErrorType
OptionsType
OutputType
getClientDataSets
getClientDataSets
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
getClientDataSetsCall
getClientDataSetsCall
type-aliases
ErrorType
OptionsType
OutputType
getClientDataSetsLength
getClientDataSetsLength
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
getClientDataSetsLengthCall
getClientDataSetsLengthCall
type-aliases
ErrorType
OptionsType
OutputType
getClientNonce
getClientNonce
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
getClientNonceCall
getClientNonceCall
type-aliases
ErrorType
OptionsType
OutputType
getCreateDataSetAndAddPiecesResult
getCreateDataSetAndAddPiecesResult
type-aliases
ErrorType
OptionsType
OutputType
getCreateDataSetResult
getCreateDataSetResult
type-aliases
ErrorType
OptionsType
OutputType
getDataSet
getDataSet
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
getDataSetCall
getDataSetCall
type-aliases
ErrorType
OptionsType
OutputType
getDataSetsById
getDataSetsById
type-aliases
ErrorType
OptionsType
OutputType
getPdpDataSet
getPdpDataSet
type-aliases
ErrorType
OptionsType
OutputType
getPdpDataSets
getPdpDataSets
type-aliases
ErrorType
OptionsType
OutputType
getPriceList
getPriceList
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
getPriceListCall
getPriceListCall
type-aliases
ErrorType
OptionsType
OutputType
getUploadCosts
getUploadCosts
type-aliases
ErrorType
OptionsType
OutputType
readAddresses
readAddresses
type-aliases
ErrorType
OptionsType
OutputType
removeApprovedProvider
removeApprovedProvider
type-aliases
ErrorType
OptionsType
OutputType
removeApprovedProviderCall
removeApprovedProviderCall
type-aliases
ErrorType
OptionsType
OutputType
removeApprovedProviderSync
removeApprovedProviderSync
type-aliases
ErrorType
OptionsType
OutputType
resolveProviderLocations
resolveProviderLocations
type-aliases
ErrorType
OptionsType
OutputType
selectReachableProviders
selectReachableProviders
type-aliases
ErrorType
OptionsType
OutputType
terminateService
terminateService
type-aliases
ErrorType
OptionsType
OutputType
terminateServiceCall
terminateServiceCall
type-aliases
ErrorType
OptionsType
OutputType
terminateServiceSync
terminateServiceSync
type-aliases
ErrorType
OptionsType
OutputType
type-aliases
DataSetInfo
PdpDataSetInfo
synapse-react
@filoz/synapse-react
functions
assertSessionKey
getSignerClient
useAccountInfo
useAddUsdfc
useApproveAllowance
useApproveOperator
useCreateDataSet
useDataSets
useDeletePiece
useDeposit
useDepositAndApprove
useERC20Balance
useFundWallet
useOperatorApprovals
usePriceList
useProviders
useRevokeOperator
useUpload
useUploadPieces
useUploadSimple
useWithdraw
interfaces
DataSetWithPieces
SessionKeySignerOptions
UploadedPiece
UploadPiecesFileProgress
UseAccountInfoProps
UseApproveAllowanceProps
UseCreateDataSetProps
UseCreateDataSetVariables
UseDataSetsProps
UseDeletePieceProps
UseDeletePieceVariables
UseDepositAndApproveProps
UseDepositProps
UseERC20BalanceProps
UseFundWalletProps
UseOperatorApprovalsProps
UsePriceListProps
UseProvidersProps
UseUploadPiecesProps
UseUploadPiecesResult
UseUploadPiecesVariables
UseUploadProps
UseUploadSimpleProps
UseUploadSimpleVariables
UseUploadVariables
UseWatchUsdfcProps
type-aliases
ApproveOperatorProps
RevokeOperatorProps
UseApproveAllowanceVariables
UseCreateDataSetResult
UseDataSetsResult
UseDeletePieceResult
UseDepositAndApproveVariables
UseDepositVariables
UsePriceListResult
UseProvidersResult
UseWithdrawProps
UseWithdrawVariables
synapse-sdk
@filoz/synapse-sdk
FilBeam
FilBeam
classes
FilBeamService
interfaces
DataSetStats
GetDataSetStatsOptions
Payments
Payments
classes
PaymentsService
interfaces
DepositOptions
SPRegistry
SPRegistry
classes
SPRegistryService
interfaces
PDPOffering
PDPServiceInfo
ProviderInfo
ProviderRegistrationInfo
ServiceProduct
type-aliases
PRODUCTS
ProductType
Storage
Storage
classes
StorageContext
StorageManager
interfaces
StorageContextOptions
StorageManagerDownloadOptions
StorageManagerOptions
StorageManagerUploadOptions
type-aliases
CombinedCallbacks
StorageManagerDownloadStreamOptions
Synapse
Synapse
classes
CommitError
StoreError
Synapse
functions
asChain
formatUnits
getChain
parseUnits
interfaces
BaseContextOptions
CommitBaseOptions
CommitResult
ContextCreateContextsOptions
CopyResult
CreateContextsOptions
DataSetData
DataSetInfo
DataSetPieceData
EnhancedDataSetInfo
FailedAttempt
FilecoinChain
PDPProvider
PieceBatchingOptions
PieceCID
PieceFetchOptions
PieceRecord
PieceRetriever
PieceStatus
PrepareOptions
PrepareResult
ProviderSelectionResult
PullBaseOptions
PullResult
SettlementResult
StorageContextCallbacks
StorageContextCreateOptions
StorageErrorOptions
StorageInfo
StorageOptions
StorageServiceOptions
StoreOptions
StoreResult
SynapseFromClientOptions
SynapseOptions
TerminateServiceOptions
TerminateServiceResult
UploadCallbacks
UploadOptions
UploadResult
UploadTask
namespaces
asChain
asChain
type-aliases
ErrorType
getChain
getChain
type-aliases
ErrorType
getPriceList
getPriceList
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
getUploadCosts
getUploadCosts
type-aliases
ErrorType
OptionsType
OutputType
type-aliases
AddPiecesCommit
Commit
CommitOptions
CommitPiece
CopyRole
CreateDataSetAndAddPiecesCommit
DataSetId
DownloadOptions
DownloadStreamOptions
FilecoinNetworkType
FundOptions
getPriceList
getUploadCosts
GetUploadCostsOptions
MetadataEntry
MetadataObject
PieceBatcherWait
PrivateKey
PullOptions
PullSource
PullStatus
RailInfo
ServiceProvider
TokenAmount
TokenIdentifier
UploadCosts
variables
calibration
DEFAULT_CHAIN
devnet
mainnet
METADATA_KEYS
SIZE_CONSTANTS
TIME_CONSTANTS
TOKENS
WarmStorage
WarmStorage
classes
WarmStorageService
Github
X
Select theme
Dark
Light
Auto
isReachable
Copy Markdown
Open
Open in ChatGPT
Open in Claude
View in Markdown
Type Aliases
Section titled “Type Aliases”
Type Alias
Description
ErrorType
-
OptionsType
-
OutputType
-
