Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README based on latest changes for v0.3.0. #33

Merged
merged 1 commit into from
Apr 16, 2024
Merged

Update README based on latest changes for v0.3.0. #33

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
Loading