SynapseOptions

Defined in: packages/synapse-sdk/src/types.ts:40

Options for initializing the Synapse instance Must provide one of:

privateKey + rpcURL (for server environments)
provider (for browser environments - user handles MetaMask coupling)
signer (for direct ethers.js integration)

Properties

authorization?

optional authorization: string

Defined in: packages/synapse-sdk/src/types.ts:55

Authorization header value for API authentication (e.g., Bearer token)

dev?

optional dev: boolean

Defined in: packages/synapse-sdk/src/types.ts:64

Whether to include providers with serviceStatus=dev in the capabilities list (default: false)

disableNonceManager?

optional disableNonceManager: boolean

Defined in: packages/synapse-sdk/src/types.ts:68

Whether to disable NonceManager for automatic nonce management (default: false, meaning NonceManager is used)

endorsementsAddress?

optional endorsementsAddress: `0x${string}`

Defined in: packages/synapse-sdk/src/types.ts:76

Override Endorsements contract address (required for devnet)

multicall3Address?

optional multicall3Address: `0x${string}`

Defined in: packages/synapse-sdk/src/types.ts:72

Override Multicall3 contract address (required for devnet)

pieceRetriever?

optional pieceRetriever: PieceRetriever

Defined in: packages/synapse-sdk/src/types.ts:66

Optional override for piece retrieval

privateKey?

optional privateKey: string

Defined in: packages/synapse-sdk/src/types.ts:44

Private key for signing transactions (requires rpcURL)

provider?

optional provider: Provider

Defined in: packages/synapse-sdk/src/types.ts:46

Ethers Provider instance (handles both reads and transactions)

rpcURL?

optional rpcURL: string

Defined in: packages/synapse-sdk/src/types.ts:53

RPC URL for Filecoin node (required with privateKey)

signer?

optional signer: Signer

Defined in: packages/synapse-sdk/src/types.ts:48

Ethers Signer instance (for direct ethers.js integration)

subgraphConfig?

optional subgraphConfig: SubgraphConfig

Defined in: packages/synapse-sdk/src/types.ts:81

Optional configuration for the default subgraph service, to enable subgraph-based retrieval.

subgraphService?

optional subgraphService: SubgraphRetrievalService

Defined in: packages/synapse-sdk/src/types.ts:79

Optional override for default subgraph service, to enable subgraph-based retrieval.

usdfcAddress?

optional usdfcAddress: `0x${string}`

Defined in: packages/synapse-sdk/src/types.ts:74

Override USDFC token address (optional, useful for devnet)

warmStorageAddress?

optional warmStorageAddress: `0x${string}`

Defined in: packages/synapse-sdk/src/types.ts:70

Override Warm Storage service contract address (defaults to network’s default)

withCDN?

optional withCDN: boolean

Defined in: packages/synapse-sdk/src/types.ts:60

Whether to use CDN for retrievals (default: false)

withIpni?

optional withIpni: boolean

Defined in: packages/synapse-sdk/src/types.ts:62

Whether to filter providers by IPNI availability