presets

const presets: object

Defined in: packages/synapse-core/src/mocks/jsonrpc/index.ts:287

Type Declaration

basic

basic: object

basic.debug

debug: boolean

basic.endorsements

endorsements: object

basic.endorsements.getProviderIds()

getProviderIds: (args) => readonly [readonly bigint[]]

Parameters

Parameter	Type
args	readonly []

Returns

readonly [readonly bigint[]]

basic.erc20

erc20: object

basic.erc20.allowance()

allowance: (args) => readonly [bigint]

Parameters

Parameter	Type
args	readonly [`0x${string}`, `0x${string}`]

Returns

readonly [bigint]

basic.erc20.approve()

approve: (args) => readonly [boolean]

Parameters

Parameter	Type
args	readonly [`0x${string}`, bigint]

Returns

readonly [boolean]

basic.erc20.balanceOf()

balanceOf: (args) => readonly [bigint]

Parameters

Parameter	Type
args	readonly [`0x${string}`]

Returns

readonly [bigint]

basic.erc20.decimals()

decimals: (args) => readonly [number]

Parameters

Parameter	Type
args	readonly []

Returns

readonly [number]

basic.erc20.name()

name: (args) => readonly [string]

Parameters

Parameter	Type
args	readonly []

Returns

readonly [string]

basic.erc20.nonces()

nonces: (args) => readonly [bigint]

Parameters

Parameter	Type
args	readonly [`0x${string}`]

Returns

readonly [bigint]

basic.erc20.symbol()

symbol: (args) => readonly [string]

Parameters

Parameter	Type
args	readonly []

Returns

readonly [string]

basic.erc20.version()

version: (args) => readonly [string]

Parameters

Parameter	Type
args	readonly []

Returns

readonly [string]

basic.eth_accounts

eth_accounts: string[]

basic.eth_blockNumber

eth_blockNumber: string

basic.eth_chainId

eth_chainId: string

basic.eth_estimateGas()

eth_estimateGas: (params) => `0x${string}`

Parameters

Parameter	Type
params	[TransactionRequest] | [TransactionRequest, bigint | BlockTag] | [TransactionRequest, bigint | BlockTag, RpcStateOverride]

Returns

`0x${string}`

basic.eth_fillTransaction()

eth_fillTransaction: (params) => object

Parameters

Parameter	Type
params	[TransactionRequest]

Returns

object

raw

raw: `0x${string}`

tx

tx: RpcTransaction

basic.eth_gasPrice()

eth_gasPrice: () => `0x${string}`

Returns

`0x${string}`

basic.eth_getBalance()

eth_getBalance: (params) => `0x${string}`

Parameters

Parameter	Type
params	[`0x${string}`, bigint | BlockTag]

Returns

`0x${string}`

basic.eth_getBlockByNumber()

eth_getBlockByNumber: (params) => Block<`0x${string}`, boolean, BlockTag, RpcTransaction<false>> | null

Parameters

Parameter	Type
params	[bigint | BlockTag, boolean]

Returns

Block<`0x${string}`, boolean, BlockTag, RpcTransaction<false>> | null

basic.eth_getTransactionByHash()

eth_getTransactionByHash: (params) => any

Parameters

Parameter	Type
params	any

Returns

any

basic.eth_getTransactionCount()

eth_getTransactionCount: (params) => `0x${string}`

Parameters

Parameter	Type
params	[`0x${string}`, bigint | BlockTag | BlockIdentifier]

Returns

`0x${string}`

basic.eth_getTransactionReceipt()

eth_getTransactionReceipt: (params) => any

Parameters

Parameter	Type
params	any

Returns

any

basic.eth_maxPriorityFeePerGas()

eth_maxPriorityFeePerGas: () => `0x${string}`

Returns

`0x${string}`

basic.eth_sendRawTransaction()

eth_sendRawTransaction: (params) => `0x${string}`

Parameters

Parameter	Type
params	[`0x${string}`]

Returns

`0x${string}`

basic.eth_signTypedData_v4()

eth_signTypedData_v4: (params) => string

