Skip to main content

Module keychain

Module keychain 

Source

StructsΒ§

AnvilNodeInfo πŸ”’
AuthScopesJson
Newtype wrapper for parsed key-authorization --scopes JSON.
DoctorCandidate πŸ”’
Candidate subject collected before the RPC chain is known.
DoctorContext πŸ”’
DoctorStep πŸ”’
DoctorSubject πŸ”’
Result of resolving a local registry entry for the doctor.
InspectedLimit πŸ”’
JsonCallScope πŸ”’
Represents a single scope entry in JSON format for --scopes.
JsonSelectorWithRecipients πŸ”’
KeyAuthorizationArgs
Common fields for cast key-authorization encode and cast key-authorization sign.
KeyMetadata πŸ”’
LocalCandidateResolution πŸ”’
LocalLimitMetadata πŸ”’
ScopesJson
Newtype wrapper for parsed --scopes JSON so clap can treat it as a single value.
SponsorshipDiagnosis πŸ”’
ValidKeyAuthorization πŸ”’

EnumsΒ§

AllowedCallMatch πŸ”’
Outcome of TIP-1011 allowed-call matching.
AllowedCallsView πŸ”’
ChainTimestamp πŸ”’
DoctorStatus πŸ”’
JsonSelectorEntry πŸ”’
A selector entry can be either a plain string or an object with recipients.
KeyAuthorizationSubcommand
Tempo key-authorization artifact helpers.
KeyRegistrationState πŸ”’
KeychainPolicySubcommand
Higher-level access-key policy editing commands.
KeychainRootSigner πŸ”’
KeychainSubcommand
Tempo keychain management commands.
KeychainTxOutcome πŸ”’

FunctionsΒ§

