Skip to content
synapse Synapse

StorageInfo

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

Comprehensive storage service information

Properties

Section titled “Properties”

allowances

Section titled “allowances”
allowances:
  | null
  | {
  lockupAllowance: bigint;
  lockupUsed: bigint;
  rateAllowance: bigint;
  rateUsed: bigint;
  service: string;
};

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

Current user allowances (null if wallet not connected)

Type Declaration

Section titled “Type Declaration”

null

{
  lockupAllowance: bigint;
  lockupUsed: bigint;
  rateAllowance: bigint;
  rateUsed: bigint;
  service: string;
}

lockupAllowance

Section titled “lockupAllowance”
lockupAllowance: bigint;

Maximum lockup amount allowed

lockupUsed

Section titled “lockupUsed”
lockupUsed: bigint;

Current lockup allowance used

rateAllowance

Section titled “rateAllowance”
rateAllowance: bigint;

Maximum payment rate per epoch allowed

rateUsed

Section titled “rateUsed”
rateUsed: bigint;

Current rate allowance used

service

Section titled “service”
service: string;

Service contract address

pricing

Section titled “pricing”
pricing: object;

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

Pricing information for storage services

noCDN

Section titled “noCDN”
noCDN: object;

Pricing without CDN

noCDN.perTiBPerDay
Section titled “noCDN.perTiBPerDay”
perTiBPerDay: bigint;

Cost per TiB per day in token units

noCDN.perTiBPerEpoch
Section titled “noCDN.perTiBPerEpoch”
perTiBPerEpoch: bigint;

Cost per TiB per epoch in token units

noCDN.perTiBPerMonth
Section titled “noCDN.perTiBPerMonth”
perTiBPerMonth: bigint;

Cost per TiB per month in token units

tokenAddress

Section titled “tokenAddress”
tokenAddress: string;

Token contract address

tokenSymbol

Section titled “tokenSymbol”
tokenSymbol: string;

Token symbol (always USDFC for now)

withCDN

Section titled “withCDN”
withCDN: object;

Pricing with CDN enabled

withCDN.perTiBPerDay
Section titled “withCDN.perTiBPerDay”
perTiBPerDay: bigint;

Cost per TiB per day in token units

withCDN.perTiBPerEpoch
Section titled “withCDN.perTiBPerEpoch”
perTiBPerEpoch: bigint;

Cost per TiB per epoch in token units

withCDN.perTiBPerMonth
Section titled “withCDN.perTiBPerMonth”
perTiBPerMonth: bigint;

Cost per TiB per month in token units

providers

Section titled “providers”
providers: ProviderInfo[];

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

List of approved service providers

serviceParameters

Section titled “serviceParameters”
serviceParameters: object;

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

Service configuration parameters

epochDuration

Section titled “epochDuration”
epochDuration: number;

Duration of each epoch in seconds

epochsPerDay

Section titled “epochsPerDay”
epochsPerDay: bigint;

Number of epochs in a day

epochsPerMonth

Section titled “epochsPerMonth”
epochsPerMonth: bigint;

Number of epochs in a month

maxUploadSize

Section titled “maxUploadSize”
maxUploadSize: number;

Maximum allowed upload size in bytes

minUploadSize

Section titled “minUploadSize”
minUploadSize: number;

Minimum allowed upload size in bytes

network

Section titled “network”
network: FilecoinNetworkType;

Network type (mainnet or calibration)

paymentsAddress

Section titled “paymentsAddress”
paymentsAddress: string;

Payments contract address

pdpVerifierAddress

Section titled “pdpVerifierAddress”
pdpVerifierAddress: string;

PDP Verifier contract address

warmStorageAddress

Section titled “warmStorageAddress”
warmStorageAddress: string;

Warm Storage service contract address