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
Synapse SDK
Components
storage
Storage Operations
Storage Costs
Storage Context
payments
Payment Operations
Rails & Settlement
React Integration
Telemetry
CookBooks
Filecoin Pay Cookbook
Resources
Contract Addresses
Additional Resources
API
Index
@filoz
synapse-core
Index
abis
Index
namespaces
generated
Index
variables
errorsAbi
errorsAddress
errorsConfig
filecoinPayV1Abi
filecoinPayV1Address
filecoinPayV1Config
filecoinWarmStorageServiceAbi
filecoinWarmStorageServiceAddress
filecoinWarmStorageServiceConfig
filecoinWarmStorageServiceStateViewAbi
filecoinWarmStorageServiceStateViewAddress
filecoinWarmStorageServiceStateViewConfig
pdpVerifierAbi
pdpVerifierAddress
pdpVerifierConfig
serviceProviderRegistryAbi
serviceProviderRegistryAddress
serviceProviderRegistryConfig
sessionKeyRegistryAbi
sessionKeyRegistryAddress
sessionKeyRegistryConfig
variables
erc20
erc20WithPermit
storage
chains
Index
functions
getChain
interfaces
Chain
variables
calibration
mainnet
erc20
Index
functions
approveAllowance
balance
type-aliases
ERC20ApproveAllowanceOptions
ERC20BalanceOptions
ERC20BalanceResult
errors
Index
classes
AddPiecesError
AllowanceAmountError
CreateDataSetError
DeletePieceError
DepositAmountError
FindPieceError
GetDataSetError
InsufficientAllowanceError
InsufficientAvailableFundsError
InsufficientBalanceError
InvalidUploadSizeError
LocationHeaderError
PollDataSetCreationStatusError
PollForAddPiecesStatusError
PostPieceError
SynapseError
UnsupportedChainError
UploadPieceError
WithdrawAmountError
functions
isSynapseError
interfaces
SynapseErrorOptions
index
Index
pay
Index
functions
accountInfo
deposit
depositAndApprove
operatorApprovals
setOperatorApproval
withdraw
type-aliases
AccountInfoOptions
AccountInfoResult
DepositAndApproveOptions
DepositOptions
OperatorApprovalsOptions
OperatorApprovalsResult
SetOperatorApprovalOptions
WithdrawOptions
piece
Index
functions
asLegacyPieceCID
asPieceCID
calculate
calculateFromIterable
createPieceCIDStream
downloadAndValidate
getSize
getSizeFromPieceCID
hexToPieceCID
isPieceCID
parse
uint8ArrayToAsyncIterable
type-aliases
LegacyPieceCID
PieceCID
variables
MAX_UPLOAD_SIZE
session-key
Index
classes
Secp256k1Key
functions
getExpiry
isExpired
login
revoke
interfaces
Secp256k1SessionKeyCreateOptions
Secp256k1SessionKeyProps
SessionKey
type-aliases
GetExpiryOptions
IsExpiredOptions
LoginOptions
RevokeOptions
SessionKeyPermissions
WalletEvents
variables
SESSION_KEY_PERMISSIONS
sp
Index
functions
addPieces
createDataSet
createDataSetAndAddPieces
deletePiece
findPiece
getDataSet
getPiecesForDataSet
ping
pollForAddPiecesStatus
pollForDataSetCreationStatus
setTimeout
uploadPiece
uploadPieceStreaming
type-aliases
AddPiecesOptions
AddPiecesResponse
AddPiecesSuccess
DataSetCreatedResponse
DataSetCreateSuccess
DeletePieceOptions
DeletePieceResponse
FindPieceOptions
GetDataSetOptions
GetDataSetResponse
GetPiecesForDataSetOptions
PDPCreateDataSetAndAddPiecesOptions
PDPCreateDataSetOptions
PollForAddPiecesStatusOptions
PollForDataSetCreationStatusOptions
SPPiece
SPPieceWithUrl
UploadPieceOptions
UploadPieceResponse
UploadPieceStreamingOptions
variables
FACTOR
MIN_TIMEOUT
RETRIES
typed-data
Index
functions
getStorageDomain
signAddPieces
signCreateDataSet
signErc20Permit
interfaces
GetStorageDomainOptions
type-aliases
MetadataEntry
SignAddPiecesOptions
signDataSetOptions
SignErc20PermitOptions
TypedDataType
variables
EIP712Types
usdfc
Index
functions
watchUsdfc
utils
Index
functions
capabilitiesListToObject
claimTokens
clientFromTransport
createPieceUrl
datasetMetadataObjectToEntry
decodeAddressCapability
decodePDPCapabilities
decodePDPError
encodePDPCapabilities
fallbackRandIndex
fallbackRandU256
formatBalance
formatFraction
metadataArrayToObject
pieceMetadataObjectToEntry
randIndex
randU256
transportFromTransportConfig
interfaces
MetadataDataSetInternal
MetadataPieceInternal
type-aliases
ClaimTokenResponse
ClaimTokenResponseError
ClaimTokensOptions
MetadataArray
MetadataEntry
MetadataObject
variables
CAP_IPNI_IPFS
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
SIZE_CONSTANTS
TIME_CONSTANTS
warm-storage
Index
functions
addPieces
createDataSet
createDataSetAndAddPieces
deletePiece
getDataSet
getDataSetMetadata
getDataSets
getPieces
getProvider
pollForDeletePieceStatus
readAddresses
readProviders
servicePrice
terminateDataSet
upload
interfaces
DataSet
GetDataSetsOptions
PDPOffering
PDPProvider
type-aliases
AddPiecesOptions
ClientDataSet
CreateDataSetAndAddPiecesOptions
CreateDataSetOptions
DeletePieceOptions
getClientDataSetsType
GetDataSetOptions
GetPiecesOptions
GetProviderOptions
getProviderType
Piece
PollForDeletePieceStatusOptions
ReadAddressesResult
ServicePriceResult
ServiceProviderInfo
TerminateDataSetOptions
UploadOptions
synapse-react
Index
functions
useAccountInfo
useAddUsdfc
useApproveAllowance
useApproveOperator
useCreateDataSet
useDataSets
useDeletePiece
useDeposit
useDepositAndApprove
useERC20Balance
useFilsnap
useFundWallet
useOperatorApprovals
useProviders
useRevokeOperator
useServicePrice
useUpload
useWithdraw
interfaces
DataSetWithPieces
UseCreateDataSetProps
UseCreateDataSetVariables
UseDataSetsProps
UseDeletePieceProps
UseDeletePieceVariables
UseOperatorApprovalsProps
UseProvidersProps
UseServicePriceProps
UseUploadProps
UseUploadVariables
UseWatchUsdfcProps
type-aliases
OperatorApprovalsResult
PieceWithMetadata
UseCreateDataSetResult
UseDataSetsResult
UseProvidersResult
UseServicePriceResult
synapse-sdk
Index
Payments
Index
PDP
Index
Storage
Index
Synapse
Index
classes
PaymentsService
PDPAuthHelper
PDPServer
PDPVerifier
SessionKey
StorageContext
StorageManager
SubgraphService
Synapse
TelemetryService
WarmStorageService
functions
asDataSetData
asDataSetPieceData
calculateLastProofDate
combineMetadata
constructFindPieceUrl
constructPieceUrl
createError
dateToEpoch
epochToDate
getCurrentEpoch
getFilecoinNetworkType
getGenesisTimestamp
getGlobalTelemetry
initGlobalTelemetry
isDataSetCreationStatusResponse
isFindPieceResponse
isPieceAdditionStatusResponse
metadataMatches
timeUntilEpoch
validateDataSetCreationStatusResponse
validateFindPieceResponse
validatePieceAdditionStatusResponse
interfaces
AddPiecesResponse
AuthSignature
ComprehensiveDataSetStatus
CreateContextsOptions
CreateDataSetResponse
DataSetCreationStatusResponse
DataSetCreationVerification
DataSetData
DataSetInfo
DataSetPieceData
DebugDump
DepositOptions
DetailedSubgraphDataSetInfo
EnhancedDataSetInfo
FaultRecord
FindPieceResponse
NestedQueryOptions
PaginationOptions
PieceAdditionStatusResponse
PieceInfo
PieceRetriever
PieceStatus
PreflightInfo
ProviderInfo
ProviderSelectionResult
ProviderStats
QueryOptions
RailInfo
SettlementResult
StorageContextCallbacks
StorageInfo
StorageOptions
StorageServiceOptions
SubgraphConfig
SubgraphDataSetInfo
SubgraphRetrievalService
SynapseOptions
TelemetryConfig
UploadCallbacks
UploadOptions
UploadResult
UploadTask
type-aliases
Address
DataSetId
DownloadOptions
FilecoinNetworkType
MetadataEntry
PieceCID
PrivateKey
ServiceProvider
TokenAmount
TokenIdentifier
variables
ADD_PIECES_TYPEHASH
CHAIN_IDS
CONTRACT_ABIS
CONTRACT_ADDRESSES
CREATE_DATA_SET_TYPEHASH
DELETE_DATA_SET_TYPEHASH
EIP2612_PERMIT_TYPES
EIP712_ENCODED_TYPES
EIP712_TYPE_HASHES
EIP712_TYPES
GENESIS_TIMESTAMPS
METADATA_KEYS
PDP_PERMISSION_NAMES
PDP_PERMISSIONS
RPC_URLS
SCHEDULE_PIECE_REMOVALS_TYPEHASH
SETTLEMENT_FEE
SIZE_CONSTANTS
TIME_CONSTANTS
TIMING_CONSTANTS
TOKENS
Github
X
Select theme
Dark
Light
Auto
PrivateKey
Copy Markdown
Open
Open in ChatGPT
Open in Claude
View in Markdown
type
PrivateKey
=
string
;
Defined in:
packages/synapse-sdk/src/types.ts:16
