Skip to content
foc Filecoin Onchain Cloud Documentation

SynapseOptions

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

Options for initializing the Synapse instance

Properties

Section titled “Properties”

account

Section titled “account”

account: `0x${string}` | Account

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

Viem account

See

Section titled “See”

chain?

Section titled “chain?”

optional chain: Chain

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

Filecoin chain

sessionKey?

Section titled “sessionKey?”

optional sessionKey: SessionKey<"Secp256k1">

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

source

Section titled “source”

source: string | null

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

Application identifier for namespace isolation. When set to a non-empty string, datasets are tagged with this value and only datasets with a matching source are reused. Set to null to explicitly opt out.

transport?

Section titled “transport?”

optional transport: Transport

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

Viem transport

See

Section titled “See”

https://viem.sh/docs/clients/intro#transports

withCDN?

Section titled “withCDN?”

optional withCDN: boolean

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

Whether to use CDN for retrievals (default: false)