Skip to main content

Crate hns_wallet_hns

Crate hns_wallet_hns 

Source
Expand description

Handshake wallet key roles, restoration, UTXO selection, and name workflows.

Structs§

AcceptedHnsHeader
One newly agreed header and the consensus entry needed to verify its filtered-block evidence without trusting the peer that supplied it.
ActiveNameOwnerCoinEvidence
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.
AuthorizedNameOperation
BlockHashEvidence
CanonicalNameStateSummary
ChainTip
CoinSelection
ConfirmedWalletPage
ConfirmedWalletPageRequest
ConnectedHnsPeer
One completed version/verack connection registered with the local header authority. The identifier is random and connection-scoped, not authority.
CreatedWallet
CurrentShakedexLockQuery
Exact caller-owned input for one query-scoped Shakedex lock lookup.
DerivedHnsAddress
EmbeddedHnsBackend
EncryptedHnsLightAuthority
Encrypted, wallet-owned Handshake light-chain authority.
EncryptedHnsLightIndex
Encrypted account index whose only confirmed-state input is VerifiedWalletBlock.
HistoryEntry
HnsAccountReadBinding
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.
HnsAccountReadRuntime
Synchronized, non-value HNS runtime for product/provider compositions that already own an exact account and one process-local store authority.
HnsAccountReadSnapshot
Complete non-value HNS account projection produced by one bounded wallet reconciliation. All fields are derived from the same chain/mempool binding.
HnsAccountRecord
HnsBlockScanBatchTelemetry
Local timing breakdown for one atomically persisted filtered-block batch.
HnsBlockScanProgress
Result of one bounded filtered-block scan.
HnsBootstrapPolicy
Explicit chain policy for the one-account native-wallet bootstrap.
HnsCanonicalBlock
One snapshot-bound block supplied by HSRD. raw == None with a known hash means the canonical body was pruned. Present raw bytes passed Handshake body validation and have a header hash matching block_hash.
HnsChainCheckpoint
HnsDirectPeerConfig
Native direct-peer policy for one wallet runtime.
HnsDirectPeerCoordinator
Complete wallet-owned direct HNS runtime. Clones share the same backend, persistent connections, and in-flight header-round state.
HnsDirectShakescapeListener
A wallet-owned, nonblocking TCP admission point for direct Shakescape peers.
HnsDirectShakescapePeer
One direct Shakescape Experimental V2 session owned by the wallet.
HnsExistingAccountSelector
Read-only selector for one exact pre-existing HNS account held by the same Arc-backed store/key authority as its caller.
HnsInboundNetworkPeer
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.
HnsInputCoinEvidence
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.
HnsInputReservation
HnsLightFloor
Rollback floor that callers retain in platform-protected monotonic storage.
HnsLightScanStatus
Persisted scan coverage for the exact watch set.
HnsLightWatchSet
Complete deterministic bloom-filter input set for one wallet account.
HnsNodeRpcBackend
Concrete synchronous hns-node-rs wallet RPC v1 backend.
HnsNodeRpcConfig
Trusted local configuration for the authenticated wallet RPC boundary.
HnsOutpoint
HnsPersistedRecoveryReadOnlyRuntime
Explicit recovery-only reader for one exact already-persisted HNS account whose historical configuration contains a value or settlement flag.
HnsPreparedSettlementValueSummary
Exact value accounting for a prepared HNS settlement transaction.
HnsPreparedShakedexFunding
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.
HnsPublicHeaderTransport
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.
HnsPublicPeerSessions
Wallet-detached standard HSD transport sessions that contain no signing authority, encrypted store, watch set, wallet projection, or pending wallet-filter traffic.
HnsReconciliationReport
HnsRecoverableFundingPlan
HnsRecoveryContract
Structural match only. The runtime must verify inclusion, current unspent output and maturity independently before permitting a settlement spend.
HnsRecoveryState
HnsRedeemSubmission
HnsRuntimeConfig
HnsSettlementBroadcastGuard
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.
HnsShakedexChangeReservation
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.
HnsShakedexFundingApprovalExpectation
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.
HnsShakedexFundingAuthorization
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.
HnsShakedexFundingReservation
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.
HnsShakedexFundingReservationBatch
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.
HnsShakedexFundingScope
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.
HnsShakedexKeyAllocation
Immutable public recovery binding for one HNS Shakedex workflow.
HnsShakedexKeyAllocationRequest
Immutable caller context for one Shakedex seller-key allocation.
HnsShakedexSellerTerms
Canonical economic terms frozen before a Shakedex seller-key allocation.
HnsShakedexSigner
Opaque, non-cloneable and non-serializable seller authority.
HnsShakedexTransactionObservation
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.
HnsShakescapeCandidate
One hostile-input-filtered ShakeScape endpoint learned from ordinary HSD ADDR traffic. The record is a connectivity hint only: neither its source HSD peer nor the endpoint is identity or board authority.
HnsShakescapeDiscoveryStatus
Non-sensitive process-local discovery and direct-connect telemetry.
HnsTransactionFeeQuote
Exact node-resolved HSD policy evidence for one serialized transaction. The transaction bytes remain the durable source artifact.
HnsTransactionRecord
HnsWalletBootstrap
Prepared seed plus one exact HNS account for native create or restore.
HnsWalletRuntime
IncomingTransferCandidate
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.
IncomingTransfersPage
IncomingTransfersPageRequest
IndexedWalletCoin
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.
KnownName
MempoolSnapshotBinding
MempoolWalletPage
MempoolWalletPageRequest
NameActionContextEvidence
Snapshot-bound policy and active-chain evidence returned by the canonical node for one exact owner outpoint and candidate name action.
NameEvidence
NameOperation
NameProofResponse
NativeHnsPeerPool
Persistent native standard-peer pool and transaction broadcast boundary.
OutpointSpendEntry
OutpointSpendEvidence
PersistedHeaderRound
Result of a peer-agreement round committed to the encrypted wallet store.
PrepareNameFinalize
PrepareNameTransfer
PrepareNameUpdate
PreparedNameOperation
RecoveryPhrase
SelectedHnsAccountRevision
Exact authenticated account row and its monotonic entity revision.
ShakescapePublicationAcceptance
ShakescapePublicationHandoff
Exact durable publication attempt sent to the authenticated local node.
ShakescapeTransportEvent
ShakescapeTransportEventPage
ShakescapeTransportSnapshotPage
ShakescapeTransportSnapshotRecord
SnapshotBinding
SpendingTransactionEvidence
SystemClock
TrackedHnsCoin
TransactionEvidence
TransactionInclusion
TransactionStatus
VerifiedCurrentShakedexLock
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.
VerifiedCurrentShakedexLockBatch
Ephemeral authority for an ordered batch of exact current Shakedex locks.
VerifiedCurrentShakedexLockEntry
One ordered lock entry retained under a VerifiedCurrentShakedexLockBatch.
VerifiedCurrentShakedexTransfer
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.
VerifiedHnsBoardCancellationContext
Query-scoped selected-account, network, and trusted-time authority for one Shakescape board metadata read or negative cancellation admission.
VerifiedHnsNameProof
Strict Urkel proof admitted against one locally agreed header-tree root.
VerifiedHnsTransactionObservation
One transaction whose relevance was established inside a locally verified filtered block.
VerifiedNameOwnership
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.
VerifiedOutgoingNameTransfer
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.
WalletAddressKey
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.
WalletCoin

