FUZD / @fuzd/scheduler / SchedulerStorage
Interface: SchedulerStorage<TransactionDataType>
Type Parameters
• TransactionDataType
Methods
archiveExecution()
archiveExecution(
executionToStore):Promise<void>
Parameters
executionToStore
ScheduledExecutionQueued<TransactionDataType>
Returns
Promise<void>
Defined in
types/scheduler-storage.ts:31
claimDueExecutions()
claimDueExecutions(
params):Promise<ScheduledExecutionQueued<TransactionDataType>[]>
Claim the due executions of a chain (not broadcast, checkinTime <= upToCheckinTime, earliest first) that no other run holds: in one atomic step, so two runs never get the same one. They stay the claimant's until it writes them (createOrUpdateQueuedExecution and archiveExecution release them), calls releaseExecutionClaims, or the claim expires (claim.expiresAt, unix ms). 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
upToCheckinTime
number
Returns
Promise<ScheduledExecutionQueued<TransactionDataType>[]>
Defined in
types/scheduler-storage.ts:51
clear()
clear():
Promise<void>
Returns
Promise<void>
Defined in
types/scheduler-storage.ts:80
createOrUpdateQueuedExecution()
createOrUpdateQueuedExecution(
executionToStore):Promise<ScheduledExecutionQueued<TransactionDataType>>
Parameters
executionToStore
ScheduledExecutionQueued<TransactionDataType>
Returns
Promise<ScheduledExecutionQueued<TransactionDataType>>
Defined in
types/scheduler-storage.ts:32
deleteExecution()
deleteExecution(
params):Promise<void>
Parameters
params
account
`0x${string}`
chainId
string
slot
string
Returns
Promise<void>
Defined in
types/scheduler-storage.ts:30
deleteFinalizedScheduledExecutions()
deleteFinalizedScheduledExecutions(
params):Promise<void>
Parameters
params
chainId
string
upTo
number
Returns
Promise<void>
Defined in
types/scheduler-storage.ts:79
getAccountArchivedSubmissions()
getAccountArchivedSubmissions(
account,params):Promise<ScheduledExecutionQueued<TransactionDataType>[]>
Parameters
account
`0x${string}`
params
limit
number
Returns
Promise<ScheduledExecutionQueued<TransactionDataType>[]>
Defined in
types/scheduler-storage.ts:75
getAccountSubmissions()
getAccountSubmissions(
account,params):Promise<ScheduledExecutionQueued<TransactionDataType>[]>
Parameters
account
`0x${string}`
params
limit
number
Returns
Promise<ScheduledExecutionQueued<TransactionDataType>[]>
Defined in
types/scheduler-storage.ts:71
getAllExecutions()
getAllExecutions(
params):Promise<ScheduledExecutionQueued<TransactionDataType>[]>
Parameters
params
limit
number
order
"ASC" | "DESC"
Returns
Promise<ScheduledExecutionQueued<TransactionDataType>[]>
Defined in
types/scheduler-storage.ts:67
getQueuedExecution()
getQueuedExecution(
params):Promise<undefined|ScheduledExecutionQueued<TransactionDataType>>
Parameters
params
account
`0x${string}`
chainId
string
slot
string
Returns
Promise<undefined | ScheduledExecutionQueued<TransactionDataType>>
Defined in
types/scheduler-storage.ts:21
getQueuedExecutionsForAccount()
getQueuedExecutionsForAccount(
params):Promise<ScheduledExecutionQueued<TransactionDataType>[]>
Parameters
params
account
`0x${string}`
chainId
string
Returns
Promise<ScheduledExecutionQueued<TransactionDataType>[]>
Defined in
types/scheduler-storage.ts:26
getQueueTopMostExecutions()
getQueueTopMostExecutions(
params):Promise<ScheduledExecutionQueued<TransactionDataType>[]>
The queued (not yet broadcast) executions with the earliest checkin time first. chainId restricts them to one chain, upToCheckinTime to those due at that time.
Parameters
params
chainId
string
limit
number
upToCheckinTime
number
Returns
Promise<ScheduledExecutionQueued<TransactionDataType>[]>
Defined in
types/scheduler-storage.ts:39
getUnFinalizedBroadcastedScheduledExecutions()
getUnFinalizedBroadcastedScheduledExecutions(
params):Promise<ScheduledExecutionQueued<TransactionDataType>[]>
Parameters
params
limit
number
Returns
Promise<ScheduledExecutionQueued<TransactionDataType>[]>
Defined in
types/scheduler-storage.ts:59
getUnFinalizedScheduledExecutionsPerBroadcaster()
getUnFinalizedScheduledExecutionsPerBroadcaster(
params):Promise<ScheduledExecutionQueued<TransactionDataType>[]>
Parameters
params
broadcaster
`0x${string}`
chainId
string
limit
number
Returns
Promise<ScheduledExecutionQueued<TransactionDataType>[]>
Defined in
types/scheduler-storage.ts:62
releaseExecutionClaims()
releaseExecutionClaims(
claimant):Promise<void>
Release whatever claimant still holds (its run is over).
Parameters
claimant
string
Returns
Promise<void>
Defined in
types/scheduler-storage.ts:58
setup()
setup():
Promise<void>
Returns
Promise<void>
Defined in
types/scheduler-storage.ts:81