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.

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

migrating outgoing.rs to snafu error handling #3854

Merged
merged 17 commits into from
Aug 17, 2024

Conversation

cryptoni9n
Copy link
Collaborator

@cryptoni9n cryptoni9n commented Jul 12, 2024

part of fix for #3192
converted src/outgoing.rs to use snafu instead of anyhow errors

@cryptoni9n cryptoni9n closed this Jul 12, 2024
@cryptoni9n cryptoni9n reopened this Jul 12, 2024
@cryptoni9n cryptoni9n changed the title convert-outgoing.rs-to-snafu-error migrating outgoing.rs to snafu error handling Jul 12, 2024
@cryptoni9n cryptoni9n closed this Jul 15, 2024
@cryptoni9n cryptoni9n deleted the convert-outgoing.rs-to-snafu-error branch July 15, 2024 15:03
@cryptoni9n cryptoni9n restored the convert-outgoing.rs-to-snafu-error branch July 15, 2024 15:05
@cryptoni9n cryptoni9n reopened this Jul 15, 2024
@cryptoni9n cryptoni9n closed this Aug 8, 2024
@cryptoni9n cryptoni9n reopened this Aug 8, 2024
@cryptoni9n cryptoni9n marked this pull request as draft August 9, 2024 02:34
@cryptoni9n cryptoni9n marked this pull request as ready for review August 15, 2024 16:31
@cryptoni9n
Copy link
Collaborator Author

Hi @casey - I revised this PR and tried to apply your advice from #3858 to it. Please review and let me know what you think - thanks!

Copy link
Collaborator

@casey casey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Left a couple comments.

