Expand description
Platform-neutral native wallet control for Android and iOS applications.
Structs§
- Bitcoin
Broadcast Recovery Summary - Bounded, non-sensitive state for approved Bitcoin transaction recovery. It deliberately omits transaction bytes, input outpoints, commitments, values, addresses, and peer information.
- Connected
HnsPeer - Backend composition types exposed for downstream native shells. The RPC
adapter remains available for explicitly configured local deployments; a
host can instead open the wallet-owned direct peer coordinator below and
compose its
EmbeddedHnsBackendwithout endpoint credentials. One completed version/verack connection registered with the local header authority. The identifier is random and connection-scoped, not authority. - Embedded
HnsBackend - Backend composition types exposed for downstream native shells. The RPC
adapter remains available for explicitly configured local deployments; a
host can instead open the wallet-owned direct peer coordinator below and
compose its
EmbeddedHnsBackendwithout endpoint credentials. - HnsBlock
Scan Progress - Backend composition types exposed for downstream native shells. The RPC
adapter remains available for explicitly configured local deployments; a
host can instead open the wallet-owned direct peer coordinator below and
compose its
EmbeddedHnsBackendwithout endpoint credentials. Result of one bounded filtered-block scan. - HnsBootstrap
Policy - Backend composition types exposed for downstream native shells. The RPC
adapter remains available for explicitly configured local deployments; a
host can instead open the wallet-owned direct peer coordinator below and
compose its
EmbeddedHnsBackendwithout endpoint credentials. Explicit chain policy for the one-account native-wallet bootstrap. - HnsDirect
Peer Config - Backend composition types exposed for downstream native shells. The RPC
adapter remains available for explicitly configured local deployments; a
host can instead open the wallet-owned direct peer coordinator below and
compose its
EmbeddedHnsBackendwithout endpoint credentials. Native direct-peer policy for one wallet runtime. - HnsDirect
Peer Coordinator - Backend composition types exposed for downstream native shells. The RPC
adapter remains available for explicitly configured local deployments; a
host can instead open the wallet-owned direct peer coordinator below and
compose its
EmbeddedHnsBackendwithout endpoint credentials. Complete wallet-owned direct HNS runtime. Clones share the same backend, persistent connections, and in-flight header-round state. - HnsDirect
Shakescape Listener - Backend composition types exposed for downstream native shells. The RPC
adapter remains available for explicitly configured local deployments; a
host can instead open the wallet-owned direct peer coordinator below and
compose its
EmbeddedHnsBackendwithout endpoint credentials. A wallet-owned, nonblocking TCP admission point for direct Shakescape peers. - HnsDirect
Shakescape Peer - Backend composition types exposed for downstream native shells. The RPC
adapter remains available for explicitly configured local deployments; a
host can instead open the wallet-owned direct peer coordinator below and
compose its
EmbeddedHnsBackendwithout endpoint credentials. One direct Shakescape Experimental V2 session owned by the wallet. - HnsInbound
Network Peer - Backend composition types exposed for downstream native shells. The RPC
adapter remains available for explicitly configured local deployments; a
host can instead open the wallet-owned direct peer coordinator below and
compose its
EmbeddedHnsBackendwithout endpoint credentials. 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. - HnsLight
Floor - Backend composition types exposed for downstream native shells. The RPC
adapter remains available for explicitly configured local deployments; a
host can instead open the wallet-owned direct peer coordinator below and
compose its
EmbeddedHnsBackendwithout endpoint credentials. Rollback floor that callers retain in platform-protected monotonic storage. - HnsNode
RpcBackend - Backend composition types exposed for downstream native shells. The RPC
adapter remains available for explicitly configured local deployments; a
host can instead open the wallet-owned direct peer coordinator below and
compose its
EmbeddedHnsBackendwithout endpoint credentials. Concrete synchronous hns-node-rs wallet RPC v1 backend. - HnsNode
RpcConfig - Backend composition types exposed for downstream native shells. The RPC
adapter remains available for explicitly configured local deployments; a
host can instead open the wallet-owned direct peer coordinator below and
compose its
EmbeddedHnsBackendwithout endpoint credentials. Trusted local configuration for the authenticated wallet RPC boundary. - HnsPublic
Peer Sessions - Backend composition types exposed for downstream native shells. The RPC
adapter remains available for explicitly configured local deployments; a
host can instead open the wallet-owned direct peer coordinator below and
compose its
EmbeddedHnsBackendwithout endpoint credentials. Wallet-detached standard HSD transport sessions that contain no signing authority, encrypted store, watch set, wallet projection, or pending wallet-filter traffic. - HnsRead
System Clock - Backend composition types exposed for downstream native shells. The RPC
adapter remains available for explicitly configured local deployments; a
host can instead open the wallet-owned direct peer coordinator below and
compose its
EmbeddedHnsBackendwithout endpoint credentials. - HnsShakescape
Discovery Status - Backend composition types exposed for downstream native shells. The RPC
adapter remains available for explicitly configured local deployments; a
host can instead open the wallet-owned direct peer coordinator below and
compose its
EmbeddedHnsBackendwithout endpoint credentials. Non-sensitive process-local discovery and direct-connect telemetry. - Mobile
Automatic Settlement Permission - Mobile
Bitcoin Broadcast Receipt - Bounded evidence that the exact persisted transaction was accepted by the wallet-owned Kyoto peer set. This deliberately contains no transaction bytes or private derivation information.
- Mobile
Bitcoin Direct Config - Configuration for one wallet-owned Kyoto client.
data_diris an app private directory, never a server endpoint or a hosted index state. - Mobile
Bitcoin Htlc Funding Approval - Mobile
Bitcoin Htlc Funding Receipt - Mobile
Bitcoin Htlc Settlement Approval - Mobile
Bitcoin Htlc Settlement Receipt - Mobile
Bitcoin Send Approval - The only information an installed UI receives before it explicitly approves one exact Bitcoin spend. Its opaque token is process-local and has no signing authority after it is consumed, rejected, expired, or the wallet locks.
- Mobile
Bitcoin Shutdown Handle - Lifecycle-only stop capability for the active direct Bitcoin node.
- Mobile
Bitcoin Snapshot - Bounded projection for an unlocked direct Bitcoin wallet. The address is generated locally from the encrypted seed; it does not come from a relay or wallet server.
- Mobile
Bitcoin Sync Progress - Bounded public progress suitable for native wallet UI presentation.
- Mobile
Bitcoin Sync Progress Handle - Mobile
Bitcoin Value Controller - Wallet-owned Kyoto state for the installed HNS/Bitcoin product. It opens only while the shared encrypted store is unlocked and tears down its direct peer node before that store is relocked.
- Mobile
BtcFor HnsOffer Approval - Mobile
BtcFor HnsOffer Summary - Mobile
Database Key - A platform-unwrapped database key. It deliberately implements neither
ClonenorDebug, and it is zeroized when dropped. - Mobile
Direct HnsValue Controller - Full native HNS value controller composed with the wallet-owned direct standard-peer coordinator.
- Mobile
Direct Offer Acceptance Approval - Mobile
Direct Offer Acceptance Summary - Mobile
Direct Offer Candidate Summary - Mobile
Direct Offer Summary - Mobile
Direct Shakescape Listener - A direct Shakescape listener created by one
MobileDirectHnsValueController. - Mobile
HnsFinalize Notice - Mobile
HnsFor BtcOffer Approval - Mobile
HnsName Page - One deterministic page from the last authenticated known-name projection.
- Mobile
HnsName State Summary - Mobile
HnsName Summary - One minimized, serializable known-name projection for trusted native UI. Raw proofs, name-state bytes, owner outpoints, resource bytes, and key derivations never cross this boundary.
- Mobile
HnsRead Controller - Backend-injected native HNS read controller. It composes the exact same
SharedWalletStoreauthority through account selection, synchronized HNS reconciliation, provider-state persistence, and private ABI lifecycle control. It authenticates a script-free epoch/tip and selected-network genesis before deriving or querying watch scripts. Backend transport remains a product-owned trust boundary. This controller exposes no browser/provider entry point or value operation. - Mobile
HnsRead Snapshot - One exact synchronized read-only HNS projection. Every field comes from the same chain-tip/epoch and mempool instance/generation binding, which remains internal to the controller.
- Mobile
HnsValue Approval - Exact summary displayed by native UI before one value action can execute. The opaque action token is process-local, random, single-use, and carries no signing authority after this controller is locked or dropped.
- Mobile
HnsValue Controller - Full same-store native HNS controller. It retains the signing runtime and the private service behind an installed-product boundary, exposes no raw provider frames, and permits at most one exact process-local value approval at a time.
- Mobile
Recovery Phrase - A caller-owned recovery phrase accepted only by the native restore path.
It deliberately implements neither
ClonenorDebugand zeroizes its allocation on drop. - Mobile
Shakescape Bitcoin Absence Permit - Exact authenticated Bitcoin lock terms for proving that an expired local first-funding action never produced a durable transaction.
- Mobile
Shakescape Bitcoin Funding Permit - Rust-only authority passed from the accepted Shakescape session controller to the Bitcoin controller. Its fields remain private so Kotlin/Swift cannot replace signed terms, the session identifier, or the reserved fee cap.
- Mobile
Shakescape Bitcoin Settlement Permit - Mobile
Shakescape Bitcoin Watch Permit - Mobile
Shakescape Direct Inventory Report - Bounded material emitted during one periodic direct-board reconciliation.
- Mobile
Shakescape Direct Transport Report - Bounded effects of one direct HNS/BTC Shakescape transport event. Discovery
traffic has no settlement authority;
admissionis populated only after a signed offer or session message passes the durable local checks. - Mobile
Shakescape Execution Summary - Non-sensitive durable execution projection for native recovery UI. It contains no transaction bytes, preimage, derivation path, peer endpoint, or private key material; chain actions remain behind explicit approvals.
- Mobile
Shakescape First Funding Observation - Rust-only, single-use proof that the durable generation was advanced before a first-chain read began. Private fields prevent Kotlin, Swift, or a provider payload from manufacturing or replaying an older chain result.
- Mobile
Shakescape HnsFunding Approval - Mobile
Shakescape HnsFunding Permit - Mobile
Shakescape HnsFunding Receipt - Mobile
Shakescape HnsSettlement Approval - Mobile
Shakescape HnsSettlement Permit - Mobile
Shakescape HnsSettlement Receipt - Mobile
Shakescape HnsVerification Permit - Mobile
Shakescape HnsWatch Permit - Mobile
Shakescape Networking - One active mobile ShakeScape discovery/listening lifecycle.
- Mobile
Shakescape Session Controller - One wallet-owned bridge from a direct Shakescape packet to the existing durable HNS/BTC handshake journal. It exposes neither generic message execution nor a signing authority; HTLC operations stay behind their chain-specific controllers and explicit native approvals.
- Mobile
Shakescape Unfunded Bitcoin Proof - Checkpoint-bound proof that this wallet neither observed nor durably approved the exact Bitcoin HTLC funding output for a swap session. Fields remain crate-private so platform bindings cannot manufacture it.
- Mobile
Shakescape Unfunded HnsProof - Proof produced only by this wallet’s HNS value controller after checking the exact session’s durable native-lock broadcast journal.
- Mobile
Wallet Controller - One process-local native controller. No raw ABI frame, provider authority, decrypted record key, or recovery phrase is exposed through this type.
- Mobile
Wallet Creation - A newly created controller and its one-time dedicated recovery display.
The phrase is not exposed as an ordinary public field or through
Debug. - Verified
Bitcoin Htlc Spend Observation - One HTLC spend re-authenticated from this wallet’s compact-filter chain view. The observation is available only while the caller presents the exact checkpoint to which the watch was reconciled, preventing stale or reorged watch data from advancing a recovery workflow.
- Verified
Bitcoin Lock
Enums§
- HnsDirect
Peer Error - Backend composition types exposed for downstream native shells. The RPC
adapter remains available for explicitly configured local deployments; a
host can instead open the wallet-owned direct peer coordinator below and
compose its
EmbeddedHnsBackendwithout endpoint credentials. Direct-peer construction, transport, or locally verified data failure. - HnsDirect
Shakescape Message - Backend composition types exposed for downstream native shells. The RPC
adapter remains available for explicitly configured local deployments; a
host can instead open the wallet-owned direct peer coordinator below and
compose its
EmbeddedHnsBackendwithout endpoint credentials. 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. - HnsHeader
Round Progress - Backend composition types exposed for downstream native shells. The RPC
adapter remains available for explicitly configured local deployments; a
host can instead open the wallet-owned direct peer coordinator below and
compose its
EmbeddedHnsBackendwithout endpoint credentials. Result of one bounded direct header round. - HnsInbound
Mobile Peer - Backend composition types exposed for downstream native shells. The RPC
adapter remains available for explicitly configured local deployments; a
host can instead open the wallet-owned direct peer coordinator below and
compose its
EmbeddedHnsBackendwithout endpoint credentials. 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. - HnsNetwork
- Backend composition types exposed for downstream native shells. The RPC
adapter remains available for explicitly configured local deployments; a
host can instead open the wallet-owned direct peer coordinator below and
compose its
EmbeddedHnsBackendwithout endpoint credentials. - HnsShakescape
Direct Failure - Backend composition types exposed for downstream native shells. The RPC
adapter remains available for explicitly configured local deployments; a
host can instead open the wallet-owned direct peer coordinator below and
compose its
EmbeddedHnsBackendwithout endpoint credentials. Coarse, non-sensitive outcome of the most recent direct discovery dial. - Mobile
HnsFinalize Notice Phase - Mobile
HnsName Ownership Status - Mobile
HnsName Resource Status - Mobile
HnsValue Intent - Closed native value vocabulary. The selected account and native origin are inserted by Rust and can never be supplied or replaced by Kotlin, Swift, a WebView, or website content.
- Mobile
Platform - Mobile
Shakedex Query - Closed non-signing Shakedex query vocabulary for the installed native UI.
- Mobile
Shakescape Direct Admission - One locally admitted direct-board or direct-session event. The native controller intentionally exposes no oracle-derived pricing result.
- Mobile
Shakescape Direct Message Kind - Protocol identity of one serviced cross-chain envelope. This intentionally exposes no offer, wallet, transaction, or session identifier; embeddings can use it to diagnose bounded transport progress without logging private market material.
- Mobile
Shakescape Settlement Action - Mobile
Wallet Error - Reconciled
Shakescape Bitcoin Funding - Current result for one durable HTLC watch.
NotConfirmedis returned only after the watch has been reconciled to the controller’s exact current checkpoint, so callers can distinguish authoritative absence/reorg from a watch that is merely still catching up.
Constants§
- MAX_
MOBILE_ HNS_ NAME_ PAGE - MAX_
MOBILE_ RECOVERY_ PHRASE_ BYTES - MINIMUM_
BITCOIN_ FEE_ RESERVE_ SATS - Product floor for Bitcoin funding/refund headroom committed by a mobile direct offer participant. Values below this cannot pass the downstream Bitcoin transaction fee policy and therefore must not become signed terms.
- MOBILE_
ACCOUNT_ LABEL - MOBILE_
DATABASE_ KEY_ BYTES
Traits§
- HnsBackend
- Backend composition types exposed for downstream native shells. The RPC
adapter remains available for explicitly configured local deployments; a
host can instead open the wallet-owned direct peer coordinator below and
compose its
EmbeddedHnsBackendwithout endpoint credentials. - HnsClock
- Backend composition types exposed for downstream native shells. The RPC
adapter remains available for explicitly configured local deployments; a
host can instead open the wallet-owned direct peer coordinator below and
compose its
EmbeddedHnsBackendwithout endpoint credentials.