# core

**Synapse Core - Main Entry Point**

## Example

```ts
import * as core from '@filoz/synapse-core'
```

## Namespaces

| Namespace | Description |
| ------ | ------ |
| [paginate](/reference/filoz/synapse-core/core/namespaces/paginate/toc/) | - |
| [resolvePagination](/reference/filoz/synapse-core/core/namespaces/resolvepagination/toc/) | - |

## Type Aliases

| Type Alias | Description |
| ------ | ------ |
| [AccountClient](/reference/filoz/synapse-core/core/type-aliases/accountclient/) | Wallet/account client for write actions. |
| [ActionCallChain](/reference/filoz/synapse-core/core/type-aliases/actioncallchain/) | Action call chain options |
| [ActionSyncCallback](/reference/filoz/synapse-core/core/type-aliases/actionsynccallback/) | Action sync callback options |
| [ActionSyncOutput](/reference/filoz/synapse-core/core/type-aliases/actionsyncoutput/) | Action sync output type |
| [Extended](/reference/filoz/synapse-core/core/type-aliases/extended/) | - |
| [Page](/reference/filoz/synapse-core/core/type-aliases/page/) | One bounded page of items and its opaque continuation cursor. |
| [PageWithTotal](/reference/filoz/synapse-core/core/type-aliases/pagewithtotal/) | A page that also reports the collection's total size. |
| [PaginatedActionCallOptions](/reference/filoz/synapse-core/core/type-aliases/paginatedactioncalloptions/) | Convert normalized action pagination into required contract-facing call arguments. |
| [PaginationOptions](/reference/filoz/synapse-core/core/type-aliases/paginationoptions/) | Options shared by actions that return one bounded page. |
| [ReadClient](/reference/filoz/synapse-core/core/type-aliases/readclient/) | - |
| [SessionKeyClient](/reference/filoz/synapse-core/core/type-aliases/sessionkeyclient/) | - |

## Functions

| Function | Description |
| ------ | ------ |
| [pageFromLookahead](/reference/filoz/synapse-core/core/functions/pagefromlookahead/) | Convert a contract response fetched with `limit + 1` into a bounded page. |
| [paginate](/reference/filoz/synapse-core/core/functions/paginate/) | Iterate over every item returned by a cursor-paginated action. |
| [resolvePagination](/reference/filoz/synapse-core/core/functions/resolvepagination/) | Validate and resolve pagination options for an action. |

## References

### abis

Re-exports [abis](/reference/filoz/synapse-core/abis/toc/)

***

### auction

Re-exports [auction](/reference/filoz/synapse-core/auction/toc/)

***

### chains

Re-exports [chains](/reference/filoz/synapse-core/chains/toc/)

***

### DataSetInfo

Re-exports [DataSetInfo](/reference/filoz/synapse-core/warm-storage/type-aliases/datasetinfo/)

***

### datasetMetadataObjectToEntry

Re-exports [datasetMetadataObjectToEntry](/reference/filoz/synapse-core/utils/functions/datasetmetadataobjecttoentry/)

***

### endorsements

Re-exports [endorsements](/reference/filoz/synapse-core/endorsements/toc/)

***

### erc20

Re-exports [erc20](/reference/filoz/synapse-core/erc20/toc/)

***

### errors

Re-exports [errors](/reference/filoz/synapse-core/errors/toc/)

***

### METADATA\_LIMITS

Re-exports [METADATA_LIMITS](/reference/filoz/synapse-core/utils/variables/metadata_limits/)

***

### MetadataArray

Re-exports [MetadataArray](/reference/filoz/synapse-core/utils/type-aliases/metadataarray/)

***

### metadataArrayToObject

Re-exports [metadataArrayToObject](/reference/filoz/synapse-core/utils/functions/metadataarraytoobject/)

***

### MetadataDataSetInternal

Re-exports [MetadataDataSetInternal](/reference/filoz/synapse-core/utils/interfaces/metadatadatasetinternal/)

***

### MetadataEntry

Re-exports [MetadataEntry](/reference/filoz/synapse-core/utils/type-aliases/metadataentry/)

***

### MetadataObject

Re-exports [MetadataObject](/reference/filoz/synapse-core/utils/type-aliases/metadataobject/)

***

### MetadataPieceInternal

Re-exports [MetadataPieceInternal](/reference/filoz/synapse-core/utils/interfaces/metadatapieceinternal/)

***

### pay

Re-exports [pay](/reference/filoz/synapse-core/pay/toc/)

***

### PdpDataSet

Re-exports [PdpDataSet](/reference/filoz/synapse-core/warm-storage/interfaces/pdpdataset/)

***

### PdpDataSetInfo

Re-exports [PdpDataSetInfo](/reference/filoz/synapse-core/warm-storage/type-aliases/pdpdatasetinfo/)

***

### piece

Re-exports [piece](/reference/filoz/synapse-core/piece/toc/)

***

### Piece

Re-exports [Piece](/reference/filoz/synapse-core/warm-storage/interfaces/piece/)

***

### pieceMetadataObjectToEntry

Re-exports [pieceMetadataObjectToEntry](/reference/filoz/synapse-core/utils/functions/piecemetadataobjecttoentry/)

***

### PieceWithMetadata

Re-exports [PieceWithMetadata](/reference/filoz/synapse-core/warm-storage/interfaces/piecewithmetadata/)

***

### sessionKey

Renames and re-exports [session-key](/reference/filoz/synapse-core/session-key/toc/)

***

### sp

Re-exports [sp](/reference/filoz/synapse-core/sp/toc/)

***

### spRegistry

Renames and re-exports [sp-registry](/reference/filoz/synapse-core/sp-registry/toc/)

***

### typedData

Renames and re-exports [typed-data](/reference/filoz/synapse-core/typed-data/toc/)

***

### usdfc

Re-exports [usdfc](/reference/filoz/synapse-core/usdfc/toc/)

***

### utils

Re-exports [utils](/reference/filoz/synapse-core/utils/toc/)

***

### warmStorage

Renames and re-exports [warm-storage](/reference/filoz/synapse-core/warm-storage/toc/)