SynapseFromClientOptions
Defined in: packages/synapse-sdk/src/types.ts:152
Properties
Section titled “Properties”cdnGroup?
Section titled “cdnGroup?”
optionalcdnGroup?:string
Defined in: packages/synapse-sdk/src/types.ts:173
CDN group id used as the withCDN metadata value when CDN is enabled. FWSS keys the shared
CDN bandwidth rail by keccak256(payer, cdnGroup), so all data sets sharing this value join
one bandwidth subscription instead of buying CDN per data set. Opt-in and empty by default,
which keeps a dedicated bandwidth rail per data set and preserves exact-metadata reuse. Set the
same value on every copy of a multi-copy upload so they share one rail.
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
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:161
source
Section titled “source”source:
string|null
Defined in: packages/synapse-sdk/src/types.ts:180
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:164
Whether to use CDN for retrievals (default: false)