FUZD / @fuzd/server / RemoteSQLExecutorStorage
Class: RemoteSQLExecutorStorage<TransactionDataType>
Type Parameters
• TransactionDataType
Implements
ExecutorStorage<TransactionDataType>
Constructors
new RemoteSQLExecutorStorage()
new RemoteSQLExecutorStorage<
TransactionDataType>(db):RemoteSQLExecutorStorage<TransactionDataType>
Parameters
db
RemoteSQL
Returns
RemoteSQLExecutorStorage<TransactionDataType>
Defined in
packages/server/src/storage/RemoteSQLExecutorStorage.ts:175
Methods
claimPendingExecutions()
claimPendingExecutions(
params):Promise<PendingExecutionStored<TransactionDataType>[]>
Claim the unfinalized executions of a chain due for a check (nextCheckTime <= upToNextCheckTime, earliest first) that no other run holds, in one atomic step. They stay the claimant's until written (createOrUpdatePendingExecution, postponePendingExecution), released, or the claim expires. See docs/adr/0004-claim-due-items-with-a-lease.md.
Parameters
params
chainId
string
claim
{ by: string; expiresAt: number; now: number; }
claim.by
string
claim.expiresAt
number
claim.now
number
limit
number
upToNextCheckTime
number
Returns
Promise<PendingExecutionStored<TransactionDataType>[]>
Implementation of
ExecutorStorage.claimPendingExecutions
Defined in
packages/server/src/storage/RemoteSQLExecutorStorage.ts:427
clear()
clear():
Promise<void>
Returns
Promise<void>
Implementation of
Defined in
packages/server/src/storage/RemoteSQLExecutorStorage.ts:532
createBroadcaster()
createBroadcaster(
broadcaster):Promise<void>
Parameters
broadcaster
Returns
Promise<void>
Implementation of
ExecutorStorage.createBroadcaster
Defined in
packages/server/src/storage/RemoteSQLExecutorStorage.ts:512
createOrUpdatePendingExecution()
createOrUpdatePendingExecution(
executionToStore,__namedParameters,asPaymentFor?):Promise<PendingExecutionStored<TransactionDataType>>
Parameters
executionToStore
PendingExecutionStored<TransactionDataType>
__namedParameters
debtOffset
bigint
updateNonceIfNeeded
{ broadcaster: `0x${string}`; lock: string; }
updateNonceIfNeeded.broadcaster
`0x${string}`
updateNonceIfNeeded.lock
string
asPaymentFor?
account
`0x${string}`
batchIndex
number
chainId
string
helpedForUpToGasPrice
{ upToGasPrice: bigint; valueSent: bigint; }
helpedForUpToGasPrice.upToGasPrice
bigint
helpedForUpToGasPrice.valueSent
bigint
slot
string
Returns
Promise<PendingExecutionStored<TransactionDataType>>
Implementation of
ExecutorStorage.createOrUpdatePendingExecution
Defined in
packages/server/src/storage/RemoteSQLExecutorStorage.ts:292
deleteFinalizedPendingExecutions()
deleteFinalizedPendingExecutions(
params):Promise<void>
Parameters
params
chainId
string
upTo
number
Returns
Promise<void>
Implementation of
ExecutorStorage.deleteFinalizedPendingExecutions
Defined in
packages/server/src/storage/RemoteSQLExecutorStorage.ts:519
deletePendingExecution()
deletePendingExecution(
params):Promise<void>
Parameters
params
account
`0x${string}`
batchIndex
number
chainId
string
slot
string
Returns
Promise<void>
Implementation of
ExecutorStorage.deletePendingExecution
Defined in
packages/server/src/storage/RemoteSQLExecutorStorage.ts:208
getAllExecutions()
getAllExecutions(
params):Promise<PendingExecutionStored<TransactionDataType>[]>
Parameters
params
limit
number
order
"ASC" | "DESC"
Returns
Promise<PendingExecutionStored<TransactionDataType>[]>
Implementation of
ExecutorStorage.getAllExecutions
Defined in
packages/server/src/storage/RemoteSQLExecutorStorage.ts:471
getBroadcaster()
getBroadcaster(
params):Promise<undefined|BroadcasterData>
Parameters
params
address
string
chainId
string
Returns
Promise<undefined | BroadcasterData>
Implementation of
ExecutorStorage.getBroadcaster
Defined in
packages/server/src/storage/RemoteSQLExecutorStorage.ts:503
getChainConfiguration()
getChainConfiguration(
chainId):Promise<ChainConfiguration>
Parameters
chainId
string
Returns
Promise<ChainConfiguration>
Implementation of
ExecutorStorage.getChainConfiguration
Defined in
packages/server/src/storage/RemoteSQLExecutorStorage.ts:545
getPendingExecution()
getPendingExecution(
params):Promise<undefined|PendingExecutionStored<TransactionDataType>>
Parameters
params
account
`0x${string}`
batchIndex
number
chainId
string
slot
string
Returns
Promise<undefined | PendingExecutionStored<TransactionDataType>>
Implementation of
ExecutorStorage.getPendingExecution
Defined in
packages/server/src/storage/RemoteSQLExecutorStorage.ts:177
getPendingExecutionBatch()
getPendingExecutionBatch(
params):Promise<undefined|PendingExecutionStored<TransactionDataType>[]>
Parameters
params
account
`0x${string}`
chainId
string
slot
string
Returns
Promise<undefined | PendingExecutionStored<TransactionDataType>[]>
Implementation of
ExecutorStorage.getPendingExecutionBatch
Defined in
packages/server/src/storage/RemoteSQLExecutorStorage.ts:195
getPendingExecutions()
getPendingExecutions(
params):Promise<PendingExecutionStored<TransactionDataType>[]>
The unfinalized executions with the earliest next check first. chainId restricts them to one chain, upToNextCheckTime to those due at that time.
Parameters
params
chainId
string
limit
number
upToNextCheckTime
number
Returns
Promise<PendingExecutionStored<TransactionDataType>[]>
Implementation of
ExecutorStorage.getPendingExecutions
Defined in
packages/server/src/storage/RemoteSQLExecutorStorage.ts:405
getPendingExecutionsPerBroadcaster()
getPendingExecutionsPerBroadcaster(
broadcasterData,params):Promise<PendingExecutionStored<TransactionDataType>[]>
Parameters
broadcasterData
broadcaster
`0x${string}`
chainId
string
params
limit
number
Returns
Promise<PendingExecutionStored<TransactionDataType>[]>
Implementation of
ExecutorStorage.getPendingExecutionsPerBroadcaster
Defined in
packages/server/src/storage/RemoteSQLExecutorStorage.ts:487
lockBroadcaster()
lockBroadcaster(
params):Promise<undefined|BroadcasterDataWithLock>
Parameters
params
address
string
chainId
string
nonceFromNetwork
number
Returns
Promise<undefined | BroadcasterDataWithLock>
Implementation of
ExecutorStorage.lockBroadcaster
Defined in
packages/server/src/storage/RemoteSQLExecutorStorage.ts:221
postponePendingExecution()
postponePendingExecution(
execution,nextCheckTime,lastError?):Promise<void>
Move the next check of an unfinalized execution, unless it changed since it was read: only the row still carrying hash is updated, so a concurrent resubmission is never overwritten.
Parameters
execution
account
`0x${string}`
batchIndex
number
chainId
string
hash
`0x${string}`
slot
string
nextCheckTime
number
lastError?
string
Returns
Promise<void>
Implementation of
ExecutorStorage.postponePendingExecution
Defined in
packages/server/src/storage/RemoteSQLExecutorStorage.ts:450
releasePendingExecutionClaims()
releasePendingExecutionClaims(
claimant):Promise<void>
Release whatever claimant still holds (its run is over).
Parameters
claimant
string
Returns
Promise<void>
Implementation of
ExecutorStorage.releasePendingExecutionClaims
Defined in
packages/server/src/storage/RemoteSQLExecutorStorage.ts:443
setup()
setup():
Promise<void>
Returns
Promise<void>
Implementation of
Defined in
packages/server/src/storage/RemoteSQLExecutorStorage.ts:538
unlockBroadcaster()
unlockBroadcaster(
params):Promise<void>
Parameters
params
address
string
chainId
string
Returns
Promise<void>
Implementation of
ExecutorStorage.unlockBroadcaster
Defined in
packages/server/src/storage/RemoteSQLExecutorStorage.ts:276
updateExpectedWorstCaseGasPrice()
updateExpectedWorstCaseGasPrice(
chainId,timestamp,newGasPrice):Promise<ChainConfiguration>
Parameters
chainId
string
timestamp
number
newGasPrice
bigint
Returns
Promise<ChainConfiguration>
Implementation of
ExecutorStorage.updateExpectedWorstCaseGasPrice
Defined in
packages/server/src/storage/RemoteSQLExecutorStorage.ts:555
updateFees()
updateFees(
chainId,timestamp,newFees):Promise<ChainConfiguration>
Parameters
chainId
string
timestamp
number
newFees
Returns
Promise<ChainConfiguration>
Implementation of
Defined in
packages/server/src/storage/RemoteSQLExecutorStorage.ts:570