Expand description
Handshake wallet key roles, restoration, UTXO selection, and name workflows.
Structs§
- Accepted
HnsHeader - One newly agreed header and the consensus entry needed to verify its filtered-block evidence without trusting the peer that supplied it.
- Active
Name Owner Coin Evidence - Pruning-safe current NameState/owner-Coin projection. The source label distinguishes a trusted node UTXO projection from a Coin reconstructed by the wallet from a Merkle-verified transaction.
- Authorized
Name Operation - Block
Hash Evidence - Canonical
Name State Summary - Chain
Tip - Coin
Selection - Confirmed
Wallet Page - Confirmed
Wallet Page Request - Connected
HnsPeer - One completed version/verack connection registered with the local header authority. The identifier is random and connection-scoped, not authority.
- Created
Wallet - Current
Shakedex Lock Query - Exact caller-owned input for one query-scoped Shakedex lock lookup.
- Derived
HnsAddress - Embedded
HnsBackend - Encrypted
HnsLight Authority - Encrypted, wallet-owned Handshake light-chain authority.
- Encrypted
HnsLight Index - Encrypted account index whose only confirmed-state input is
VerifiedWalletBlock. - History
Entry - HnsAccount
Read Binding - Exact confirmed-chain and mempool authority for one synchronized account read. The trusted service composition retains this binding internally to prevent mixed-snapshot projections; website/provider JSON must not receive node identity, epoch, tip, or mempool-generation details.
- HnsAccount
Read Runtime - Synchronized, non-value HNS runtime for product/provider compositions that already own an exact account and one process-local store authority.
- HnsAccount
Read Snapshot - Complete non-value HNS account projection produced by one bounded wallet reconciliation. All fields are derived from the same chain/mempool binding.
- HnsAccount
Record - HnsBlock
Scan Batch Telemetry - Local timing breakdown for one atomically persisted filtered-block batch.
- HnsBlock
Scan Progress - Result of one bounded filtered-block scan.
- HnsBootstrap
Policy - Explicit chain policy for the one-account native-wallet bootstrap.
- HnsCanonical
Block - One snapshot-bound block supplied by HSRD.
raw == Nonewith a known hash means the canonical body was pruned. Present raw bytes passed Handshake body validation and have a header hash matchingblock_hash. - HnsChain
Checkpoint - HnsDirect
Peer Config - Native direct-peer policy for one wallet runtime.
- HnsDirect
Peer Coordinator - Complete wallet-owned direct HNS runtime. Clones share the same backend, persistent connections, and in-flight header-round state.
- HnsDirect
Shakescape Listener - A wallet-owned, nonblocking TCP admission point for direct Shakescape peers.
- HnsDirect
Shakescape Peer - One direct Shakescape Experimental V2 session owned by the wallet.
- HnsExisting
Account Selector - Read-only selector for one exact pre-existing HNS account held by the same Arc-backed store/key authority as its caller.
- HnsInbound
Network Peer - A stock-compatible inbound Handshake peer served from the wallet’s verified header authority. It intentionally exposes no wallet filters, names, keys, RPC, or arbitrary extension data.
- HnsInput
Coin Evidence - Serializable, exact input-coin evidence retained beside signed workflows. It carries all fields required by canonical script sigop and fee policy so restart/rebroadcast validation never falls back to a node assertion.
- HnsInput
Reservation - HnsLight
Floor - Rollback floor that callers retain in platform-protected monotonic storage.
- HnsLight
Scan Status - Persisted scan coverage for the exact watch set.
- HnsLight
Watch Set - Complete deterministic bloom-filter input set for one wallet account.
- HnsNode
RpcBackend - Concrete synchronous hns-node-rs wallet RPC v1 backend.
- HnsNode
RpcConfig - Trusted local configuration for the authenticated wallet RPC boundary.
- HnsOutpoint
- HnsPersisted
Recovery Read Only Runtime - Explicit recovery-only reader for one exact already-persisted HNS account whose historical configuration contains a value or settlement flag.
- HnsPrepared
Settlement Value Summary - Exact value accounting for a prepared HNS settlement transaction.
- HnsPrepared
Shakedex Funding - Product-owned result of selecting and binding the ordinary HNS funding suffix for one current Shakedex action. The generic prepared artifact is retained with the exact scope, reservations, fee, and optional change mutation that were computed from it; callers cannot independently replace one component.
- HnsPublic
Header Transport - Public-header access to the same live sockets used by the wallet. This weak handle exposes neither filters, store access nor signing authority. Every consumer must independently validate the returned untrusted headers.
- HnsPublic
Peer Sessions - Wallet-detached standard HSD transport sessions that contain no signing authority, encrypted store, watch set, wallet projection, or pending wallet-filter traffic.
- HnsReconciliation
Report - HnsRecoverable
Funding Plan - HnsRecovery
Contract - Structural match only. The runtime must verify inclusion, current unspent output and maturity independently before permitting a settlement spend.
- HnsRecovery
State - HnsRedeem
Submission - HnsRuntime
Config - HnsSettlement
Broadcast Guard - Exact persisted ShakeScape state that must still authorize a guarded HNS redeem when its signed transaction crosses the irreversible broadcast checkpoint. The workflow revision binds current funding authority; the signed-session entity revision binds the session and network policy that produced it.
- HnsShakedex
Change Reservation - Exact wallet-account mutation required when a funded Shakedex transaction uses the account’s current internal change address. The fields remain private so another crate cannot substitute a different account row or derivation after coin selection. The enclosing Shakedex workflow persists this save in the same immediate transaction as its input reservations.
- HnsShakedex
Funding Approval Expectation - Exact private-approval row expected by suffix authorization. The request bytes are deliberately opaque here: the Shakedex aggregate owns their market-terms schema, while this boundary requires byte-for-byte equality with the authenticated live store row.
- HnsShakedex
Funding Authorization - Signed exact transaction bytes plus the still-live authenticated approval row. The caller must pass that row to the store’s atomic consume-and-save CAS; this method never consumes approval separately from the aggregate.
- HnsShakedex
Funding Reservation - Complete persisted reservation identity for one script-controlled source and its ordered ordinary-wallet funding suffix. The private fields prevent callers from mutating only one part after construction, while serde permits the enclosing Shakedex aggregate to retain the exact evidence across a restart.
- HnsShakedex
Funding Reservation Batch - Opaque entity mutations that an enclosing Shakedex workflow passes to one of the wallet store’s existing workflow/entity CAS operations. Merely constructing this value never writes the database.
- HnsShakedex
Funding Scope - Opaque account namespace used to derive reservation record identifiers. It can only be obtained from an open HNS runtime, so an external workflow cannot silently substitute another wallet or account configuration.
- HnsShakedex
KeyAllocation - Immutable public recovery binding for one HNS Shakedex workflow.
- HnsShakedex
KeyAllocation Request - Immutable caller context for one Shakedex seller-key allocation.
- HnsShakedex
Seller Terms - Canonical economic terms frozen before a Shakedex seller-key allocation.
- HnsShakedex
Signer - Opaque, non-cloneable and non-serializable seller authority.
- HnsShakedex
Transaction Observation - Opaque same-snapshot transaction and input-spend evidence fetched for one exact persisted Shakedex transaction. Construction remains runtime-owned, so a product caller cannot promote self-authored status objects.
- HnsShakescape
Candidate - One hostile-input-filtered ShakeScape endpoint learned from ordinary HSD
ADDRtraffic. The record is a connectivity hint only: neither its source HSD peer nor the endpoint is identity or board authority. - HnsShakescape
Discovery Status - Non-sensitive process-local discovery and direct-connect telemetry.
- HnsTransaction
FeeQuote - Exact node-resolved HSD policy evidence for one serialized transaction. The transaction bytes remain the durable source artifact.
- HnsTransaction
Record - HnsWallet
Bootstrap - Prepared seed plus one exact HNS account for native create or restore.
- HnsWallet
Runtime - Incoming
Transfer Candidate - One active TRANSFER addressed by covenant to a requested derivation. The embedded Coin remains the old owner’s active TRANSFER output and must never be reconciled into the recipient wallet’s UTXO set or balance.
- Incoming
Transfers Page - Incoming
Transfers Page Request - Indexed
Wallet Coin - One backend UTXO tied to the index of the requested script. Returning the index instead of wallet derivation data keeps the node boundary watch-only.
- Known
Name - Mempool
Snapshot Binding - Mempool
Wallet Page - Mempool
Wallet Page Request - Name
Action Context Evidence - Snapshot-bound policy and active-chain evidence returned by the canonical node for one exact owner outpoint and candidate name action.
- Name
Evidence - Name
Operation - Name
Proof Response - Native
HnsPeer Pool - Persistent native standard-peer pool and transaction broadcast boundary.
- Outpoint
Spend Entry - Outpoint
Spend Evidence - Persisted
Header Round - Result of a peer-agreement round committed to the encrypted wallet store.
- Prepare
Name Finalize - Prepare
Name Transfer - Prepare
Name Update - Prepared
Name Operation - Recovery
Phrase - Selected
HnsAccount Revision - Exact authenticated account row and its monotonic entity revision.
- Shakescape
Publication Acceptance - Shakescape
Publication Handoff - Exact durable publication attempt sent to the authenticated local node.
- Shakescape
Transport Event - Shakescape
Transport Event Page - Shakescape
Transport Snapshot Page - Shakescape
Transport Snapshot Record - Snapshot
Binding - Spending
Transaction Evidence - System
Clock - Tracked
HnsCoin - Transaction
Evidence - Transaction
Inclusion - Transaction
Status - Verified
Current Shakedex Lock - Ephemeral current-chain authority for one canonical, unspent Shakedex FINALIZE lock. It is deliberately non-cloneable and non-serializable; a restart, reorg, or mempool-generation change requires reacquisition.
- Verified
Current Shakedex Lock Batch - Ephemeral authority for an ordered batch of exact current Shakedex locks.
- Verified
Current Shakedex Lock Entry - One ordered lock entry retained under a
VerifiedCurrentShakedexLockBatch. - Verified
Current Shakedex Transfer - Ephemeral current-chain authority for the exact unspent TRANSFER created from a Shakedex lock. It additionally binds the exact active-chain owner inclusion and canonical FINALIZE renewal evidence under the same chain/mempool snapshot.
- Verified
HnsBoard Cancellation Context - Query-scoped selected-account, network, and trusted-time authority for one Shakescape board metadata read or negative cancellation admission.
- Verified
HnsName Proof - Strict Urkel proof admitted against one locally agreed header-tree root.
- Verified
HnsTransaction Observation - One transaction whose relevance was established inside a locally verified filtered block.
- Verified
Name Ownership - Ephemeral proof that the current runtime snapshot binds a canonical name owner output to one persisted account-zero receive derivation. It is deliberately not serializable or cloneable; every value workflow must reacquire it and check that its exact snapshot is still current before preparing an action.
- Verified
Outgoing Name Transfer - Non-serializable authorization to spend one confirmed outgoing TRANSFER. The old owner-address key signs direct FINALIZE; merely being the incoming recipient does not confer signing authority.
- Wallet
Address Key - Exact canonical Handshake address input for the node’s ScriptId conversion. Restoration derives version-0 20-byte coin/name programs and separated 32-byte Shakedex lock-script programs.
- Wallet
Coin
Enums§
- Active
Name Owner Coin Source Binding - HnsDirect
Peer Error - Direct-peer construction, transport, or locally verified data failure.
- HnsDirect
Shakescape Message - One canonical Shakescape application message received on a negotiated direct peer. Name-market replication and direct HNS/BTC offers share only the socket; they retain separate protocol identities and validation paths.
- HnsFee
Rate Source - HnsHeader
Round Progress - Result of one bounded direct header round.
- HnsInbound
Mobile Peer - One admitted inbound connection on the shared mobile Handshake listener. Extension-capable wallets proceed to exact ShakeScape negotiation; an ordinary stock peer remains a standard bounded NETWORK session.
- HnsLight
Error - Authenticated HNS light-authority persistence or consensus failure.
- HnsLight
Index Error - Filtered-block index persistence or evidence failure.
- HnsName
Action - Wallet-owned base-name action. Shakedex script-controlled transitions use separate authorities and must not be routed through this P2PKH workflow.
- HnsName
Lifecycle - HnsNetwork
- HnsRedeem
Submission Stage - Non-sensitive state of this wallet’s durable HNS redeem submission.
- HnsSend
Stage - HnsShakedex
Funding Purpose - The only Shakedex actions that may ask the ordinary HNS key role to sign a funding suffix. The script-FINALIZE purpose is deliberately distinct from the two FINALIZE-lock purposes so a persisted reservation cannot silently exchange current-lock authority for current-TRANSFER authority.
- HnsShakedex
Funding Reservation State - HnsShakedex
KeyAllocation Error - Failures specific to protected HNS Shakedex key allocation and recovery. None of these errors authorizes a value operation or broadcast.
- HnsShakescape
Direct Failure - Coarse, non-sensitive outcome of the most recent direct discovery dial.
- HnsWallet
Error - Incoming
Transfer Source Binding - Name
Action Ineligibility - Name
Operation State - Name
Ownership Status - Name
Resource Status - Shakescape
Transport Message Kind - Verified
Native Htlc Spend - A native-HNS HTLC spend authenticated against the wallet’s locally verified funding coin and the current proof-bound transaction evidence. Peer notices never construct this value: the runtime re-executes the HNS witness program and reports the branch it observed.
Constants§
- DEFAULT_
DUST_ THRESHOLD - DEFAULT_
FEE_ TARGET_ BLOCKS - DEFAULT_
RESTORE_ LOOKAHEAD - DIRECT_
WALLET_ INDEX_ WATCH_ SET_ INCOMPLETE_ MESSAGE - Stable diagnostic marker for the one recoverable case where a direct filtered-block index has reached its tip but a newly discovered trailing restoration window has not been watched yet. Hosts must expand and rewind the public watch set before retrying; they must never publish a projection from the incomplete index.
- HNS_
DERIVATION_ DOMAIN - HNS_
FEE_ QUOTE_ ALGEBRA_ RELEASE_ QUALIFIED - Canonical HSD fee-policy algebra is enabled for the integrated product flow. Final distribution qualification is performed over the assembled product, rather than blocking runtime exercise of this implementation.
- HNS_
LIGHT_ CHAIN_ FORMAT_ VERSION - Version of the authenticated encrypted HNS light-chain record envelope.
- HNS_
LIGHT_ INDEX_ FORMAT_ VERSION - Version of the encrypted filtered-block index envelope.
- HNS_
LOCKTIME_ THRESHOLD - HNS_
SETTLEMENT_ KEY_ DOMAIN - HNS_
SHAKEDEX_ FUNDING_ RELEASE_ QUALIFIED - Protected Shakedex source/funding reservation and suffix signing are enabled for the integrated product flow.
- HNS_
VALUE_ RUNTIME_ RELEASE_ QUALIFIED - Concrete HNS value operations are enabled for integrated mainnet testing.
- MAINNET_
WALLET_ CHECKPOINT_ HEIGHT - Product-pinned Mainnet checkpoint used to bound restored-wallet header work.
- MAX_
CHECKPOINT_ BOOTSTRAP_ HEIGHT - Highest birthday accepted by the checkpoint-segment acceleration path.
- MAX_
CURRENT_ SHAKEDEX_ LOCK_ BATCH - Maximum number of exact name/seller lock queries that may share one selected-account, chain, mempool, and trusted-time observation.
- MAX_
GENESIS_ BOOTSTRAP_ HEADERS - Largest genesis-verified header acceleration stream accepted in one wallet bootstrap. Product shells pin their own reviewed checkpoint and may advance this bound in a later release alongside a new bundled checkpoint.
- MAX_
HISTORY_ RESULTS - MAX_
MEMPOOL_ SCAN_ RESULTS - MAX_
OUTPOINT_ SPEND_ BATCH - MAX_
RECOVERY_ CHECKPOINTS - MAX_
RESTORE_ ADDRESS_ RECORDS - The coin, dedicated name, and Shakedex lock branches are queried separately so no branch reduces another’s bounded lookahead. Persisted address records are nevertheless bounded as one account-owned collection.
- MAX_
RESTORE_ LOOKAHEAD - MAX_
RESTORE_ SCRIPTS_ PER_ QUERY - MAX_
SCAN_ CURSOR_ BYTES - MAX_
SCAN_ PAGES - MAX_
SCAN_ PAGE_ RESULTS - MAX_
SHAKESCAPE_ NAME_ MARKET_ ENVELOPE_ BYTES - MAX_
SHAKESCAPE_ NAME_ MARKET_ TRANSPORT_ PAGE - MAX_
SNAPSHOT_ RESTARTS - MAX_
TRANSACTION_ INPUTS - MAX_
WALLET_ COINS - PREPARED_
ARTIFACT_ LIFETIME_ SECONDS - SEND_
PROPAGATION_ GRACE_ SECONDS - Keep a newly submitted send in the durable broadcast state while connected peers have time to announce it back through their mempool inventory. A successful socket write is not itself remote mempool evidence.
Traits§
- HnsBackend
- HnsClock
- HnsLight
Network - Direct standard-peer network boundary used by the embedded backend.
Functions§
- activate_
hns_ shakedex_ funding_ reservations - Construct the exact prepared-to-active reservation updates for the same transaction that consumes approval and persists signed bytes.
- build_
recovered_ hns_ htlc - create_
hns_ shakedex_ funding_ reservations - Construct the exact source/funding reservation inserts for the enclosing Shakedex workflow’s initial CAS. Existing workflow or outpoint reservations fail closed; retry recovery should validate the already-persisted set.
- create_
wallet - delete_
hns_ shakedex_ funding_ reservations - Construct exact terminal reservation deletes. Generic HNS cleanup ignores these protected rows, so only the enclosing Shakedex workflow may request this explicit CAS after authenticating its expected state.
- derive_
hns_ account_ public_ key - Derive ordinary HNS authority from the canonical hsd/Bob BIP-44 tree. Script-specific ShakeDex and application keys remain role-separated.
- derive_
hns_ light_ watch_ set - Derive the complete public watch set required by the wallet-owned direct
HNS light client. The encrypted recovery seed remains inside
store; this function returns only version-zero script identifiers and already-known name hashes, never private keys, derivation secrets, or transaction data. - derive_
hns_ light_ watch_ set_ with_ restore_ extension - Derive the public direct-wallet watch set with complete additional restore windows. This is used only after an authenticated direct scan discovers activity at the current trailing gap: the expanded set is installed before the index is rewound and re-scanned, so no unscanned script can enter a read projection.
- direct_
shakescape_ network_ binding - Reconstruct the exact local Handshake binding used by the direct Shakescape HNS/BTC protocol. This is derived only from the selected wallet network; it has no relay, peer, indexer, or price-policy input.
- discover_
hns_ recovery_ contracts - generate_
account_ id - Generates a nonzero random account identifier. This identifier is local profile metadata; on-chain recovery is anchored by the stable account derivation index rather than this random value.
- generate_
wallet_ id - Generates the random wallet-local identifier used by the existing create path. Recovery deliberately derives its identifier from the mnemonic instead, preserving the established wallet semantics.
- hns_
account_ transaction_ history_ prefix - Public namespace for this exact account’s authenticated transaction history.
- hns_
recovery_ anchor_ program - Ordinary internal address zero is discoverable after restoring only the seed.
- hns_
redeem_ submission - Read the exact session’s approved redeem checkpoint. A merely prepared transaction is still awaiting approval and must not hide the redeem action.
- import_
known_ name - open_
wallet_ direct_ hns_ peer_ coordinator - Open the direct peer coordinator owned by one encrypted wallet account.
- open_
wallet_ direct_ hns_ peer_ coordinator_ with_ floor - Open the direct coordinator with the platform-held monotonic rollback floor. Installed wallets must use this constructor; the compatibility wrapper above remains for deterministic in-memory callers that have no platform storage boundary.
- open_
wallet_ direct_ hns_ peer_ coordinator_ with_ floor_ and_ checkpoint_ bootstrap - Open the direct coordinator from the compiled Mainnet block-300,000 checkpoint plus only the canonical header segment through the wallet birthday. The same path migrates an existing wallet that predates the bounded pre-birthday name-action header archive. The resulting controller still requires fresh direct-peer agreement before current value authority is available.
- open_
wallet_ direct_ hns_ peer_ coordinator_ with_ floor_ and_ genesis_ bootstrap - Open a direct coordinator after replacing a pristine new-wallet genesis checkpoint with a locally verified, product-pinned header acceleration stream. The stream is never peer authority: after it is committed the coordinator remains in header-syncing state and requires fresh direct-peer agreement before it can issue current-chain evidence.
- open_
wallet_ direct_ hns_ peer_ coordinator_ with_ floor_ and_ public_ peer_ sessions - Open the installed-wallet coordinator while adopting standard HSD sessions sanitized during retirement of the same platform wallet scope.
- open_
wallet_ direct_ hns_ peer_ coordinator_ with_ floor_ checkpoint_ and_ public_ peer_ sessions - Open the checkpoint-accelerated installed-wallet coordinator while adopting sanitized standard HSD sessions from the same platform wallet scope.
- prepare_
hns_ recoverable_ funding - receive_
address - recover_
hns_ contract_ from_ ancestors - recovered_
hns_ htlc_ funding_ locator - Find a recovered swap’s exact HNS lock in the account’s authenticated filtered-block history. The returned transaction ID is only a locator: current-chain inclusion, confirmations, and the lock output are checked again by the native settlement verifier before any spend is authorized.
- restore_
wallet - retain_
active_ hns_ shakedex_ funding_ reservations - Construct an exact no-op rewrite of every active protected row. Passing this batch to the workflow’s pre-submit CAS makes reservation presence, type, and revisions part of the same durable fence as the signed bytes.
- select_
coins - validate_
hns_ shakedex_ final_ fee_ quote_ evidence - Validate exact final node fee evidence for a Shakedex lock transaction without granting signing, approval, submission, or release qualification. Product paths must still pass their independent runtime and broadcast gates.
- validate_
hns_ shakedex_ finalize_ final_ fee_ quote_ evidence - Validate exact final node fee evidence for a script-controlled FINALIZE. Unlike the lock-spend validator, this accepts only current TRANSFER authority and the purpose dedicated to that source covenant.
- validate_
hns_ shakedex_ funding_ reservations - Authenticate the complete persisted reservation set and reject missing, extra, mixed-state, retyped, or cross-account rows.
- validate_
persisted_ hns_ shakedex_ fee_ quote_ evidence - Reauthenticate a persisted Shakedex fee quote from its exact ordered coin evidence after restart. The quote’s own snapshot identifiers are retained only as authenticated historical evidence; this function does not claim that either snapshot remains current and cannot authorize submission.
Type Aliases§
- Verified
HnsBoard Context - Generalized name for the purpose-minimized account/network/time context shared by closed Shakescape board metadata reads and cancellation admission.