abi_scope_to_auth_scope πŸ”’
active_from_anvil_node_info πŸ”’
add_selector_rule_to_scope πŸ”’
address_label πŸ”’
address_label_with_address πŸ”’
allowed_calls_to_json πŸ”’
anvil_tempo_hardfork_active πŸ”’
auth_signature_type_label πŸ”’
auth_signature_type_name πŸ”’
call_scope_to_json πŸ”’
check_allowed_calls πŸ”’
Step 8 helper: allowed calls (TIP-1011).
check_authorization_allowed_calls πŸ”’
check_authorization_expiry πŸ”’
check_authorization_spending_limits πŸ”’
check_expiring_nonce πŸ”’
Step 12 helper: validate TIP-1009 expiring-nonce options, if supplied.
check_expiring_nonce_window πŸ”’
check_fee_token_balance πŸ”’
Step 9 helper: fee-token balance on the root account.
check_hardfork πŸ”’
check_key_expiry πŸ”’
check_local_signing_readiness πŸ”’
Step 4 helper: verify whether the local side can actually sign as the key.
check_spending_limits πŸ”’
Step 7 helper: spending limits.
check_sponsorship πŸ”’
Step 13 helper: validate sponsorship configuration, if supplied.
collect_local_candidates πŸ”’
Step 1 helper: collect local registry candidates.
decode_and_validate_key_authorization πŸ”’
Decode a hex RLP key authorization (signed or unsigned) and validate its account binding.
decoded_entry_key_authorization πŸ”’
diagnose_allowed_scopes πŸ”’
encode_key_authorization πŸ”’
ensure_key_authorization_root_sender πŸ”’
Ensures key authorization artifacts are signed by the expected root account.
ensure_root_sender πŸ”’
Ensures AccountKeychain calls with a known root account use that root as the signer.
ensure_tempo_precompile_active πŸ”’
Fails early with requirement when a Tempo precompile is not active yet: a pre-fork call would succeed as a silent no-op instead of reverting. Prefers the hardfork query and falls back to checking the precompile’s code when the RPC lacks the method.
fetch_chain_timestamp πŸ”’
finalize_doctor πŸ”’
Render the doctor result and return.
format_authorization_limits πŸ”’
format_duration_words πŸ”’
format_expiry πŸ”’
format_expiry_for_inspect πŸ”’
format_period_end πŸ”’
format_recipients πŸ”’
format_relative_timestamp πŸ”’
format_relative_timestamp_from πŸ”’
format_selector πŸ”’
format_timestamp_iso πŸ”’
inspected_limit_to_json πŸ”’
is_rpc_method_not_found πŸ”’
is_tempo_hardfork_active πŸ”’
key_entry_effective_key πŸ”’
key_entry_to_json πŸ”’
key_metadata_from_entry πŸ”’
key_type_label πŸ”’
key_type_matches_authorization πŸ”’
key_type_name πŸ”’
load_keys_file πŸ”’
local_key_role πŸ”’
Classify a local key entry’s role for display.
match_allowed_call πŸ”’
Pure TIP-1011 matching logic. Extracted so it can be unit-tested.
parse_auth_limit πŸ”’
Parse a key-authorization --limit TOKEN:AMOUNT[:PERIOD] flag value.
parse_auth_scope πŸ”’
parse_auth_scopes_json_wrapped πŸ”’
parse_auth_signature_type πŸ”’
parse_limit πŸ”’
Parse a --limit TOKEN:AMOUNT flag value.
parse_scopes_json πŸ”’
Parse --scopes JSON flag value.
parse_scopes_json_wrapped πŸ”’
Parse --scopes JSON flag value into the newtype wrapper.
parse_signature_type πŸ”’
print_allowed_calls πŸ”’
print_doctor_step πŸ”’
print_inspected_limits πŸ”’
print_key_entry πŸ”’
print_signed_key_authorization πŸ”’
redact_private_key_uri_tokens πŸ”’
resolve_key_metadata πŸ”’
resolve_keychain_root_signer πŸ”’
Resolve the root-authorized signer used for AccountKeychain policy changes.
run_authorize πŸ”’
cast keychain authorize / cast keychain auth β€” authorize a key on-chain.
run_burn_witness πŸ”’
cast keychain burn-witness β€” burn a TIP-1053 key authorization witness.
run_check πŸ”’
cast keychain check / cast keychain info β€” query on-chain key status.
run_doctor πŸ”’
cast keychain doctor β€” diagnose access-key signing failures.
run_inspect πŸ”’
cast keychain inspect <key_address> β€” inspect on-chain key policy.
run_is_admin πŸ”’
cast keychain is-admin β€” check whether a key is the root or an active admin key (T6).
run_is_witness_burned πŸ”’
cast keychain is-witness-burned β€” check TIP-1053 witness burn state.
run_key_auth_encode πŸ”’
run_key_auth_inspect πŸ”’
cast key-authorization inspect β€” decode a signed or unsigned key authorization and print its fields, including the T6 is_admin / account fields.
run_key_auth_sign πŸ”’
run_list πŸ”’
cast keychain list β€” display all entries from keys.toml.
run_policy_add_call πŸ”’
cast keychain policy add-call β€” merge a selector rule into a target scope.
run_policy_set_limit πŸ”’
cast keychain policy set-limit β€” update a spending limit amount.
run_remaining_limit πŸ”’
cast keychain rl β€” query remaining spending limit.
run_remove_scope πŸ”’
cast keychain rs β€” remove call scope for a target.
run_revoke πŸ”’
cast keychain revoke / cast keychain rev β€” revoke a key on-chain.
run_set_scope πŸ”’
cast keychain ss β€” set allowed call scopes.
run_show πŸ”’
cast keychain show <wallet_address> β€” show keys for a specific wallet.
run_update_limit πŸ”’
cast keychain ul β€” update spending limit.
run_verify_keychain πŸ”’
cast keychain verify / verify-admin β€” verify a Tempo keychain signature (T6).
sanitize_sponsor_config_error πŸ”’
select_subject_for_chain πŸ”’
Step 3 helper: filter candidates to the RPC chain id and pick a single entry.
selector_hex πŸ”’
selector_rule_to_json πŸ”’
selector_signature πŸ”’
send_keychain_tx πŸ”’
Send calldata to the Tempo AccountKeychain precompile as a root-authorized transaction.
send_keychain_tx_with_root_signer πŸ”’
Send AccountKeychain calldata with an already-resolved root signer.
signature_type_label πŸ”’
signature_type_name πŸ”’
tempo_keys_path_display πŸ”’
unix_timestamp_now πŸ”’
validate_admin_key_authorization πŸ”’
Enforce the T6 admin access-key invariants when constructing a key authorization.
validate_pending_key_authorization πŸ”’
wallet_type_name πŸ”’