• Top
  • Documentation
  • Books
  • Boolean-reasoning
  • Projects
  • Debugging
  • Std
  • Proof-automation
  • Macro-libraries
  • ACL2
  • Interfacing-tools
  • Hardware-verification
  • Software-verification
    • Kestrel-books
      • Crypto-hdwallet
        • Command-error
          • Command-error-p
          • Command-error-fix
          • Command-error-case
          • Command-error-kind
          • Command-error-equiv
          • Command-error-wrong-number-of-arguments
          • Command-error-address-key-index-too-large
          • Command-error-wrong-command
          • Command-error-malformed-value
          • Command-error-malformed-to
          • Command-error-malformed-passphrase
          • Command-error-malformed-nonce
          • Command-error-malformed-mnemonic
          • Command-error-malformed-gas-price
          • Command-error-malformed-gas-limit
          • Command-error-malformed-entropy
          • Command-error-malformed-data
          • Command-error-malformed-address-key-index
          • Command-error-address-key-index-skipped
          • Command-error-address-key-derivation-fail
          • Command-error-transaction-sign-fail
          • Command-error-transaction-rlp-fail
          • Command-error-state-file-untestable
          • Command-error-state-file-present
          • Command-error-state-file-not-regular
          • Command-error-state-file-malformed
          • Command-error-state-file-absent
          • Command-error-root-key-derivation-fail
          • Command-error-purpose-key-derivation-fail
          • Command-error-pretransaction-rlp-fail
          • Command-error-no-command
          • Command-error-external-chain-key-derivation-fail
          • Command-error-coin-type-key-derivation-fail
          • Command-error-address-key-index-limit
          • Command-error-account-key-derivation-fail
        • Sign
        • Init-from-mnemonic
        • Command-error-message
        • Stat
        • Next-key
        • Init-from-entropy
        • Process-command
        • Transaction-message
        • Maybe-command-error
        • Maybe-stat
        • Check-stat-file-present
        • Valid-key-path-p
        • String-to-byte-list
        • Load-stat
        • Mnemonic-message
        • Process-sign
        • Process-init-from-entropy
        • All-valid-key-paths-p
        • String-to-word
        • String-to-nat
        • Process-next-key
        • Wallet
        • Process-init-from-mnemonic
        • Check-stat-file-absent
        • Stat-wfp
        • Save-stat
        • Stat-addresses-bounded-p
        • Stat-all-valid-key-paths-p
        • Stat-priv-keys-p
        • Stat-root-depth-zero-p
        • Stat-path-prefix-in-tree-p
        • Crypto-hdwallet-executable
        • *stat-filepath*
        • *key-path-prefix*
        • *coin-type-index*
        • *purpose-index*
        • *external-chain-index*
        • *command-name-init-from-mnemonic*
        • *command-name-init-from-entropy*
        • *account-index*
        • *command-name-sign*
        • *command-name-next-key*
      • Apt
      • Error-checking
      • Fty-extensions
      • Isar
      • Kestrel-utilities
      • Set
      • Soft
      • C
      • Bv
      • Imp-language
      • Event-macros
      • Java
      • Bitcoin
      • Ethereum
      • Yul
      • Zcash
      • ACL2-programming-language
      • Prime-fields
      • Json
      • Syntheto
      • File-io-light
      • Cryptography
      • Number-theory
      • Lists-light
      • Axe
      • Builtins
      • Solidity
      • Helpers
      • Htclient
      • Typed-lists-light
      • Arithmetic-light
    • X86isa
    • Axe
    • Execloader
  • Math
  • Testing-utilities

• Command-error

Command-error-case

Case macro for the different kinds of command-error structures.

This is an ACL2::fty sum-type case macro, typically introduced by fty::defflexsum or fty::deftagsum. It allows you to safely check the type of a command-error structure, or to split into cases based on its type.

Short Form

In its short form, command-error-case allows you to safely check the type of a command-error structure. For example:

(command-error-case x :malformed-mnemonic)

is essentially just a safer alternative to writing:

(equal (command-error-kind x) :malformed-mnemonic)

Why is using command-error-case safer? When we directly inspect the kind with equal, there is no static checking being done to ensure that, e.g., :malformed-mnemonic is a valid kind of command-error structure. That means there is nothing to save you if, later, you change the kind keyword for this type from :malformed-mnemonic to something else. It also means you get no help if you just make a typo when writing the :malformed-mnemonic symbol. Over the course of developing VL, we found that such issues were very frequent sources of errors!

Long Form

In its longer form, command-error-case allows you to split into cases based on the kind of structure you are looking at. A typical example would be:

(command-error-case x
  :malformed-mnemonic ...
  :malformed-passphrase ...
  :malformed-entropy ...
  :malformed-nonce ...
  :malformed-gas-price ...
  :malformed-gas-limit ...
  :malformed-to ...
  :malformed-value ...
  :malformed-data ...
  :malformed-address-key-index ...
  :address-key-index-too-large ...
  :address-key-index-skipped ...
  :root-key-derivation-fail ...
  :purpose-key-derivation-fail ...
  :coin-type-key-derivation-fail ...
  :account-key-derivation-fail ...
  :external-chain-key-derivation-fail ...
  :address-key-derivation-fail ...
  :address-key-index-limit ...
  :pretransaction-rlp-fail ...
  :transaction-sign-fail ...
  :transaction-rlp-fail ...
  :state-file-untestable ...
  :state-file-absent ...
  :state-file-present ...
  :state-file-not-regular ...
  :state-file-malformed ...
  :wrong-number-of-arguments ...
  :wrong-command ...
  :no-command ...)

It is also possible to consolidate ``uninteresting'' cases using :otherwise.

For convenience, the case macro automatically binds the fields of x for you, as appropriate for each case. That is, in the :malformed-mnemonic case, you can use fty::defprod-style foo.bar style accessors for x without having to explicitly add a malformed-mnemonic b* binder.