migrating outgoing.rs to snafu error handling #3854

cryptoni9n · 2024-07-12T20:54:03Z

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

…-to-snafu-error

cryptoni9n · 2024-08-15T16:32:55Z

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!

…om/cryptoni9n/ord into convert-outgoing.rs-to-snafu-error

casey

Looks good! Left a couple comments.

casey · 2024-08-15T18:36:07Z

src/error.rs

@@ -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 {


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

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.

casey · 2024-08-15T18:38:36Z

src/error.rs

+  #[snafu(display("Unrecognized outgoing: `{}`", input))]
+  UnrecognizedOutgoing { input: String },
+  #[snafu(display("Failed to parse decimal: {}", source))]
+  DecimalParse { source: error::Error, input: String },


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

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

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

ok, updates pushed.

…om/cryptoni9n/ord into convert-outgoing.rs-to-snafu-error

casey

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.

* 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>

* 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>

* 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) * Update JSON-API & Recursive documentation (ordinals#3984) * Document POST method for /inscriptions (ordinals#4017) * Add authors to Handbook (ordinals#4018) * Add more info to `wallet outputs` (ordinals#4019) * Add `wallet addresses` (ordinals#4005) * Add BIP322 `wallet sign` (ordinals#3988) * Add `/r/undelegated-content/<INSCRIPTION_ID>` (ordinals#3932) * Show total child count (ordinals#4009) * Create change output when inputs containing non-outgoing runes are selected (ordinals#4028) * Release 0.21.2 (ordinals#4029) - Bump version: 0.21.1 → 0.21.2 - Update changelog - Update changelog contributor credits * Allow fallback for satpoints and addresses (ordinals#4033) * Un-pin redb dependency and update to 2.2.0 (ordinals#4032) * Add `ord wallet split` command for splitting utxos (ordinals#4030) * Hide image preview and thumbnail scrollbars (ordinals#4042) * Rescan wallet on restore (ordinals#4041) * Do not chunk runestone data pushes (ordinals#4036) * Add simple taproot HD wallet to mockcore (ordinals#4038) * Collapse long strings in HTML (ordinals#4053) * BIP322 sign file (ordinals#4026) * Identify collapsible nodes with class=collapse (ordinals#4055) * Add assert_html function (ordinals#4058) * Allow including metadata when burning inscriptions (ordinals#4045) * Get output information by address (ordinals#4056) * Document split command (ordinals#4062) * Add palindrome charm (ordinals#4064) * Allow restoring wallet with custom timestamp (ordinals#4065) * Release 0.21.3 (ordinals#4059) - Bump version: 0.21.2 → 0.21.3 - Update changelog - Update changelog contributor credits - Update dependencies - Pin `bitcoin` to 0.32.3 - Downgrade `bip322` to 0.0.8 * Add Cargo.lock --------- 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: Arik <arik-so@users.noreply.github.com>

cryptoni9n and others added 2 commits July 12, 2024 16:51

convert-outgoing.rs-to-snafu

d58b9ef

Merge branch 'master' into convert-outgoing.rs-to-snafu-error

da4bc24

cryptoni9n closed this Jul 12, 2024

cryptoni9n reopened this Jul 12, 2024

cryptoni9n changed the title ~~convert-outgoing.rs-to-snafu-error~~ migrating outgoing.rs to snafu error handling Jul 12, 2024

cryptoni9n closed this Jul 15, 2024

cryptoni9n deleted the convert-outgoing.rs-to-snafu-error branch July 15, 2024 15:03

cryptoni9n restored the convert-outgoing.rs-to-snafu-error branch July 15, 2024 15:05

cryptoni9n reopened this Jul 15, 2024

cryptoni9n added 3 commits July 15, 2024 20:46

migrate-object.rs-to-snafu

5af8d79

Merge remote-tracking branch 'origin/master' into convert-outgoing.rs…

7d4c881

…-to-snafu-error

merging master / resolving conflicts

4475df5

cryptoni9n closed this Aug 8, 2024

cryptoni9n reopened this Aug 8, 2024

cryptoni9n marked this pull request as draft August 9, 2024 02:34

Merge branch 'ordinals:master' into convert-outgoing.rs-to-snafu-error

540ac4a

cryptoni9n marked this pull request as ready for review August 15, 2024 16:31

cryptoni9n added 2 commits August 15, 2024 12:39

updated with snafu_context

a190e59

Merge branch 'convert-outgoing.rs-to-snafu-error' of https://github.c…

7754561

…om/cryptoni9n/ord into convert-outgoing.rs-to-snafu-error

casey requested changes Aug 15, 2024

View reviewed changes

cryptoni9n added 2 commits August 15, 2024 16:04

updating error names per request

0752180

cargo fmt

53f607a

cryptoni9n closed this Aug 15, 2024

cryptoni9n reopened this Aug 15, 2024

Merge branch 'master' into convert-outgoing.rs-to-snafu-error

b6730d4

cryptoni9n closed this Aug 16, 2024

cryptoni9n reopened this Aug 16, 2024

cryptoni9n added 2 commits August 16, 2024 20:38

combining errors

2118718

Merge branch 'convert-outgoing.rs-to-snafu-error' of https://github.c…

0c10041

…om/cryptoni9n/ord into convert-outgoing.rs-to-snafu-error

cryptoni9n and others added 2 commits August 16, 2024 20:42

placate clippy

c52ea8a

Merge branch 'master' into convert-outgoing.rs-to-snafu-error

f346a4f

raphjaph requested a review from casey August 17, 2024 13:38

Tweak

1c00dcb

casey approved these changes Aug 17, 2024

View reviewed changes

Enhance

8d612ad

casey enabled auto-merge (squash) August 17, 2024 20:29

casey merged commit 75bf04b into ordinals:master Aug 17, 2024
5 checks passed

cryptoni9n deleted the convert-outgoing.rs-to-snafu-error branch August 18, 2024 19:05

BrewTestBot mentioned this pull request Sep 3, 2024

ord 0.20.0 Homebrew/homebrew-core#183374

Merged

popcnt1 pushed a commit to popcnt1/ord that referenced this pull request Jan 11, 2025

Migrate Outgoing to SnafuError (ordinals#3854)

b656480

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

migrating outgoing.rs to snafu error handling #3854

migrating outgoing.rs to snafu error handling #3854

cryptoni9n commented Jul 12, 2024 •

edited

Loading

cryptoni9n commented Aug 15, 2024

casey left a comment

casey Aug 15, 2024

cryptoni9n Aug 15, 2024

casey Aug 15, 2024

cryptoni9n Aug 15, 2024

casey Aug 16, 2024

cryptoni9n Aug 17, 2024

casey left a comment •

edited

Loading

migrating outgoing.rs to snafu error handling #3854

migrating outgoing.rs to snafu error handling #3854

Conversation

cryptoni9n commented Jul 12, 2024 • edited Loading

cryptoni9n commented Aug 15, 2024

casey left a comment

Choose a reason for hiding this comment

casey Aug 15, 2024

Choose a reason for hiding this comment

cryptoni9n Aug 15, 2024

Choose a reason for hiding this comment

casey Aug 15, 2024

Choose a reason for hiding this comment

cryptoni9n Aug 15, 2024

Choose a reason for hiding this comment

casey Aug 16, 2024

Choose a reason for hiding this comment

cryptoni9n Aug 17, 2024

Choose a reason for hiding this comment

casey left a comment • edited Loading

Choose a reason for hiding this comment

cryptoni9n commented Jul 12, 2024 •

edited

Loading

casey left a comment •

edited

Loading