Enums§

ActiveNameOwnerCoinSourceBinding
HnsDirectPeerError
Direct-peer construction, transport, or locally verified data failure.
HnsDirectShakescapeMessage
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.
HnsFeeRateSource
HnsHeaderRoundProgress
Result of one bounded direct header round.
HnsInboundMobilePeer
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.
HnsLightError
Authenticated HNS light-authority persistence or consensus failure.
HnsLightIndexError
Filtered-block index persistence or evidence failure.
HnsNameAction
Wallet-owned base-name action. Shakedex script-controlled transitions use separate authorities and must not be routed through this P2PKH workflow.
HnsNameLifecycle
HnsNetwork
HnsRedeemSubmissionStage
Non-sensitive state of this wallet’s durable HNS redeem submission.
HnsSendStage
HnsShakedexFundingPurpose
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.
HnsShakedexFundingReservationState
HnsShakedexKeyAllocationError
Failures specific to protected HNS Shakedex key allocation and recovery. None of these errors authorizes a value operation or broadcast.
HnsShakescapeDirectFailure
Coarse, non-sensitive outcome of the most recent direct discovery dial.
HnsWalletError
IncomingTransferSourceBinding
NameActionIneligibility
NameOperationState
NameOwnershipStatus
NameResourceStatus
ShakescapeTransportMessageKind
VerifiedNativeHtlcSpend
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
HnsLightNetwork
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§

VerifiedHnsBoardContext
Generalized name for the purpose-minimized account/network/time context shared by closed Shakescape board metadata reads and cancellation admission.