Parameters

Parameter	Type
params	any

Returns

string

basic.payments

payments: object

basic.payments.accounts()

accounts: (args) => readonly [bigint, bigint, bigint, bigint]

Parameters

Parameter	Type
args	readonly [`0x${string}`, `0x${string}`]

Returns

readonly [bigint, bigint, bigint, bigint]

basic.payments.deposit()

deposit: (args) => readonly []

Parameters

Parameter	Type
args	readonly [`0x${string}`, `0x${string}`, bigint]

Returns

readonly []

basic.payments.depositWithPermit()

depositWithPermit: (args) => readonly []

Parameters

Parameter	Type
args	readonly [`0x${string}`, `0x${string}`, bigint, bigint, number, `0x${string}`, `0x${string}`]

Returns

readonly []

basic.payments.depositWithPermitAndApproveOperator()

depositWithPermitAndApproveOperator: (args) => readonly []

Parameters

Parameter	Type
args	readonly [`0x${string}`, `0x${string}`, bigint, bigint, number, `0x${string}`, `0x${string}`, `0x${string}`, bigint, bigint, bigint]

Returns

readonly []

basic.payments.getRail()

getRail: (args) => readonly [{ commissionRateBps: bigint; endEpoch: bigint; from: `0x${string}`; lockupFixed: bigint; lockupPeriod: bigint; operator: `0x${string}`; paymentRate: bigint; serviceFeeRecipient: `0x${string}`; settledUpTo: bigint; to: `0x${string}`; token: `0x${string}`; validator: `0x${string}`; }]

Parameters

Parameter	Type
args	readonly [bigint]

Returns

readonly [{ commissionRateBps: bigint; endEpoch: bigint; from: `0x${string}`; lockupFixed: bigint; lockupPeriod: bigint; operator: `0x${string}`; paymentRate: bigint; serviceFeeRecipient: `0x${string}`; settledUpTo: bigint; to: `0x${string}`; token: `0x${string}`; validator: `0x${string}`; }]

basic.payments.getRailsForPayeeAndToken()

getRailsForPayeeAndToken: (args) => readonly [readonly object[], bigint, bigint]

Parameters

Parameter	Type
args	readonly [`0x${string}`, `0x${string}`, bigint, bigint]

Returns

readonly [readonly object[], bigint, bigint]

basic.payments.getRailsForPayerAndToken()

getRailsForPayerAndToken: (args) => readonly [readonly object[], bigint, bigint]

Parameters

Parameter	Type
args	readonly [`0x${string}`, `0x${string}`, bigint, bigint]

Returns

readonly [readonly object[], bigint, bigint]

basic.payments.operatorApprovals()

operatorApprovals: (args) => readonly [boolean, bigint, bigint, bigint, bigint, bigint]

Parameters

Parameter	Type
args	readonly [`0x${string}`, `0x${string}`, `0x${string}`]

Returns

readonly [boolean, bigint, bigint, bigint, bigint, bigint]

basic.payments.setOperatorApproval()

setOperatorApproval: (args) => readonly []

Parameters

Parameter	Type
args	readonly [`0x${string}`, `0x${string}`, boolean, bigint, bigint, bigint]

Returns

readonly []

basic.payments.settleRail()

settleRail: (args) => readonly [bigint, bigint, bigint, bigint, bigint, string]

Parameters

Parameter	Type
args	readonly [bigint, bigint]

Returns

readonly [bigint, bigint, bigint, bigint, bigint, string]

basic.payments.settleTerminatedRailWithoutValidation()

settleTerminatedRailWithoutValidation: (args) => readonly [bigint, bigint, bigint, bigint, bigint, string]

Parameters

Parameter	Type
args	readonly [bigint]

Returns

readonly [bigint, bigint, bigint, bigint, bigint, string]

basic.payments.withdraw()

withdraw: (args) => readonly []

Parameters

Parameter	Type
args	readonly [`0x${string}`, bigint]

Returns

readonly []

basic.payments.withdrawTo()

withdrawTo: (args) => readonly []

Parameters

