# SynapseOptions

Defined in: [packages/synapse-sdk/src/types.ts:38](https://github.com/FilOzone/synapse-sdk/blob/1d6c4b9fe34534bf1087dfe41491b72be0b46858/packages/synapse-sdk/src/types.ts#L38)

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?

```ts
optional authorization: string;
```

Defined in: [packages/synapse-sdk/src/types.ts:53](https://github.com/FilOzone/synapse-sdk/blob/1d6c4b9fe34534bf1087dfe41491b72be0b46858/packages/synapse-sdk/src/types.ts#L53)

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

***

### dev?

```ts
optional dev: boolean;
```

Defined in: [packages/synapse-sdk/src/types.ts:62](https://github.com/FilOzone/synapse-sdk/blob/1d6c4b9fe34534bf1087dfe41491b72be0b46858/packages/synapse-sdk/src/types.ts#L62)

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

***

### disableNonceManager?

```ts
optional disableNonceManager: boolean;
```

Defined in: [packages/synapse-sdk/src/types.ts:66](https://github.com/FilOzone/synapse-sdk/blob/1d6c4b9fe34534bf1087dfe41491b72be0b46858/packages/synapse-sdk/src/types.ts#L66)

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

***

### multicall3Address?

```ts
optional multicall3Address: string;
```

Defined in: [packages/synapse-sdk/src/types.ts:70](https://github.com/FilOzone/synapse-sdk/blob/1d6c4b9fe34534bf1087dfe41491b72be0b46858/packages/synapse-sdk/src/types.ts#L70)

Override Multicall3 contract address (required for devnet)

***

### pieceRetriever?

```ts
optional pieceRetriever: PieceRetriever;
```

Defined in: [packages/synapse-sdk/src/types.ts:64](https://github.com/FilOzone/synapse-sdk/blob/1d6c4b9fe34534bf1087dfe41491b72be0b46858/packages/synapse-sdk/src/types.ts#L64)

Optional override for piece retrieval

***

### privateKey?

```ts
optional privateKey: string;
```

Defined in: [packages/synapse-sdk/src/types.ts:42](https://github.com/FilOzone/synapse-sdk/blob/1d6c4b9fe34534bf1087dfe41491b72be0b46858/packages/synapse-sdk/src/types.ts#L42)

Private key for signing transactions (requires rpcURL)

***

### provider?

```ts
optional provider: Provider;
```

Defined in: [packages/synapse-sdk/src/types.ts:44](https://github.com/FilOzone/synapse-sdk/blob/1d6c4b9fe34534bf1087dfe41491b72be0b46858/packages/synapse-sdk/src/types.ts#L44)

Ethers Provider instance (handles both reads and transactions)

***

### rpcURL?

```ts
optional rpcURL: string;
```

Defined in: [packages/synapse-sdk/src/types.ts:51](https://github.com/FilOzone/synapse-sdk/blob/1d6c4b9fe34534bf1087dfe41491b72be0b46858/packages/synapse-sdk/src/types.ts#L51)

RPC URL for Filecoin node (required with privateKey)

***

### signer?

```ts
optional signer: Signer;
```

Defined in: [packages/synapse-sdk/src/types.ts:46](https://github.com/FilOzone/synapse-sdk/blob/1d6c4b9fe34534bf1087dfe41491b72be0b46858/packages/synapse-sdk/src/types.ts#L46)

Ethers Signer instance (for direct ethers.js integration)

***

### subgraphConfig?

```ts
optional subgraphConfig: SubgraphConfig;
```

Defined in: [packages/synapse-sdk/src/types.ts:77](https://github.com/FilOzone/synapse-sdk/blob/1d6c4b9fe34534bf1087dfe41491b72be0b46858/packages/synapse-sdk/src/types.ts#L77)

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

***

### subgraphService?

```ts
optional subgraphService: SubgraphRetrievalService;
```

Defined in: [packages/synapse-sdk/src/types.ts:75](https://github.com/FilOzone/synapse-sdk/blob/1d6c4b9fe34534bf1087dfe41491b72be0b46858/packages/synapse-sdk/src/types.ts#L75)

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

***

### usdfcAddress?

```ts
optional usdfcAddress: string;
```

Defined in: [packages/synapse-sdk/src/types.ts:72](https://github.com/FilOzone/synapse-sdk/blob/1d6c4b9fe34534bf1087dfe41491b72be0b46858/packages/synapse-sdk/src/types.ts#L72)

Override USDFC token address (optional, useful for devnet)

***

### warmStorageAddress?

```ts
optional warmStorageAddress: string;
```

Defined in: [packages/synapse-sdk/src/types.ts:68](https://github.com/FilOzone/synapse-sdk/blob/1d6c4b9fe34534bf1087dfe41491b72be0b46858/packages/synapse-sdk/src/types.ts#L68)

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

***

### withCDN?

```ts
optional withCDN: boolean;
```

Defined in: [packages/synapse-sdk/src/types.ts:58](https://github.com/FilOzone/synapse-sdk/blob/1d6c4b9fe34534bf1087dfe41491b72be0b46858/packages/synapse-sdk/src/types.ts#L58)

Whether to use CDN for retrievals (default: false)

***

### withIpni?

```ts
optional withIpni: boolean;
```

Defined in: [packages/synapse-sdk/src/types.ts:60](https://github.com/FilOzone/synapse-sdk/blob/1d6c4b9fe34534bf1087dfe41491b72be0b46858/packages/synapse-sdk/src/types.ts#L60)

Whether to filter providers by IPNI availability