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
Getting Started
Quick Start with Synapse SDK
Developer Guides
Migration Guide
Synapse SDK
Components
Payments
Payment Operations
Rails & Settlement
Storage
Storage Operations
Storage Costs
Storage Context
React Integration
Devnet Configuration
CookBooks
Filecoin Pay
Resources
Contract Addresses
Additional Resources
Changelogs
@filoz/synapse-sdk
@filoz/synapse-core
@filoz/synapse-react
Reference
Documentation
@filoz
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
storage
auction
auction
functions
auctionFunds
auctionInfo
auctionPriceAt
type-aliases
AuctionInfo
variables
HALVING_SECONDS
chains
chains
functions
asChain
getChain
interfaces
Chain
namespaces
asChain
asChain
type-aliases
ErrorType
variables
calibration
devnet
mainnet
core
core
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
AddPiecesError
AllowanceAmountError
CreateDataSetError
DeletePieceError
DepositAmountError
DownloadPieceError
FindPieceError
GetDataSetError
InsufficientAllowanceError
InsufficientAvailableFundsError
InsufficientBalanceError
InvalidUploadSizeError
LocationHeaderError
PostPieceError
SynapseError
UnsupportedChainError
UploadPieceError
ValidationError
WaitDataSetCreationStatusError
WaitForAddPiecesStatusError
WithdrawAmountError
ZodValidationError
functions
isSynapseError
interfaces
SynapseErrorOptions
mocks
mocks
functions
JSONRPC
mockServiceProviderRegistry
PING
interfaces
PingMockOptions
namespaces
pdp
pdp
functions
addPiecesWithMetadataCapture
createAndAddPiecesHandler
createDataSetWithMetadataCapture
dataSetCreationStatusHandler
decodeMetadataFromCreateDataSetExtraData
decodePieceMetadataFromExtraData
finalizePieceUploadHandler
findAnyPieceHandler
findPieceHandler
pieceAdditionStatusHandler
postPieceHandler
postPieceUploadsHandler
streamingUploadHandlers
uploadPieceHandler
uploadPieceStreamingHandler
interfaces
MetadataCapture
PDPMockOptions
PieceMetadataCapture
variables
ADDRESSES
presets
PRIVATE_KEYS
PROVIDERS
pay
pay
functions
accounts
accountsCall
deposit
depositAndApprove
depositCall
depositSync
extractDepositEvent
extractSetOperatorApprovalEvent
extractSettleRailEvent
extractSettleTerminatedRailWithoutValidationEvent
extractWithdrawEvent
getRail
getRailCall
getRailsForPayeeAndToken
getRailsForPayeeAndTokenCall
getRailsForPayerAndToken
getRailsForPayerAndTokenCall
operatorApprovals
operatorApprovalsCall
parseAccounts
parseGetRailsForPayeeAndToken
parseGetRailsForPayerAndToken
parseOperatorApprovals
setOperatorApproval
setOperatorApprovalCall
setOperatorApprovalSync
settleRail
settleRailCall
settleRailSync
settleTerminatedRailWithoutValidation
settleTerminatedRailWithoutValidationCall
settleTerminatedRailWithoutValidationSync
withdraw
withdrawCall
withdrawSync
namespaces
accounts
accounts
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
accountsCall
accountsCall
type-aliases
ErrorType
OptionsType
OutputType
deposit
deposit
type-aliases
ErrorType
OptionsType
depositCall
depositCall
type-aliases
ErrorType
OptionsType
OutputType
depositSync
depositSync
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
RailInfo
getRailsForPayeeAndTokenCall
getRailsForPayeeAndTokenCall
type-aliases
ErrorType
OptionsType
OutputType
getRailsForPayerAndToken
getRailsForPayerAndToken
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
RailInfo
getRailsForPayerAndTokenCall
getRailsForPayerAndTokenCall
type-aliases
ErrorType
OptionsType
OutputType
operatorApprovals
operatorApprovals
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
operatorApprovalsCall
operatorApprovalsCall
type-aliases
ErrorType
OptionsType
OutputType
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
withdraw
withdraw
type-aliases
ErrorType
OptionsType
withdrawCall
withdrawCall
type-aliases
ErrorType
OptionsType
OutputType
withdrawSync
withdrawSync
type-aliases
ErrorType
OptionsType
OutputType
type-aliases
DepositAndApproveOptions
pdp-verifier
pdp-verifier
functions
dataSetLive
dataSetLiveCall
getActivePieceCount
getActivePieceCountCall
getActivePieces
getActivePiecesCall
getContract
getDataSetLeafCount
getDataSetLeafCountCall
getDataSetListener
getDataSetListenerCall
getDataSetStorageProvider
getDataSetStorageProviderCall
getNextPieceId
getNextPieceIdCall
getScheduledRemovals
getScheduledRemovalsCall
namespaces
dataSetLive
dataSetLive
type-aliases
ErrorType
OptionsType
OutputType
dataSetLiveCall
dataSetLiveCall
type-aliases
ErrorType
OptionsType
OutputType
getActivePieceCount
getActivePieceCount
type-aliases
ErrorType
OptionsType
OutputType
getActivePieceCountCall
getActivePieceCountCall
type-aliases
ErrorType
OptionsType
OutputType
getActivePieces
getActivePieces
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
getActivePiecesCall
getActivePiecesCall
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
getDataSetListener
getDataSetListener
type-aliases
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
getNextPieceId
getNextPieceId
type-aliases
ErrorType
OptionsType
OutputType
getNextPieceIdCall
getNextPieceIdCall
type-aliases
ErrorType
OptionsType
OutputType
getScheduledRemovals
getScheduledRemovals
type-aliases
ErrorType
OptionsType
OutputType
getScheduledRemovalsCall
getScheduledRemovalsCall
type-aliases
ErrorType
OptionsType
OutputType
piece
piece
functions
asLegacyPieceCID
asPieceCID
calculate
calculateFromIterable
createPieceCIDStream
downloadAndValidate
getSize
getSizeFromPieceCID
hexToPieceCID
isPieceCID
parse
type-aliases
LegacyPieceCID
PieceCID
session-key
session-key
classes
Secp256k1Key
functions
authorizationExpiry
authorizationExpiryCall
getPermissionFromTypeHash
isExpired
login
revoke
interfaces
Secp256k1SessionKeyCreateOptions
Secp256k1SessionKeyProps
SessionKey
namespaces
authorizationExpiry
authorizationExpiry
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
authorizationExpiryCall
authorizationExpiryCall
type-aliases
ErrorType
OptionsType
OutputType
type-aliases
IsExpiredOptions
LoginOptions
RevokeOptions
SessionKeyPermissions
WalletEvents
variables
ALL_PERMISSIONS
SESSION_KEY_PERMISSIONS
sp
sp
classes
AbortError
NetworkError
TimeoutError
functions
addPieces
createDataSet
createDataSetAndAddPieces
deletePiece
downloadPiece
findPiece
getDataSet
getPiecesForDataSet
ping
resetTimeout
setTimeout
uploadPiece
uploadPieceStreaming
waitForAddPiecesStatus
waitForDataSetCreationStatus
namespaces
addPieces
addPieces
type-aliases
ErrorType
OptionsType
RequestBody
ReturnType
createDataSet
createDataSet
type-aliases
ErrorType
OptionsType
RequestBody
ReturnType
createDataSetAndAddPieces
createDataSetAndAddPieces
type-aliases
ErrorType
OptionsType
RequestBody
ReturnType
deletePiece
deletePiece
type-aliases
ErrorType
OptionsType
ReturnType
downloadPiece
downloadPiece
type-aliases
ErrorType
OptionsType
ReturnType
findPiece
findPiece
type-aliases
ErrorType
OptionsType
ReturnType
getDataSet
getDataSet
type-aliases
ErrorType
OptionsType
ReturnType
getPiecesForDataSet
getPiecesForDataSet
type-aliases
ErrorType
OptionsType
ReturnType
uploadPiece
uploadPiece
type-aliases
ErrorType
OptionsType
waitForAddPiecesStatus
waitForAddPiecesStatus
type-aliases
ErrorType
OptionsType
ReturnType
waitForDataSetCreationStatus
waitForDataSetCreationStatus
type-aliases
ErrorType
OptionsType
ReturnType
type-aliases
AddPiecesResponse
AddPiecesSuccess
DataSetCreatedResponse
DataSetCreateSuccess
SPPiece
SPPieceWithUrl
UploadPieceResponse
UploadPieceStreamingOptions
variables
FACTOR
MIN_TIMEOUT
RETRIES
typed-data
typed-data
functions
getStorageDomain
signAddPieces
signCreateDataSet
signCreateDataSetAndAddPieces
signErc20Permit
signSchedulePieceRemovals
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
TypedDataType
variables
EIP712Types
signAddPiecesAbiParameters
signCreateDataSetAbiParameters
signcreateDataSetAndAddPiecesAbiParameters
usdfc
usdfc
functions
watchUsdfc
utils
utils
functions
asReadableStream
asyncIterableToReadableStream
capabilitiesListToObject
claimTokens
clientFromTransport
createPieceUrl
createPieceUrlPDP
datasetMetadataObjectToEntry
decodeAddressCapability
decodePDPCapabilities
decodePDPError
encodePDPCapabilities
fallbackRandIndex
fallbackRandU256
formatBalance
formatFraction
isAsyncIterable
isReadableStream
metadataArrayToObject
pieceMetadataObjectToEntry
randIndex
randU256
transportFromTransportConfig
uint8ArrayToAsyncIterable
interfaces
MetadataDataSetInternal
MetadataPieceInternal
type-aliases
ClaimTokenResponse
ClaimTokenResponseError
ClaimTokensOptions
MetadataArray
MetadataEntry
MetadataObject
variables
CAP_IPNI_IPFS
CAP_IPNI_PEER_ID
CAP_IPNI_PIECE
CAP_LOCATION
CAP_MAX_PIECE_SIZE
CAP_MIN_PIECE_SIZE
CAP_MIN_PROVING_PERIOD
CAP_PAYMENT_TOKEN
CAP_SERVICE_URL
CAP_STORAGE_PRICE
LOCKUP_PERIOD
METADATA_LIMITS
RETRY_CONSTANTS
SIZE_CONSTANTS
TIME_CONSTANTS
warm-storage
warm-storage
functions
addApprovedProvider
addApprovedProviderCall
addApprovedProviderSync
addPieces
createDataSet
createDataSetAndAddPieces
deletePiece
extractAddApprovedProviderEvent
extractRemoveApprovedProviderEvent
formatAllDataSetMetadata
formatAllPieceMetadata
getAllDataSetMetadata
getAllDataSetMetadataCall
getAllPieceMetadata
getAllPieceMetadataCall
getApprovedProviders
getApprovedProvidersCall
getDataSet
getDataSets
getPieces
getProvider
getServicePrice
getServicePriceCall
readAddresses
readProviders
removeApprovedProvider
removeApprovedProviderCall
removeApprovedProviderSync
terminateDataSet
upload
waitForDeletePieceStatus
interfaces
DataSet
Events
GetDataSetsOptions
PDPOffering
PDPProvider
namespaces
addApprovedProvider
addApprovedProvider
type-aliases
ErrorType
OptionsType
OutputType
addApprovedProviderCall
addApprovedProviderCall
type-aliases
ErrorType
OptionsType
OutputType
addApprovedProviderSync
addApprovedProviderSync
type-aliases
ErrorType
OptionsType
OutputType
createDataSetAndAddPieces
createDataSetAndAddPieces
type-aliases
ErrorType
OptionsType
ReturnType
getAllDataSetMetadata
getAllDataSetMetadata
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
getAllDataSetMetadataCall
getAllDataSetMetadataCall
type-aliases
ErrorType
OptionsType
OutputType
getAllPieceMetadata
getAllPieceMetadata
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
getAllPieceMetadataCall
getAllPieceMetadataCall
type-aliases
ErrorType
OptionsType
OutputType
getApprovedProviders
getApprovedProviders
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
getApprovedProvidersCall
getApprovedProvidersCall
type-aliases
ErrorType
OptionsType
OutputType
getServicePrice
getServicePrice
type-aliases
ContractOutputType
ErrorType
OptionsType
OutputType
getServicePriceCall
getServicePriceCall
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
type-aliases
AddPiecesOptions
ClientDataSet
CreateDataSetAndAddPiecesOptions
CreateDataSetOptions
DeletePieceOptions
getClientDataSetsType
GetDataSetOptions
GetPiecesOptions
GetProviderOptions
getProviderType
Piece
PieceInputWithMetadata
ReadAddressesResult
ServiceProviderInfo
TerminateDataSetOptions
UploadOptions
WaitForDeletePieceStatusOptions
synapse-react
@filoz/synapse-react
functions
useAccountInfo
useAddUsdfc
useApproveAllowance
useApproveOperator
useCreateDataSet
useDataSets
useDeletePiece
useDeposit
useDepositAndApprove
useERC20Balance
useFundWallet
useOperatorApprovals
useProviders
useRevokeOperator
useServicePrice
useUpload
useWithdraw
interfaces
DataSetWithPieces
UseAccountInfoProps
UseApproveAllowanceProps
UseCreateDataSetProps
UseCreateDataSetVariables
UseDataSetsProps
UseDeletePieceProps
UseDeletePieceVariables
UseDepositAndApproveProps
UseDepositProps
UseERC20BalanceProps
UseFundWalletProps
UseOperatorApprovalsProps
UseProvidersProps
UseServicePriceProps
UseUploadProps
UseUploadVariables
UseWatchUsdfcProps
type-aliases
ApproveOperatorProps
PieceWithMetadata
RevokeOperatorProps
UseApproveAllowanceVariables
UseCreateDataSetResult
UseDataSetsResult
UseDepositAndApproveVariables
UseDepositVariables
UseProvidersResult
UseServicePriceResult
UseWithdrawProps
UseWithdrawVariables
synapse-sdk
@filoz/synapse-sdk
FilBeam
FilBeam
classes
FilBeamService
interfaces
DataSetStats
Payments
Payments
classes
PaymentsService
interfaces
DepositOptions
PDP
PDP
classes
PDPServer
PDPVerifier
interfaces
AddPiecesResponse
CreateDataSetResponse
UploadPieceOptions
namespaces
PDPServer
PDPServer
type-aliases
ErrorType
OptionsType
PDPVerifier
PDPVerifier
type-aliases
OptionsType
Session
Session
classes
SessionKey
SPRegistry
SPRegistry
classes
SPRegistryService
interfaces
PDPOffering
PDPServiceInfo
ProviderRegistrationInfo
ServiceProduct
type-aliases
PRODUCTS
ProductType
Storage
Storage
classes
StorageContext
StorageManager
interfaces
StorageManagerDownloadOptions
StorageManagerUploadOptions
type-aliases
CombinedCallbacks
Subgraph
Subgraph
classes
SubgraphService
interfaces
DetailedSubgraphDataSetInfo
FaultRecord
NestedQueryOptions
PaginationOptions
PieceInfo
ProviderStats
QueryOptions
SubgraphDataSetInfo
Synapse
Synapse
classes
Synapse
interfaces
AuthSignature
CreateContextsOptions
DataSetData
DataSetInfo
DataSetPieceData
EnhancedDataSetInfo
PieceRecord
PieceRetriever
PieceStatus
PreflightInfo
ProviderInfo
ProviderSelectionResult
RailInfo
SettlementResult
StorageContextCallbacks
StorageInfo
StorageOptions
StorageServiceOptions
SubgraphConfig
SubgraphRetrievalService
SynapseOptions
UploadCallbacks
UploadOptions
UploadResult
UploadTask
type-aliases
DataSetId
DownloadOptions
FilecoinNetworkType
MetadataEntry
PieceCID
PrivateKey
ServiceProvider
TokenAmount
TokenIdentifier
variables
CHAIN_IDS
CONTRACT_ABIS
CONTRACT_ADDRESSES
EIP2612_PERMIT_TYPES
GENESIS_TIMESTAMPS
METADATA_KEYS
RPC_URLS
SIZE_CONSTANTS
TIME_CONSTANTS
TIMING_CONSTANTS
TOKENS
WarmStorage
WarmStorage
classes
WarmStorageService
Github
X
Select theme
Dark
Light
Auto
operatorApprovalsCall
Copy Markdown
Open
Open in ChatGPT
Open in Claude
View in Markdown
Type Aliases
Section titled “Type Aliases”
Type Alias
Description
ErrorType
-
OptionsType
-
OutputType
-