src/error.rs Outdated
@@ -45,6 +46,39 @@ pub enum SnafuError {
},
#[snafu(display("Unrecognized representation `{}`", input))]
UnrecognizedRepresentation { source: error::Error, input: String },
#[snafu(display("Unrecognized outgoing amount: `{}`", input))]
UnrecognizedAmount {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I would call these *Parse instead of Unrecognized*.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Casey - I'm pushing changes now that rename all of the Unrecognized* errors, except for UnrecognizedRepresentation, because that was already merged as part of #3192.

src/error.rs Outdated
#[snafu(display("Unrecognized outgoing: `{}`", input))]
UnrecognizedOutgoing { input: String },
#[snafu(display("Failed to parse decimal: {}", source))]
DecimalParse { source: error::Error, input: String },
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is only used in parsing rune amounts, then maybe RuneAmountParse.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure thing, pushing changes now. Are you ok with having the following errors be so similar, or would you prefer to merge them?

OutgoingRuneParse and RuneParse
OutgoingSatParse and SatParse
OutgoingInscriptionIdParse and InscriptionIdParse

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whoops, sorry, I wasn't looking at those other errors. Those errors can all be combined. In general, existing errors should be reused.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, updates pushed.

@cryptoni9n cryptoni9n closed this Aug 15, 2024
@cryptoni9n cryptoni9n reopened this Aug 15, 2024
@cryptoni9n cryptoni9n closed this Aug 16, 2024
@cryptoni9n cryptoni9n reopened this Aug 16, 2024
@raphjaph raphjaph requested a review from casey August 17, 2024 13:38
Copy link
Collaborator

@casey casey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! I made a couple of small changes before merging.

  • If a name conflicts, I usually don't import and rename it, I just refer to it by its full name, so I removed the use bitcoin::address::Error as AddressError and just referred to it as bitcoin::address::Error.
  • I made Representation::from_str return a SnafuError, which avoids needing to wrap an anyhow error in a snafu error.

@casey casey enabled auto-merge (squash) August 17, 2024 20:29
@casey casey merged commit 75bf04b into ordinals:master Aug 17, 2024
5 checks passed
@cryptoni9n cryptoni9n deleted the convert-outgoing.rs-to-snafu-error branch August 18, 2024 19:05
danadi7 pushed a commit to sadoprotocol/ord that referenced this pull request Sep 20, 2024
* Change test-bitcoincore-rpc to mockcore in README.md (ordinals#3842)

* Commit twice to work around redb off-by-one bug (ordinals#3856)

* Release 0.19.1 (ordinals#3864)

- Bump version: 0.19.0 → 0.19.1
- Update changelog
- Update changelog contributor credits
- Update dependencies

* Update Portuguese Translation pt.po (ordinals#3837)

* Updated Chinese translation  (ordinals#3881)

* Fix rune links for runes with no symbol (ordinals#3849)

* Suppress printing sat_ranges by default (ordinals#3867)

* Re-enter beta (ordinals#3884)

* Update pointer specification (ordinals#3861)

* Clarify that unused runes tags should not be used (ordinals#3885)

* Migrate object.rs to snafu error handling (ordinals#3858)

* Make index settings harder to misuse (ordinals#3893)

* Don't unnecessarily insert into utxo cache when indexing addresses (ordinals#3894)

* Remove trailing space from runes specification (ordinals#3896)

* Serve responses with cross origin isolation headers (ordinals#3898)

* List all Bitcoin Core wallets (ordinals#3902)

* Make first first and last sat in range clickable (ordinals#3903)

* Migrate Outgoing to SnafuError (ordinals#3854)

* Update Bitcoin Core deploy to 27.1 (ordinals#3912)

* Add sat_balance to address API (ordinals#3905)

Co-authored-by: raph <raphjaph@protonmail.com>

* Add Dutch translation to Ordinals Handbook (ordinals#3907)

* Migrate chain.rs to snafu error (ordinals#3904)

* Bump version to 0.20.0-dev (ordinals#3916)

* Revert "Serve responses with cross origin isolation headers" (ordinals#3920)

* Remove inscription content type counts from /status page (ordinals#3922)

* Unified OUTPOINT_TO_UTXO_ENTRY table (ordinals#3915)

- Upgrade `redb` to 2.1.1
- Remove `--index-spent-sats`
- Remove redundant pointer handling in `index_inscriptions()`
- Fix incorrect `is_output_spent()` results when not using `--index-sats`
- Unify UTXO index data in `OUTPOINT_TO_UTXO_ENTRY` table
- Read addresses from index when exporting

* Add address field to `/r/inscription/:id` (ordinals#3891)

* Add inscriptions and runes details to address API endpoint (ordinals#3924)

* Release 0.20.0 (ordinals#3928)

- Bump ord version: 0.19.1 → 0.20.0
- Bump ordinals version: 0.0.9 → 0.0.10
- Update changelog
- Update changelog contributor credits
- Update dependencies

---------

Co-authored-by: Anchor <49644098+TheHeBoy@users.noreply.github.com>
Co-authored-by: Casey Rodarmor <casey@rodarmor.com>
Co-authored-by: 0xArtur <metaverseartur@gmail.com>
Co-authored-by: Dr.JingLee <95461562+DrJingLee@users.noreply.github.com>
Co-authored-by: nine <118634361+cryptoni9n@users.noreply.github.com>
Co-authored-by: Bohdan Cryptolions <37701692+ansigroup@users.noreply.github.com>
Co-authored-by: raph <raphjaph@protonmail.com>
Co-authored-by: Patrick Collins <patrick@collinatorstudios.com>
Co-authored-by: Tibebtc <tibedekock@live.nl>
Co-authored-by: partialord <178683722+partialord@users.noreply.github.com>
Co-authored-by: Eloc <42568538+elocremarc@users.noreply.github.com>
Co-authored-by: twosatsmaxi <vashalpesh@gmail.com>
dcorral added a commit to sadoprotocol/ord that referenced this pull request Oct 24, 2024
* Change test-bitcoincore-rpc to mockcore in README.md (ordinals#3842)

* Commit twice to work around redb off-by-one bug (ordinals#3856)

* Release 0.19.1 (ordinals#3864)

- Bump version: 0.19.0 → 0.19.1
- Update changelog
- Update changelog contributor credits
- Update dependencies

* Update Portuguese Translation pt.po (ordinals#3837)

* Updated Chinese translation  (ordinals#3881)

* Fix rune links for runes with no symbol (ordinals#3849)

* Suppress printing sat_ranges by default (ordinals#3867)

* Re-enter beta (ordinals#3884)

* Update pointer specification (ordinals#3861)

* Clarify that unused runes tags should not be used (ordinals#3885)

* Migrate object.rs to snafu error handling (ordinals#3858)

* Make index settings harder to misuse (ordinals#3893)

* Don't unnecessarily insert into utxo cache when indexing addresses (ordinals#3894)

* Remove trailing space from runes specification (ordinals#3896)

* Serve responses with cross origin isolation headers (ordinals#3898)

* List all Bitcoin Core wallets (ordinals#3902)

* Make first first and last sat in range clickable (ordinals#3903)

* Migrate Outgoing to SnafuError (ordinals#3854)

* Update Bitcoin Core deploy to 27.1 (ordinals#3912)

* Add sat_balance to address API (ordinals#3905)

Co-authored-by: raph <raphjaph@protonmail.com>

* Add Dutch translation to Ordinals Handbook (ordinals#3907)

* Migrate chain.rs to snafu error (ordinals#3904)

* Bump version to 0.20.0-dev (ordinals#3916)

* Revert "Serve responses with cross origin isolation headers" (ordinals#3920)

* Remove inscription content type counts from /status page (ordinals#3922)

* Unified OUTPOINT_TO_UTXO_ENTRY table (ordinals#3915)

- Upgrade `redb` to 2.1.1
- Remove `--index-spent-sats`
- Remove redundant pointer handling in `index_inscriptions()`
- Fix incorrect `is_output_spent()` results when not using `--index-sats`
- Unify UTXO index data in `OUTPOINT_TO_UTXO_ENTRY` table
- Read addresses from index when exporting

* Add address field to `/r/inscription/:id` (ordinals#3891)

* Add inscriptions and runes details to address API endpoint (ordinals#3924)

* Release 0.20.0 (ordinals#3928)

- Bump ord version: 0.19.1 → 0.20.0
- Bump ordinals version: 0.0.9 → 0.0.10
- Update changelog
- Update changelog contributor credits
- Update dependencies

* Bump version to 0.20.0-dev (ordinals#3929)

* Add test to remind us to fix the UtxoEntry redb type name (ordinals#3934)

* Put AddressInfo into api module (ordinals#3933)

* Fix clippy lint (ordinals#3937)

* Add inscription index to /status (ordinals#3938)

* Remove unnecessary symbols in docs/src/guides/testing.md (ordinals#3945)

* Add inscription examples to handbook (ordinals#3769)

* Allow scrolling in iframe (ordinals#3947)

* Skip serializing None in batch::File (ordinals#3943)

* Fix /output page (ordinals#3948)

* Add `/satpoint/<SATPOINT>` endpoint (ordinals#3949)

* Don't log RPC connections to bitcoind (ordinals#3952)

* Start indexing at correct block height (ordinals#3956)

* Fix output API struct (ordinals#3957)

* Remove dependency on `ord-bitcoincore-rpc` crate (ordinals#3959)

* Keep sat ranges in low-level format (ordinals#3963)

* Implement burn for wallet command (ordinals#3437)

* Add multi parent support to wallet (ordinals#3228)

* Get parents using `as_slice` instead of converting to `Vec` (ordinals#3972)

* Rename parents_values -> parent_values (ordinals#3973)

* Fix non-existant output lookup (ordinals#3968)

* Release 0.20.1 (ordinals#3975)

* Refactor burn command (ordinals#3976)

* Remove regtest.ordinals.net just recipes (ordinals#3978)

* Add `ord verify` (ordinals#3906)

* Release 0.21.0 (ordinals#3997)

- Bump version: 0.20.1 → 0.21.0
- Update changelog
- Update changelog contributor credits
- Update dependencies

* Remove /runes/balances API endpoint (ordinals#3980)

* Update rust-bitcoin in ord (ordinals#3962)

* Revert redb to 2.1.3 (ordinals#4003)

* Release 0.21.1 (ordinals#4006)

* Update Bitcoin Core install script (ordinals#4007)

* Remove pre-alpha warning from ord help (ordinals#4011)

* Change mint progress to `mints / terms.cap` (ordinals#4012)

* Only show rune mint progress during mint (ordinals#4013)

* Show if JSON API is enabled on /status (ordinals#4014)

* Fix build error

---------

Co-authored-by: Anchor <49644098+TheHeBoy@users.noreply.github.com>
Co-authored-by: Casey Rodarmor <casey@rodarmor.com>
Co-authored-by: 0xArtur <metaverseartur@gmail.com>
Co-authored-by: Dr.JingLee <95461562+DrJingLee@users.noreply.github.com>
Co-authored-by: nine <118634361+cryptoni9n@users.noreply.github.com>
Co-authored-by: Bohdan Cryptolions <37701692+ansigroup@users.noreply.github.com>
Co-authored-by: raph <raphjaph@protonmail.com>
Co-authored-by: Patrick Collins <patrick@collinatorstudios.com>
Co-authored-by: Tibebtc <tibedekock@live.nl>
Co-authored-by: partialord <178683722+partialord@users.noreply.github.com>
Co-authored-by: Eloc <42568538+elocremarc@users.noreply.github.com>
Co-authored-by: twosatsmaxi <vashalpesh@gmail.com>
Co-authored-by: tiaoxizhan <tiaoxizhan@outlook.com>
Co-authored-by: onchainguy <1436535+onchainguy-btc@users.noreply.github.com>
Co-authored-by: lifofifo <134870335+lifofifoX@users.noreply.github.com>
Co-authored-by: dcorral <hi@dcorral.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants