• Top
    • Documentation
    • Books
    • Boolean-reasoning
    • Projects
    • Debugging
    • Std
    • Community
    • Proof-automation
    • Macro-libraries
    • ACL2
    • Interfacing-tools
    • Hardware-verification
    • Software-verification
      • Kestrel-books
        • Crypto-hdwallet
        • Apt
        • Error-checking
        • Fty-extensions
        • Isar
        • Kestrel-utilities
        • Set
        • Soft
        • C
        • Bv
        • Imp-language
        • Event-macros
        • Java
        • Bitcoin
          • Bip32
            • Bip32-wallet-structure
            • Bip32-key-trees
            • Bip32-key-serialization
            • Bip32-key-derivation
            • Bip32-executable-attachments
            • Bip32-extended-keys
              • Bip32-chain-code
              • Bip32-ext-pub-key
              • Bip32-ext-priv-key
              • Bip32-ext-key
                • Bip32-ext-key-fix
                • Bip32-ext-key-case
                  • Bip32-ext-key-equiv
                  • Bip32-ext-key-p
                  • Bip32-ext-key-pub
                  • Bip32-ext-key-priv
                  • Bip32-ext-key-kind
              • Bip32-master-key-generation
            • Bech32
            • Bip39
            • Bip44
            • Base58
            • Bip43
            • Bytes
            • Base58check
            • Cryptography
            • Bip-350
            • Bip-173
          • 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
    • Bip32-ext-key

    Bip32-ext-key-case

    Case macro for the different kinds of bip32-ext-key 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 bip32-ext-key structure, or to split into cases based on its type.

    Short Form

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

    (bip32-ext-key-case x :priv)

    is essentially just a safer alternative to writing:

    (equal (bip32-ext-key-kind x) :priv)

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

    Long Form

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

    (bip32-ext-key-case x
      :priv ...
      :pub ...)

    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 :priv case, you can use fty::defprod-style foo.bar style accessors for x without having to explicitly add a priv b* binder.