From 6cfe82fc948aa644219d29ca8794332d55f0a8a9 Mon Sep 17 00:00:00 2001 From: derekpierre Date: Tue, 16 Apr 2024 09:12:41 -0400 Subject: [PATCH] Update readme based on latest changes for v0.3.0. --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2a23f1e..a76b1a9 100644 --- a/README.md +++ b/README.md @@ -43,9 +43,13 @@ machine = AutomaticTxMachine(w3=w3) future_tx = machine.queue_transaction( signer=account, params=transaction, + on_broadcast_failure=..., + on_fault=..., + on_finalized=..., + on_insufficient_funds=..., ) -reactor.start() +reactor.run() ``` ### Features @@ -67,9 +71,11 @@ They can be configured to use any kind of custom context, like gas oracles. Hooks are fired in a dedicated thread for lifecycle events. -- `on_broadcast`: When a transaction is broadcasted. -- `on_finalized`: When a transaction is finalized. -- `on_fault`: When a transaction reverted or another error occurred. +- `on_broadcast` _(Optional)_: When a transaction is broadcasted. +- `on_broadcast_failure`: When a transaction fails to broadcast. +- `on_finalized`: When a transaction is finalized (successful or reverted). +- `on_fault`: When a transaction error occurred. +- `on_insufficient_funds`: When the account associated with the transaction does not have enough funds for the transaction. ##### Crash-Tolerance