Skip to main content

Crate hns_wallet_mobile

Crate hns_wallet_mobile 

Source
Expand description

Platform-neutral native wallet control for Android and iOS applications.

Structs§

BitcoinBroadcastRecoverySummary
Bounded, non-sensitive state for approved Bitcoin transaction recovery. It deliberately omits transaction bytes, input outpoints, commitments, values, addresses, and peer information.
ConnectedHnsPeer
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 EmbeddedHnsBackend without endpoint credentials. One completed version/verack connection registered with the local header authority. The identifier is random and connection-scoped, not authority.
EmbeddedHnsBackend
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 EmbeddedHnsBackend without endpoint credentials.
HnsBlockScanProgress
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 EmbeddedHnsBackend without endpoint credentials. Result of one bounded filtered-block scan.
HnsBootstrapPolicy
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 EmbeddedHnsBackend without endpoint credentials. Explicit chain policy for the one-account native-wallet bootstrap.
HnsDirectPeerConfig
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 EmbeddedHnsBackend without endpoint credentials. Native direct-peer policy for one wallet runtime.
HnsDirectPeerCoordinator
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 EmbeddedHnsBackend without endpoint credentials. Complete wallet-owned direct HNS runtime. Clones share the same backend, persistent connections, and in-flight header-round state.
HnsDirectShakescapeListener
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 EmbeddedHnsBackend without endpoint credentials. A wallet-owned, nonblocking TCP admission point for direct Shakescape peers.
HnsDirectShakescapePeer
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 EmbeddedHnsBackend without endpoint credentials. One direct Shakescape Experimental V2 session owned by the wallet.
HnsInboundNetworkPeer
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 EmbeddedHnsBackend without 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.
HnsLightFloor
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 EmbeddedHnsBackend without endpoint credentials. Rollback floor that callers retain in platform-protected monotonic storage.
HnsNodeRpcBackend
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 EmbeddedHnsBackend without endpoint credentials. Concrete synchronous hns-node-rs wallet RPC v1 backend.
HnsNodeRpcConfig
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 EmbeddedHnsBackend without endpoint credentials. Trusted local configuration for the authenticated wallet RPC boundary.
HnsPublicPeerSessions
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 EmbeddedHnsBackend without endpoint credentials. Wallet-detached standard HSD transport sessions that contain no signing authority, encrypted store, watch set, wallet projection, or pending wallet-filter traffic.
HnsReadSystemClock
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 EmbeddedHnsBackend without endpoint credentials.
HnsShakescapeDiscoveryStatus
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 EmbeddedHnsBackend without endpoint credentials. Non-sensitive process-local discovery and direct-connect telemetry.
MobileAutomaticSettlementPermission
MobileBitcoinBroadcastReceipt
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.
MobileBitcoinDirectConfig
Configuration for one wallet-owned Kyoto client. data_dir is an app private directory, never a server endpoint or a hosted index state.
MobileBitcoinHtlcFundingApproval
MobileBitcoinHtlcFundingReceipt
MobileBitcoinHtlcSettlementApproval
MobileBitcoinHtlcSettlementReceipt
MobileBitcoinSendApproval
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.
MobileBitcoinShutdownHandle
Lifecycle-only stop capability for the active direct Bitcoin node.
MobileBitcoinSnapshot
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.
MobileBitcoinSyncProgress
Bounded public progress suitable for native wallet UI presentation.
MobileBitcoinSyncProgressHandle
MobileBitcoinValueController
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.
MobileBtcForHnsOfferApproval
MobileBtcForHnsOfferSummary
MobileDatabaseKey
A platform-unwrapped database key. It deliberately implements neither Clone nor Debug, and it is zeroized when dropped.
MobileDirectHnsValueController
Full native HNS value controller composed with the wallet-owned direct standard-peer coordinator.
MobileDirectOfferAcceptanceApproval
MobileDirectOfferAcceptanceSummary
MobileDirectOfferCandidateSummary
MobileDirectOfferSummary
MobileDirectShakescapeListener
A direct Shakescape listener created by one MobileDirectHnsValueController.
MobileHnsFinalizeNotice
MobileHnsForBtcOfferApproval
MobileHnsNamePage
One deterministic page from the last authenticated known-name projection.
MobileHnsNameStateSummary
MobileHnsNameSummary
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.
MobileHnsReadController
Backend-injected native HNS read controller. It composes the exact same SharedWalletStore authority 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.
MobileHnsReadSnapshot
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.
MobileHnsValueApproval
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.
MobileHnsValueController
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.
MobileRecoveryPhrase
A caller-owned recovery phrase accepted only by the native restore path. It deliberately implements neither Clone nor Debug and zeroizes its allocation on drop.
MobileShakescapeBitcoinAbsencePermit
Exact authenticated Bitcoin lock terms for proving that an expired local first-funding action never produced a durable transaction.
MobileShakescapeBitcoinFundingPermit
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.
MobileShakescapeBitcoinSettlementPermit
MobileShakescapeBitcoinWatchPermit
MobileShakescapeDirectInventoryReport
Bounded material emitted during one periodic direct-board reconciliation.
MobileShakescapeDirectTransportReport
Bounded effects of one direct HNS/BTC Shakescape transport event. Discovery traffic has no settlement authority; admission is populated only after a signed offer or session message passes the durable local checks.
MobileShakescapeExecutionSummary
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.
MobileShakescapeFirstFundingObservation
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.
MobileShakescapeHnsFundingApproval
MobileShakescapeHnsFundingPermit
MobileShakescapeHnsFundingReceipt
MobileShakescapeHnsSettlementApproval
MobileShakescapeHnsSettlementPermit
MobileShakescapeHnsSettlementReceipt
MobileShakescapeHnsVerificationPermit
MobileShakescapeHnsWatchPermit
MobileShakescapeNetworking
One active mobile ShakeScape discovery/listening lifecycle.
MobileShakescapeSessionController
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.
MobileShakescapeUnfundedBitcoinProof
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.
MobileShakescapeUnfundedHnsProof
Proof produced only by this wallet’s HNS value controller after checking the exact session’s durable native-lock broadcast journal.
MobileWalletController
One process-local native controller. No raw ABI frame, provider authority, decrypted record key, or recovery phrase is exposed through this type.
MobileWalletCreation
A newly created controller and its one-time dedicated recovery display. The phrase is not exposed as an ordinary public field or through Debug.
VerifiedBitcoinHtlcSpendObservation
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.
VerifiedBitcoinLock