Parameter	Type
args	readonly [`0x${string}`, `0x${string}`, bigint]

Returns

readonly []

basic.pdpVerifier

pdpVerifier: object

basic.pdpVerifier.dataSetLive()

dataSetLive: (args) => readonly [boolean]

Parameters

Parameter	Type
args	readonly [bigint]

Returns

readonly [boolean]

basic.pdpVerifier.getActivePieceCount()

getActivePieceCount: (args) => readonly [bigint]

Parameters

Parameter	Type
args	readonly [bigint]

Returns

readonly [bigint]

basic.pdpVerifier.getActivePieces()

getActivePieces: (args) => readonly [readonly object[], readonly bigint[], boolean]

Parameters

Parameter	Type
args	readonly [bigint, bigint, bigint]

Returns

readonly [readonly object[], readonly bigint[], boolean]

basic.pdpVerifier.getDataSetLeafCount()

getDataSetLeafCount: (args) => readonly [bigint]

Parameters

Parameter	Type
args	readonly [bigint]

Returns

readonly [bigint]

basic.pdpVerifier.getDataSetListener()

getDataSetListener: (args) => readonly [`0x${string}`]

Parameters

Parameter	Type
args	readonly [bigint]

Returns

readonly [`0x${string}`]

basic.pdpVerifier.getDataSetStorageProvider()

getDataSetStorageProvider: (args) => readonly [`0x${string}`, `0x${string}`]

Parameters

Parameter	Type
args	readonly [bigint]

Returns

readonly [`0x${string}`, `0x${string}`]

basic.pdpVerifier.getNextPieceId()

getNextPieceId: (args) => readonly [bigint]

Parameters

Parameter	Type
args	readonly [bigint]

Returns

readonly [bigint]

basic.pdpVerifier.getScheduledRemovals()

getScheduledRemovals: (args) => readonly [readonly bigint[]]

Parameters

Parameter	Type
args	readonly [bigint]

Returns

readonly [readonly bigint[]]

basic.serviceRegistry

serviceRegistry: object

basic.serviceRegistry.getAllActiveProviders()

getAllActiveProviders: (args) => readonly [readonly bigint[], boolean]

Parameters

Parameter	Type
args	readonly [bigint, bigint]

Returns

readonly [readonly bigint[], boolean]

basic.serviceRegistry.getProvider()

getProvider: (args) => readonly [{ info: { description: string; isActive: boolean; name: string; payee: `0x${string}`; serviceProvider: `0x${string}`; }; providerId: bigint; }]

Parameters

Parameter	Type
args	readonly [bigint]

Returns

readonly [{ info: { description: string; isActive: boolean; name: string; payee: `0x${string}`; serviceProvider: `0x${string}`; }; providerId: bigint; }]

basic.serviceRegistry.getProviderByAddress()

getProviderByAddress: (args) => readonly [{ info: { description: string; isActive: boolean; name: string; payee: `0x${string}`; serviceProvider: `0x${string}`; }; providerId: bigint; }]

Parameters

Parameter	Type
args	readonly [`0x${string}`]

Returns

readonly [{ info: { description: string; isActive: boolean; name: string; payee: `0x${string}`; serviceProvider: `0x${string}`; }; providerId: bigint; }]

basic.serviceRegistry.getProviderCount()

getProviderCount: (args) => readonly [bigint]

Parameters

Parameter	Type
args	readonly []

Returns

readonly [bigint]

basic.serviceRegistry.getProviderIdByAddress()

getProviderIdByAddress: (args) => readonly [bigint]

Parameters

Parameter	Type
args	readonly [`0x${string}`]

Returns

readonly [bigint]

basic.serviceRegistry.getProvidersByProductType()

getProvidersByProductType: (args) => readonly [{ hasMore: boolean; providers: readonly object[]; }]

Parameters

Parameter	Type
args	readonly [number, boolean, bigint, bigint]

Returns

readonly [{ hasMore: boolean; providers: readonly object[]; }]

basic.serviceRegistry.getProviderWithProduct()

