Skip to content

Commit 1f6925d

Browse files
committed
update interface godocs
1 parent 7f20965 commit 1f6925d

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

storage/scheduled_transactions.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,11 @@ type ScheduledTransactions interface {
2929
ScheduledTransactionsReader
3030

3131
// BatchIndex indexes the scheduled transaction by its block ID, transaction ID, and scheduled transaction ID.
32-
// `scheduledTxID` is the uint64 id field returned by the system smart contract.
3332
// `txID` is be the TransactionBody.ID of the scheduled transaction.
33+
// `scheduledTxID` is the uint64 id field returned by the system smart contract.
3434
// Requires the lock: [storage.LockIndexScheduledTransaction]
3535
//
36-
// No errors are expected during normal operation.
36+
// Expected error returns during normal operation:
37+
// - [storage.ErrAlreadyExists]: if the scheduled transaction is already indexed
3738
BatchIndex(lctx lockctx.Proof, blockID flow.Identifier, txID flow.Identifier, scheduledTxID uint64, batch ReaderBatchWriter) error
3839
}

0 commit comments

Comments
 (0)