Refine Address error types
#2225
Conversation
This stack of pull requests is managed by Graphite. Learn more about stacking. Join @steveluscher and the rest of your teammates on |
| } catch (e) { | ||
| throw new SolanaError(SOLANA_ERROR__NOT_A_BASE58_ENCODED_ADDRESS, { putativeAddress }); | ||
| // Fast-path; see if the input string is of an acceptable length. | ||
| if ( | ||
| // Lowest address (32 bytes of zeroes) | ||
| putativeAddress.length < 32 || | ||
| // Highest address (32 bytes of 255) | ||
| putativeAddress.length > 44 | ||
| ) { | ||
| throw new SolanaError(SOLANA_ERROR__ADDRESS_STRING_LENGTH_OUT_OF_RANGE, { | ||
| actualLength: putativeAddress.length, | ||
| }); | ||
| } | ||
| // Slow-path; actually attempt to decode the input string. | ||
| const base58Encoder = getMemoizedBase58Encoder(); | ||
| const bytes = base58Encoder.encode(putativeAddress); | ||
| const numBytes = bytes.byteLength; | ||
| if (numBytes !== 32) { | ||
| throw new SolanaError(SOLANA_ERROR__ADDRESS_BYTE_LENGTH_OUT_OF_RANGE, { | ||
| actualLength: numBytes, | ||
| }); | ||
| } |
There was a problem hiding this comment.
@buffalojoec, I missed this in #2187. This used to aim to create an ‘all up’ error that the address is bad, with the inner error as the cause. Now that we have codes and separate errors for each cause, I don't think we need this.
Also, #2187 buried the sub errors so that they'd never reach the caller.
There was a problem hiding this comment.
Ahh, I see. Nice catch! So can't NOT_A_BASE_58_ADDRESS come out then?
There was a problem hiding this comment.
That one would have bubbled up, yes, but the others would never have seen the light of day.
I think in other PRs we consolidated on throwing granular errors, rather than one error with a cause.
| export const SOLANA_ERROR__ADDRESS_BYTE_LENGTH_OUT_OF_RANGE = 13 as const; | ||
| export const SOLANA_ERROR__ADDRESS_STRING_LENGTH_OUT_OF_RANGE = 14 as const; |
There was a problem hiding this comment.
Massaged these names while I was here. tl;dr I'm converting blockhash.ts and it's exactly the same as address.ts.
steveluscher
force-pushed
the
03-01-Refine_Address_error_types
branch
from
1d75ecf
to
34d5666
Compare
| } catch (e) { | ||
| throw new SolanaError(SOLANA_ERROR__NOT_A_BASE58_ENCODED_ADDRESS, { putativeAddress }); | ||
| // Fast-path; see if the input string is of an acceptable length. | ||
| if ( | ||
| // Lowest address (32 bytes of zeroes) | ||
| putativeAddress.length < 32 || | ||
| // Highest address (32 bytes of 255) | ||
| putativeAddress.length > 44 | ||
| ) { | ||
| throw new SolanaError(SOLANA_ERROR__ADDRESS_STRING_LENGTH_OUT_OF_RANGE, { | ||
| actualLength: putativeAddress.length, | ||
| }); | ||
| } | ||
| // Slow-path; actually attempt to decode the input string. | ||
| const base58Encoder = getMemoizedBase58Encoder(); | ||
| const bytes = base58Encoder.encode(putativeAddress); | ||
| const numBytes = bytes.byteLength; | ||
| if (numBytes !== 32) { | ||
| throw new SolanaError(SOLANA_ERROR__ADDRESS_BYTE_LENGTH_OUT_OF_RANGE, { | ||
| actualLength: numBytes, | ||
| }); | ||
| } |
There was a problem hiding this comment.
Ahh, I see. Nice catch! So can't NOT_A_BASE_58_ADDRESS come out then?
steveluscher
force-pushed
the
03-01-Refine_Address_error_types
branch
from
34d5666
to
b59fecd
Compare
|
🎉 This PR is included in version 1.90.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
|
Because there has been no activity on this PR for 14 days since it was merged, it has been automatically locked. Please open a new issue if it requires a follow up. |
#2187 buried these address sub errors in such a way that they'd never reach the caller. This PR allows them to bubble up.
Addresses #2118.