getProviderWithProduct: (args) => readonly [{ product: { capabilityKeys: readonly string[]; isActive: boolean; productType: number; }; productCapabilityValues: readonly `0x${string}`[]; providerId: bigint; providerInfo: { description: string; isActive: boolean; name: string; payee: `0x${string}`; serviceProvider: `0x${string}`; }; }]

Parameters

Parameter	Type
args	readonly [bigint, number]

Returns

readonly [{ product: { capabilityKeys: readonly string[]; isActive: boolean; productType: number; }; productCapabilityValues: readonly `0x${string}`[]; providerId: bigint; providerInfo: { description: string; isActive: boolean; name: string; payee: `0x${string}`; serviceProvider: `0x${string}`; }; }]

basic.serviceRegistry.isProviderActive()

isProviderActive: (args) => readonly [boolean]

Parameters

Parameter	Type
args	readonly [bigint]

Returns

readonly [boolean]

basic.serviceRegistry.isRegisteredProvider()

isRegisteredProvider: (args) => readonly [boolean]

Parameters

Parameter	Type
args	readonly [`0x${string}`]

Returns

readonly [boolean]

basic.serviceRegistry.REGISTRATION_FEE()

REGISTRATION_FEE: () => bigint

Returns

bigint

basic.sessionKeyRegistry

sessionKeyRegistry: object

basic.sessionKeyRegistry.authorizationExpiry()

authorizationExpiry: (args) => readonly [bigint]

Parameters

Parameter	Type
args	readonly [`0x${string}`, `0x${string}`, `0x${string}`]

Returns

readonly [bigint]

basic.warmStorage

warmStorage: object

basic.warmStorage.addApprovedProvider()

addApprovedProvider: (args) => readonly []

Parameters

Parameter	Type
args	readonly [bigint]

Returns

readonly []

basic.warmStorage.filBeamBeneficiaryAddress()

filBeamBeneficiaryAddress: (args) => readonly [`0x${string}`]

Parameters

Parameter	Type
args	readonly []

Returns

readonly [`0x${string}`]

basic.warmStorage.getServicePrice()

getServicePrice: (args) => readonly [{ epochsPerMonth: bigint; minimumPricePerMonth: bigint; pricePerTiBCacheMissEgress: bigint; pricePerTiBCdnEgress: bigint; pricePerTiBPerMonthNoCDN: bigint; tokenAddress: `0x${string}`; }]

Parameters

Parameter	Type
args	readonly []

Returns

readonly [{ epochsPerMonth: bigint; minimumPricePerMonth: bigint; pricePerTiBCacheMissEgress: bigint; pricePerTiBCdnEgress: bigint; pricePerTiBPerMonthNoCDN: bigint; tokenAddress: `0x${string}`; }]

basic.warmStorage.owner()

owner: (args) => readonly [`0x${string}`]

Parameters

Parameter	Type
args	readonly []

Returns

readonly [`0x${string}`]

basic.warmStorage.paymentsContractAddress()

paymentsContractAddress: (args) => readonly [`0x${string}`]

Parameters

Parameter	Type
args	readonly []

Returns

readonly [`0x${string}`]

basic.warmStorage.pdpVerifierAddress()

pdpVerifierAddress: (args) => readonly [`0x${string}`]

Parameters

Parameter	Type
args	readonly []

Returns

readonly [`0x${string}`]

basic.warmStorage.removeApprovedProvider()

removeApprovedProvider: (args) => readonly []

Parameters

Parameter	Type
args	readonly [bigint, bigint]

Returns

readonly []

basic.warmStorage.serviceProviderRegistry()

serviceProviderRegistry: (args) => readonly [`0x${string}`]

Parameters

Parameter	Type
args	readonly []

Returns

readonly [`0x${string}`]

basic.warmStorage.sessionKeyRegistry()

sessionKeyRegistry: (args) => readonly [`0x${string}`]

Parameters

Parameter	Type
args	readonly []

Returns

readonly [`0x${string}`]

basic.warmStorage.terminateService()

terminateService: (args) => readonly []

Parameters

