SynapseOptions

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

Options for initializing the Synapse instance Must provide one of:

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

Properties

authorization?

optional authorization: string

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

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

---

dev?

optional dev: boolean

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

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:65

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

---

multicall3Address?

optional multicall3Address: string

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

Override Multicall3 contract address (required for devnet)

---

pieceRetriever?

optional pieceRetriever: PieceRetriever

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

Optional override for piece retrieval

---

privateKey?

optional privateKey: string

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

Private key for signing transactions (requires rpcURL)

---

provider?

optional provider: Provider

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

Ethers Provider instance (handles both reads and transactions)

---

rpcURL?

optional rpcURL: string

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

RPC URL for Filecoin node (required with privateKey)

---

signer?

optional signer: Signer

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

Ethers Signer instance (for direct ethers.js integration)

---

subgraphConfig?

optional subgraphConfig: SubgraphConfig

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

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

---

subgraphService?

optional subgraphService: SubgraphRetrievalService

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

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

---

usdfcAddress?

optional usdfcAddress: string

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

Override USDFC token address (optional, useful for devnet)

---

warmStorageAddress?

optional warmStorageAddress: string

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

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

---

withCDN?

optional withCDN: boolean

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

Whether to use CDN for retrievals (default: false)

---

withIpni?

optional withIpni: boolean

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

Whether to filter providers by IPNI availability