Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

txhandler

package

Go to main page

Versions in this module

v1

v1.5.4

Sep 25, 2026

v1.5.3

Sep 1, 2026

v1.5.2

Jul 28, 2026

v1.5.1

Jun 29, 2026

v1.5.0

Jun 26, 2026

Changes in this version

+ type ManagedTxEventHandler interface

+ HandleEvent func(ctx context.Context, e apitypes.ManagedTransactionEvent) error

+ type NextNonceCallback func(ctx context.Context, signer string) (uint64, error)

+ type RichQuery interface

+ ListListeners func(ctx context.Context, filter ffapi.AndFilter) ([]*apitypes.Listener, *ffapi.FilterResult, error)

+ ListStreamListeners func(ctx context.Context, streamID *fftypes.UUID, filter ffapi.AndFilter) ([]*apitypes.Listener, *ffapi.FilterResult, error)

+ ListStreams func(ctx context.Context, filter ffapi.AndFilter) ([]*apitypes.EventStream, *ffapi.FilterResult, error)

+ ListTransactionConfirmations func(ctx context.Context, txID string, filter ffapi.AndFilter) ([]*apitypes.ConfirmationRecord, *ffapi.FilterResult, error)

+ ListTransactionHistory func(ctx context.Context, txID string, filter ffapi.AndFilter) ([]*apitypes.TXHistoryRecord, *ffapi.FilterResult, error)

+ ListTransactions func(ctx context.Context, filter ffapi.AndFilter) ([]*apitypes.ManagedTX, *ffapi.FilterResult, error)

+ NewConfirmationFilter func(ctx context.Context) ffapi.FilterBuilder

+ NewListenerFilter func(ctx context.Context) ffapi.FilterBuilder

+ NewStreamFilter func(ctx context.Context) ffapi.FilterBuilder

+ NewTransactionFilter func(ctx context.Context) ffapi.FilterBuilder

+ NewTxHistoryFilter func(ctx context.Context) ffapi.FilterBuilder

+ type SortDirection int

+ const SortDirectionAscending

+ const SortDirectionDescending

+ type Toolkit struct

+ Connector ffcapi.API

+ EventHandler ManagedTxEventHandler

+ MetricsManager TransactionMetrics

+ RichQuery RichQuery

+ TXHistory TransactionHistoryPersistence

+ TXPersistence TransactionPersistence

+ type TransactionCompletions interface

+ ListTxCompletionsByCreateTime func(ctx context.Context, after *int64, limit int, dir SortDirection) ([]*apitypes.TXCompletion, error)

+ WaitTxCompletionUpdates func(ctx context.Context, timeBeforeLastPoll time.Time) bool

+ type TransactionHandler interface

+ HandleCancelTransaction func(ctx context.Context, txID string) (mtx *apitypes.ManagedTX, err error)

+ HandleNewContractDeployment func(ctx context.Context, txReq *apitypes.ContractDeployRequest) (mtx *apitypes.ManagedTX, submissionRejected bool, err error)

+ HandleNewTransaction func(ctx context.Context, txReq *apitypes.TransactionRequest) (mtx *apitypes.ManagedTX, submissionRejected bool, err error)

+ HandleResumeTransaction func(ctx context.Context, txID string) (mtx *apitypes.ManagedTX, err error)

+ HandleSubmissions func(ctx context.Context, submissions []*apitypes.SubmissionRequest) (responses []*apitypes.SubmissionResponse)

+ HandleSuspendTransaction func(ctx context.Context, txID string) (mtx *apitypes.ManagedTX, err error)

+ HandleTransactionConfirmations func(ctx context.Context, txID string, ...) (err error)

+ HandleTransactionReceiptReceived func(ctx context.Context, txID string, receipt *ffcapi.TransactionReceiptResponse) (err error)

+ HandleTransactionUpdate func(ctx context.Context, txID string, update apitypes.TXUpdatesExternal) (mtx *apitypes.ManagedTX, err error)

+ Init func(ctx context.Context, toolkit *Toolkit)