Parameter	Type
args	readonly [bigint]

Returns

readonly []

basic.warmStorage.topUpCDNPaymentRails()

topUpCDNPaymentRails: (args) => readonly []

Parameters

Parameter	Type
args	readonly [bigint, bigint, bigint]

Returns

readonly []

basic.warmStorage.usdfcTokenAddress()

usdfcTokenAddress: (args) => readonly [`0x${string}`]

Parameters

Parameter	Type
args	readonly []

Returns

readonly [`0x${string}`]

basic.warmStorage.viewContractAddress()

viewContractAddress: (args) => readonly [`0x${string}`]

Parameters

Parameter	Type
args	readonly []

Returns

readonly [`0x${string}`]

basic.warmStorageView

warmStorageView: object

basic.warmStorageView.clientDataSets()

clientDataSets: (args) => readonly [readonly bigint[]]

Parameters

Parameter	Type
args	readonly [`0x${string}`]

Returns

readonly [readonly bigint[]]

basic.warmStorageView.clientNonces()

clientNonces: (args) => readonly [bigint]

Parameters

Parameter	Type
args	readonly [`0x${string}`, bigint]

Returns

readonly [bigint]

basic.warmStorageView.getAllDataSetMetadata()

getAllDataSetMetadata: (args) => readonly [readonly string[], readonly string[]]

Parameters

Parameter	Type
args	readonly [bigint]

Returns

readonly [readonly string[], readonly string[]]

basic.warmStorageView.getAllPieceMetadata()

getAllPieceMetadata: (args) => readonly [readonly string[], readonly string[]]

Parameters

Parameter	Type
args	readonly [bigint, bigint]

Returns

readonly [readonly string[], readonly string[]]

basic.warmStorageView.getApprovedProviders()

getApprovedProviders: (args) => readonly [readonly bigint[]]

Parameters

Parameter	Type
args	readonly [bigint, bigint]

Returns

readonly [readonly bigint[]]

basic.warmStorageView.getClientDataSets()

getClientDataSets: (args) => readonly [readonly object[]]

Parameters

Parameter	Type
args	readonly [`0x${string}`]

Returns

readonly [readonly object[]]

basic.warmStorageView.getDataSet()

getDataSet: (args) => readonly [{ cacheMissRailId: bigint; cdnRailId: bigint; clientDataSetId: bigint; commissionBps: bigint; dataSetId: bigint; payee: `0x${string}`; payer: `0x${string}`; pdpEndEpoch: bigint; pdpRailId: bigint; providerId: bigint; serviceProvider: `0x${string}`; }]

Parameters

Parameter	Type
args	readonly [bigint]

Returns

readonly [{ cacheMissRailId: bigint; cdnRailId: bigint; clientDataSetId: bigint; commissionBps: bigint; dataSetId: bigint; payee: `0x${string}`; payer: `0x${string}`; pdpEndEpoch: bigint; pdpRailId: bigint; providerId: bigint; serviceProvider: `0x${string}`; }]

basic.warmStorageView.getDataSetMetadata()

getDataSetMetadata: (args) => readonly [boolean, string]

Parameters

Parameter	Type
args	readonly [bigint, string]

Returns

readonly [boolean, string]

basic.warmStorageView.getPDPConfig()

getPDPConfig: (args) => readonly [bigint, bigint, bigint, bigint]

Parameters

Parameter	Type
args	readonly []

Returns

readonly [bigint, bigint, bigint, bigint]

basic.warmStorageView.getPieceMetadata()

getPieceMetadata: (args) => readonly [boolean, string]

Parameters

Parameter	Type
args	readonly [bigint, bigint, string]

Returns

readonly [boolean, string]

basic.warmStorageView.isProviderApproved()

isProviderApproved: (args) => readonly [boolean]

Parameters

Parameter	Type
args	readonly [bigint]

Returns

readonly [boolean]

basic.warmStorageView.railToDataSet()

railToDataSet: (args) => readonly [bigint]

Parameters

Parameter	Type
args	readonly [bigint]

Returns

readonly [bigint]