WarmStorageViewOptions
Defined in: packages/synapse-core/src/mocks/jsonrpc/warm-storage.ts:26
Properties
Section titled “Properties”clientDataSets?
Section titled “clientDataSets?”
optionalclientDataSets?: (args) =>AbiToType<readonly [{internalType:"uint256[]";name:"dataSetIds";type:"uint256[]"; }] | readonly [{internalType:"uint256[]";name:"dataSetIds";type:"uint256[]"; }]>
Defined in: packages/synapse-core/src/mocks/jsonrpc/warm-storage.ts:29
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
args | AbiToType<readonly [{ internalType: "address"; name: "payer"; type: "address"; }, { internalType: "uint256"; name: "offset"; type: "uint256"; }, { internalType: "uint256"; name: "limit"; type: "uint256"; }] | readonly [{ internalType: "address"; name: "payer"; type: "address"; }]> |
Returns
Section titled “Returns”AbiToType<readonly [{ internalType: "uint256[]"; name: "dataSetIds"; type: "uint256[]"; }] | readonly [{ internalType: "uint256[]"; name: "dataSetIds"; type: "uint256[]"; }]>
clientNonces?
Section titled “clientNonces?”
optionalclientNonces?: (args) => readonly [bigint]
Defined in: packages/synapse-core/src/mocks/jsonrpc/warm-storage.ts:39
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
args | readonly [`0x${string}`, bigint] |
Returns
Section titled “Returns”readonly [bigint]
getAllDataSetMetadata?
Section titled “getAllDataSetMetadata?”
optionalgetAllDataSetMetadata?: (args) => readonly [readonlystring[], readonlystring[]]
Defined in: packages/synapse-core/src/mocks/jsonrpc/warm-storage.ts:33
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
args | readonly [bigint] |
Returns
Section titled “Returns”readonly [readonly string[], readonly string[]]
getAllPieceMetadata?
Section titled “getAllPieceMetadata?”
optionalgetAllPieceMetadata?: (args) => readonly [readonlystring[], readonlystring[]]
Defined in: packages/synapse-core/src/mocks/jsonrpc/warm-storage.ts:37
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
args | readonly [bigint, bigint] |
Returns
Section titled “Returns”readonly [readonly string[], readonly string[]]
getApprovedProviders?
Section titled “getApprovedProviders?”
optionalgetApprovedProviders?: (args) => readonly [readonlybigint[]]
Defined in: packages/synapse-core/src/mocks/jsonrpc/warm-storage.ts:32
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
args | readonly [bigint, bigint] |
Returns
Section titled “Returns”readonly [readonly bigint[]]
getClientDataSets?
Section titled “getClientDataSets?”
optionalgetClientDataSets?: (args) =>AbiToType<readonly [{components: readonly [{internalType:"uint256";name:"pdpRailId";type:"uint256"; }, {internalType:"uint256";name:"cacheMissRailId";type:"uint256"; }, {internalType:"uint256";name:"cdnRailId";type:"uint256"; }, {internalType:"address";name:"payer";type:"address"; }, {internalType:"address";name:"payee";type:"address"; }, {internalType:"address";name:"serviceProvider";type:"address"; }, {internalType:"uint256";name:"commissionBps";type:"uint256"; }, {internalType:"uint256";name:"clientDataSetId";type:"uint256"; }, {internalType:"uint256";name:"pdpEndEpoch";type:"uint256"; }, {internalType:"uint256";name:"providerId";type:"uint256"; }, {internalType:"uint96";name:"pendingOneTimePayments";type:"uint96"; }, {internalType:"uint96";name:"lifecycleReserveBalance";type:"uint96"; }, {internalType:"uint256";name:"dataSetId";type:"uint256"; }];internalType:"struct FilecoinWarmStorageService.DataSetInfoView[]";name:"infos";type:"tuple[]"; }] | readonly [{components: readonly [{internalType:"uint256";name:"pdpRailId";type:"uint256"; }, {internalType:"uint256";name:"cacheMissRailId";type:"uint256"; }, {internalType:"uint256";name:"cdnRailId";type:"uint256"; }, {internalType:"address";name:"payer";type:"address"; }, {internalType:"address";name:"payee";type:"address"; }, {internalType:"address";name:"serviceProvider";type:"address"; }, {internalType:"uint256";name:"commissionBps";type:"uint256"; }, {internalType:"uint256";name:"clientDataSetId";type:"uint256"; }, {internalType:"uint256";name:"pdpEndEpoch";type:"uint256"; }, {internalType:"uint256";name:"providerId";type:"uint256"; }, {internalType:"uint96";name:"pendingOneTimePayments";type:"uint96"; }, {internalType:"uint96";name:"lifecycleReserveBalance";type:"uint96"; }, {internalType:"uint256";name:"dataSetId";type:"uint256"; }];internalType:"struct FilecoinWarmStorageService.DataSetInfoView[]";name:"infos";type:"tuple[]"; }]>
Defined in: packages/synapse-core/src/mocks/jsonrpc/warm-storage.ts:28
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
args | AbiToType<readonly [{ internalType: "address"; name: "client"; type: "address"; }, { internalType: "uint256"; name: "offset"; type: "uint256"; }, { internalType: "uint256"; name: "limit"; type: "uint256"; }] | readonly [{ internalType: "address"; name: "client"; type: "address"; }]> |
Returns
Section titled “Returns”AbiToType<readonly [{ components: readonly [{ internalType: "uint256"; name: "pdpRailId"; type: "uint256"; }, { internalType: "uint256"; name: "cacheMissRailId"; type: "uint256"; }, { internalType: "uint256"; name: "cdnRailId"; type: "uint256"; }, { internalType: "address"; name: "payer"; type: "address"; }, { internalType: "address"; name: "payee"; type: "address"; }, { internalType: "address"; name: "serviceProvider"; type: "address"; }, { internalType: "uint256"; name: "commissionBps"; type: "uint256"; }, { internalType: "uint256"; name: "clientDataSetId"; type: "uint256"; }, { internalType: "uint256"; name: "pdpEndEpoch"; type: "uint256"; }, { internalType: "uint256"; name: "providerId"; type: "uint256"; }, { internalType: "uint96"; name: "pendingOneTimePayments"; type: "uint96"; }, { internalType: "uint96"; name: "lifecycleReserveBalance"; type: "uint96"; }, { internalType: "uint256"; name: "dataSetId"; type: "uint256"; }]; internalType: "struct FilecoinWarmStorageService.DataSetInfoView[]"; name: "infos"; type: "tuple[]"; }] | readonly [{ components: readonly [{ internalType: "uint256"; name: "pdpRailId"; type: "uint256"; }, { internalType: "uint256"; name: "cacheMissRailId"; type: "uint256"; }, { internalType: "uint256"; name: "cdnRailId"; type: "uint256"; }, { internalType: "address"; name: "payer"; type: "address"; }, { internalType: "address"; name: "payee"; type: "address"; }, { internalType: "address"; name: "serviceProvider"; type: "address"; }, { internalType: "uint256"; name: "commissionBps"; type: "uint256"; }, { internalType: "uint256"; name: "clientDataSetId"; type: "uint256"; }, { internalType: "uint256"; name: "pdpEndEpoch"; type: "uint256"; }, { internalType: "uint256"; name: "providerId"; type: "uint256"; }, { internalType: "uint96"; name: "pendingOneTimePayments"; type: "uint96"; }, { internalType: "uint96"; name: "lifecycleReserveBalance"; type: "uint96"; }, { internalType: "uint256"; name: "dataSetId"; type: "uint256"; }]; internalType: "struct FilecoinWarmStorageService.DataSetInfoView[]"; name: "infos"; type: "tuple[]"; }]>
getClientDataSetsLength?
Section titled “getClientDataSetsLength?”
optionalgetClientDataSetsLength?: (args) => readonly [bigint]
Defined in: packages/synapse-core/src/mocks/jsonrpc/warm-storage.ts:41
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
args | readonly [`0x${string}`] |
Returns
Section titled “Returns”readonly [bigint]
getDataSet?
Section titled “getDataSet?”
optionalgetDataSet?: (args) => readonly [{cacheMissRailId:bigint;cdnRailId:bigint;clientDataSetId:bigint;commissionBps:bigint;dataSetId:bigint;lifecycleReserveBalance:bigint;payee:`0x${string}`;payer:`0x${string}`;pdpEndEpoch:bigint;pdpRailId:bigint;pendingOneTimePayments:bigint;providerId:bigint;serviceProvider:`0x${string}`; }]
Defined in: packages/synapse-core/src/mocks/jsonrpc/warm-storage.ts:30
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
args | readonly [bigint] |
Returns
Section titled “Returns”readonly [{ cacheMissRailId: bigint; cdnRailId: bigint; clientDataSetId: bigint; commissionBps: bigint; dataSetId: bigint; lifecycleReserveBalance: bigint; payee: `0x${string}`; payer: `0x${string}`; pdpEndEpoch: bigint; pdpRailId: bigint; pendingOneTimePayments: bigint; providerId: bigint; serviceProvider: `0x${string}`; }]
getDataSetMetadata?
Section titled “getDataSetMetadata?”
optionalgetDataSetMetadata?: (args) => readonly [boolean,string]
Defined in: packages/synapse-core/src/mocks/jsonrpc/warm-storage.ts:36
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
args | readonly [bigint, string] |
Returns
Section titled “Returns”readonly [boolean, string]
getPDPConfig?
Section titled “getPDPConfig?”
optionalgetPDPConfig?: (args) => readonly [bigint,bigint,bigint,bigint]
Defined in: packages/synapse-core/src/mocks/jsonrpc/warm-storage.ts:40
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
args | readonly [] |
Returns
Section titled “Returns”readonly [bigint, bigint, bigint, bigint]
getPieceMetadata?
Section titled “getPieceMetadata?”
optionalgetPieceMetadata?: (args) => readonly [boolean,string]
Defined in: packages/synapse-core/src/mocks/jsonrpc/warm-storage.ts:38
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
args | readonly [bigint, bigint, string] |
Returns
Section titled “Returns”readonly [boolean, string]
getPriceList?
Section titled “getPriceList?”
optionalgetPriceList?: (args) => readonly [{fees: {addPiecesBaseFee:bigint;addPiecesPerPieceFee:bigint;createDataSetFee:bigint;schedulePieceRemovalsFee:bigint;terminateFee:bigint; };lockups: {cacheMissLockupAmount:bigint;cdnLockupAmount:bigint;cdnLockupPeriod:bigint;defaultLockupPeriod:bigint;lifecycleReserveTarget:bigint;replenishThreshold:bigint; };rates: {cacheMissEgressPerTib:bigint;cdnEgressPerTib:bigint;datasetFeePerMonth:bigint;storagePerTibPerMonth:bigint; };token:`0x${string}`; }]
Defined in: packages/synapse-core/src/mocks/jsonrpc/warm-storage.ts:44
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
args | readonly [] |
Returns
Section titled “Returns”readonly [{ fees: { addPiecesBaseFee: bigint; addPiecesPerPieceFee: bigint; createDataSetFee: bigint; schedulePieceRemovalsFee: bigint; terminateFee: bigint; }; lockups: { cacheMissLockupAmount: bigint; cdnLockupAmount: bigint; cdnLockupPeriod: bigint; defaultLockupPeriod: bigint; lifecycleReserveTarget: bigint; replenishThreshold: bigint; }; rates: { cacheMissEgressPerTib: bigint; cdnEgressPerTib: bigint; datasetFeePerMonth: bigint; storagePerTibPerMonth: bigint; }; token: `0x${string}`; }]
isProviderApproved?
Section titled “isProviderApproved?”
optionalisProviderApproved?: (args) => readonly [boolean]
Defined in: packages/synapse-core/src/mocks/jsonrpc/warm-storage.ts:27
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
args | readonly [bigint] |
Returns
Section titled “Returns”readonly [boolean]
railToDataSet?
Section titled “railToDataSet?”
optionalrailToDataSet?: (args) => readonly [bigint]
Defined in: packages/synapse-core/src/mocks/jsonrpc/warm-storage.ts:31
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
args | readonly [bigint] |
Returns
Section titled “Returns”readonly [bigint]