+ Start func(ctx context.Context) (done <-chan struct{}, err error)

+ type TransactionHistoryPersistence interface

+ AddSubStatusAction func(ctx context.Context, txID string, subStatus apitypes.TxSubStatus, ...) error

+ type TransactionMetrics interface

+ IncTxHandlerCounterMetric func(ctx context.Context, metricName string, ...)

+ IncTxHandlerCounterMetricWithLabels func(ctx context.Context, metricName string, labels map[string]string, ...)

+ InitTxHandlerCounterMetric func(ctx context.Context, metricName string, helpText string, ...)

+ InitTxHandlerCounterMetricWithLabels func(ctx context.Context, metricName string, helpText string, labelNames []string, ...)

+ InitTxHandlerGaugeMetric func(ctx context.Context, metricName string, helpText string, ...)

+ InitTxHandlerGaugeMetricWithLabels func(ctx context.Context, metricName string, helpText string, labelNames []string, ...)

+ InitTxHandlerHistogramMetric func(ctx context.Context, metricName string, helpText string, buckets []float64, ...)

+ InitTxHandlerHistogramMetricWithLabels func(ctx context.Context, metricName string, helpText string, buckets []float64, ...)

+ InitTxHandlerSummaryMetric func(ctx context.Context, metricName string, helpText string, ...)

+ InitTxHandlerSummaryMetricWithLabels func(ctx context.Context, metricName string, helpText string, labelNames []string, ...)

+ ObserveTxHandlerHistogramMetric func(ctx context.Context, metricName string, number float64, ...)

+ ObserveTxHandlerHistogramMetricWithLabels func(ctx context.Context, metricName string, number float64, ...)

+ ObserveTxHandlerSummaryMetric func(ctx context.Context, metricName string, number float64, ...)

+ ObserveTxHandlerSummaryMetricWithLabels func(ctx context.Context, metricName string, number float64, ...)

+ SetTxHandlerGaugeMetric func(ctx context.Context, metricName string, number float64, ...)

+ SetTxHandlerGaugeMetricWithLabels func(ctx context.Context, metricName string, number float64, ...)

+ type TransactionPersistence interface

+ AddTransactionConfirmations func(ctx context.Context, txID string, clearExisting bool, ...) error

+ DeleteTransaction func(ctx context.Context, txID string) error

+ GetTransactionByID func(ctx context.Context, txID string) (*apitypes.ManagedTX, error)

+ GetTransactionByIDWithStatus func(ctx context.Context, txID string, history bool) (*apitypes.TXWithStatus, error)

+ GetTransactionByNonce func(ctx context.Context, signer string, nonce *fftypes.FFBigInt) (*apitypes.ManagedTX, error)

+ GetTransactionConfirmations func(ctx context.Context, txID string) ([]*apitypes.Confirmation, error)

+ GetTransactionReceipt func(ctx context.Context, txID string) (receipt *ffcapi.TransactionReceiptResponse, err error)

+ InsertTransactionPreAssignedNonce func(ctx context.Context, tx *apitypes.ManagedTX) error

+ InsertTransactionWithNextNonce func(ctx context.Context, tx *apitypes.ManagedTX, lookupNextNonce NextNonceCallback) error

+ InsertTransactionsWithNextNonce func(ctx context.Context, txs []*apitypes.ManagedTX, ...) []error

+ ListTransactionsByCreateTime func(ctx context.Context, after *apitypes.ManagedTX, limit int, dir SortDirection) ([]*apitypes.ManagedTX, error)

+ ListTransactionsByNonce func(ctx context.Context, signer string, after *fftypes.FFBigInt, limit int, ...) ([]*apitypes.ManagedTX, error)

+ ListTransactionsPending func(ctx context.Context, afterSequenceID string, limit int, dir SortDirection) ([]*apitypes.ManagedTX, error)

+ SetTransactionReceipt func(ctx context.Context, txID string, receipt *ffcapi.TransactionReceiptResponse) error

+ UpdateTransaction func(ctx context.Context, txID string, updates *apitypes.TXUpdates) error