Crate bitcoinrpc_util

Modules

• rpc_arg
• rpc_help_man
• rpc_result

Structs

• DescribeAddressVisitor

  ---

• RPCArg

  ---

• RPCExamples
• RPCHelpMan
• RPCResult

  ---

• RPCResults

  ---

• Section
  | A pair of strings that can be aligned | (through padding) with other Sections | later on |
• Sections
  | Keeps track of RPCArgs by transforming | them into sections for the purpose of | serializing everything to a single | string |
• UniValueType
  | Wrapper for UniValue::VType, which | includes typeAny: | | Used to denote don’t care type. |

Enums

• OuterType
  | Serializing JSON objects depends on | the outer type. Only arrays and dictionaries | can be nested in json. The top-level | outer type is “NONE”. |

Constants

• EXAMPLE_ADDRESS
• UNIX_EPOCH_TIME

Traits

• ToDescriptionString

Functions

• add_and_get_multisig_destination
  | Creates a multisig address from a given | list of public keys, number of signatures | required, and the address type |
• addr_to_pub_key
  | Retrieves a public key for an address | from the given FillableSigningProvider |
• amount_from_value
  | Validate and return a CAmount from a | UniValue number or string. | | ———– | @param[in] value | | UniValue number or string to parse. | ––––– | @param[in] decimals | | Number of significant digits (default: | 8). | | ———– | @return | | a CAmount if the various checks pass. |
• describe_address
• eval_descriptor_string_or_object
  | Evaluate a descriptor given as a string, | or as a {“desc”:…,“range”:…} object, | with default range of 1000. |
• get_services_names
  | Returns, given services flags, a list | of humanly readable (known) network | services |
• help_example_cli
• help_example_cli_named
• help_example_rpc
• help_example_rpc_named
• hex_to_pub_key
  | Converts a hex string to a public key | if possible |
• jsonrpc_transaction_error
• parse_confirm_target
  | Parse a confirm target option and raise | an RPC error if it is invalid. |
• parse_descriptor_range
  | Parse a JSON range specified as int64, | or [int64, int64] |
• parse_hasho
• parse_hashv
  | Utilities: convert hex-encoded Values | (throws error if not hex). |
• parse_hexo
• parse_hexv
• parse_range
• rpc_error_from_transaction_error
• rpc_type_check
  | Type-check arguments; throws JSONRPCError | if wrong type given. Does not check that | the right number of arguments are passed, | just that any passed are the correct | type. |
• rpc_type_check_argument
  | Type-check one argument; throws JSONRPCError | if wrong type given. |
• rpc_type_check_obj
  | Check for expected keys/value types | in an Object. |
• shell_quote
  | Quote an argument for shell. | | ———– | @note | | This is intended for help, not for security-sensitive | purposes. |
• shell_quote_if_needed
  | Shell-quotes the argument if it needs | quoting, else returns it literally, | to save typing. | | ———– | @note | | This is intended for help, not for security-sensitive | purposes. |

Type Definitions

• RPCArgList