SynapseFromClientOptions
Defined in: packages/synapse-sdk/src/types.ts:152
Properties
Section titled “Properties”client
Section titled “client”client:
Client<Transport,Chain,Account>
Defined in: packages/synapse-sdk/src/types.ts:158
Viem wallet client
https://viem.sh/docs/clients/wallet#optional-hoist-the-account
pieceBatching?
Section titled “pieceBatching?”
optionalpieceBatching?:false|PieceBatchingOptions
Defined in: packages/synapse-sdk/src/types.ts:172
Automatic addPieces batching. Enabled by default; pass false to disable.
readClient?
Section titled “readClient?”
optionalreadClient?:Client<Transport,Chain>
Defined in: packages/synapse-sdk/src/types.ts:163
Viem public client for read operations
sessionClient?
Section titled “sessionClient?”
optionalsessionClient?:Client<Transport,Chain, {address:`0x${string}`;keyType:"Secp256k1";nonceManager?:NonceManager;publicKey:`0x${string}`;rootAddress:`0x${string}`;sign: (parameters) =>Promise<`0x${string}`>;signAuthorization: (parameters) =>Promise<SignAuthorizationReturnType>;signMessage: (__namedParameters) =>Promise<`0x${string}`>;signTransaction: <serializer,transaction>(transaction,options?) =>Promise<`0x${string}`>;signTypedData: <typedData,primaryType>(parameters) =>Promise<`0x${string}`>;source:"sessionKey";type:"local"; }>
Defined in: packages/synapse-sdk/src/types.ts:166
source
Section titled “source”source:
string|null
Defined in: packages/synapse-sdk/src/types.ts:179
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.
withCDN?
Section titled “withCDN?”
optionalwithCDN?:boolean
Defined in: packages/synapse-sdk/src/types.ts:169
Whether to use CDN for retrievals (default: false)