core
Synapse Core - Main Entry Point
Example
Section titled “Example”import * as core from '@filoz/synapse-core'Namespaces
Section titled “Namespaces”| Namespace | Description |
|---|---|
| paginate | - |
| resolvePagination | - |
Type Aliases
Section titled “Type Aliases”| Type Alias | Description |
|---|---|
| AccountClient | Wallet/account client for write actions. |
| ActionCallChain | Action call chain options |
| ActionSyncCallback | Action sync callback options |
| ActionSyncOutput | Action sync output type |
| Extended | - |
| Page | One bounded page of items and its opaque continuation cursor. |
| PageWithTotal | A page that also reports the collection’s total size. |
| PaginatedActionCallOptions | Convert normalized action pagination into required contract-facing call arguments. |
| PaginationOptions | Options shared by actions that return one bounded page. |
| ReadClient | - |
| SessionKeyClient | - |
Functions
Section titled “Functions”| Function | Description |
|---|---|
| pageFromLookahead | Convert a contract response fetched with limit + 1 into a bounded page. |
| paginate | Iterate over every item returned by a cursor-paginated action. |
| resolvePagination | Validate and resolve pagination options for an action. |
References
Section titled “References”Re-exports abis
auction
Section titled “auction”Re-exports auction
chains
Section titled “chains”Re-exports chains
DataSetInfo
Section titled “DataSetInfo”Re-exports DataSetInfo
datasetMetadataObjectToEntry
Section titled “datasetMetadataObjectToEntry”Re-exports datasetMetadataObjectToEntry
endorsements
Section titled “endorsements”Re-exports endorsements
Re-exports erc20
errors
Section titled “errors”Re-exports errors
METADATA_LIMITS
Section titled “METADATA_LIMITS”Re-exports METADATA_LIMITS
MetadataArray
Section titled “MetadataArray”Re-exports MetadataArray
metadataArrayToObject
Section titled “metadataArrayToObject”Re-exports metadataArrayToObject
MetadataDataSetInternal
Section titled “MetadataDataSetInternal”Re-exports MetadataDataSetInternal
MetadataEntry
Section titled “MetadataEntry”Re-exports MetadataEntry
MetadataObject
Section titled “MetadataObject”Re-exports MetadataObject
MetadataPieceInternal
Section titled “MetadataPieceInternal”Re-exports MetadataPieceInternal
Re-exports pay
PdpDataSet
Section titled “PdpDataSet”Re-exports PdpDataSet
PdpDataSetInfo
Section titled “PdpDataSetInfo”Re-exports PdpDataSetInfo
Re-exports piece
Re-exports Piece
pieceMetadataObjectToEntry
Section titled “pieceMetadataObjectToEntry”Re-exports pieceMetadataObjectToEntry
PieceWithMetadata
Section titled “PieceWithMetadata”Re-exports PieceWithMetadata
sessionKey
Section titled “sessionKey”Renames and re-exports session-key
Re-exports sp
spRegistry
Section titled “spRegistry”Renames and re-exports sp-registry
typedData
Section titled “typedData”Renames and re-exports typed-data
Re-exports usdfc
Re-exports utils
warmStorage
Section titled “warmStorage”Renames and re-exports warm-storage