Enums§

HnsDirectPeerError
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 EmbeddedHnsBackend without endpoint credentials. Direct-peer construction, transport, or locally verified data failure.
HnsDirectShakescapeMessage
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 EmbeddedHnsBackend without 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.
HnsHeaderRoundProgress
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 EmbeddedHnsBackend without endpoint credentials. Result of one bounded direct header round.
HnsInboundMobilePeer
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 EmbeddedHnsBackend without 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 EmbeddedHnsBackend without endpoint credentials.
HnsShakescapeDirectFailure
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 EmbeddedHnsBackend without endpoint credentials. Coarse, non-sensitive outcome of the most recent direct discovery dial.
MobileHnsFinalizeNoticePhase
MobileHnsNameOwnershipStatus
MobileHnsNameResourceStatus
MobileHnsValueIntent
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.
MobilePlatform
MobileShakedexQuery
Closed non-signing Shakedex query vocabulary for the installed native UI.
MobileShakescapeDirectAdmission
One locally admitted direct-board or direct-session event. The native controller intentionally exposes no oracle-derived pricing result.
MobileShakescapeDirectMessageKind
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.
MobileShakescapeSettlementAction
MobileWalletError
ReconciledShakescapeBitcoinFunding
Current result for one durable HTLC watch. NotConfirmed is 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 EmbeddedHnsBackend without 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 EmbeddedHnsBackend without endpoint credentials.