Unhelpful and unorganized error messages

[arboleya]

Origin story

We should organize all error messages and properly document them, so there is a consistent, helpful and descriptive set of error messages across the sdk instead of ones I experienced like "too small" with no value or details flagged.

Note

• Incoming from Feedback - WebAuthn App QA Results #1545

Requirements

• Document all FuelError with TypeDoc
• Replace all occurrences of Error to FuelError #2001
• Throw custom errors from findOrThrow method.
  chore: helper functions for common JsonAbi features #2000

Redundant error codes

PR: #2002

• FRAGMENT_NOT_FOUND due to the getFunction throwing a FUNCTION_NOT_FOUND
• INSUFFICIENT_BALANCE - no found in code anywhere apart from docs
• INVALID_URL - not used anywhere other than doc examples and tests
• LATEST_BLOCK_UNAVAILABLE - unused
• UNEXPECTED_HEX_VALUE - used in hexlifyWithPrefix, which could be simplified (see below). knownHex flag seems redudant only ever true, with these only two instances.

export const hexlifyWithPrefix = (value: string) => value.startsWith('0x') ? hexlify(value) : hexlify(`0x${value}`)

Discussion worthy

• Decoding and encoding error handling has room for improvement, would be good to get peoples thoughts on handling these errors.
• Consolidate INVALID_PASSWORD and INVALID_CREDENTIALS
• MemoryCache doesn't allow a value of 0 for the TTL and will throw INVALID_TTL.
  I believe 0 should be allowed, as this implies the cache should be skipped.
• We have two means of retrieving error codes for an error ErrorCode. and FuelError.CODES., I believe it should be one or the other, what do other people think?

Related

• Custom revert message not being pulled though.
  Reported in Error for decode erros in contract #1782
  Fixed by Supply better error messaging on Reverts #823.

[petertonysmith94]

@danielbate please tag me please

[petertonysmith94]

Moved this comment to the issue body 😃