Expand description
Canonical Handshake marketplace and bilateral cross-chain wire protocols.
Structs§
- Asset
Amount - AssetId
- ChainId
- Direct
Offer - An offer setter’s exact, indivisible HNS/BTC exchange intent.
- Direct
Offer Acceptance - A responder’s signed acceptance of one exact live offer intent.
- Direct
Offer Cancellation - A signed, monotonic withdrawal of an offer setter’s live intent.
- HnsHtlc
Session Binding - Exact native-HNS descriptor and timing identity bound into one session hello side.
- Market
Pair - Name
Market Hello - Network
Binding - Settlement
Deadline - Shakescape
Hnsa Endpoint Binding - Exact HNSA service and endpoint delegation material used for relay handoff.
- Shakescape
HrmRoot Binding - Exact HRM root material that authorized the configured named relay.
- Shakescape
Publication Acceptance Expectation - Exact durable wallet handoff fields covered by an endpoint receipt.
- Shakescape
Publication Acceptance Policy - Immutable endpoint policy bound into every signed relay acceptance.
- Signed
Object Header - Swap
Funding Status - Swap
Redeem Status - Swap
Refund Status - Swap
Session Hello - Swap
Session Proposal - Canonical responder-maker-signed session terms sent to the original offer
setter, now the execution taker, before a fully accepted
SwapSessionHelloexists. - Swap
Watch Ready - A receiver-signed, session-bound acknowledgement that an exact HTLC watch is installed before its counterparty funds that chain. It deliberately contains no peer endpoint, wallet height, address, or transaction claim. A sender cannot use it as funding evidence; it only closes the bilateral pre-funding coordination gate.
- Verified
Shakescape Publication Acceptance - Canonically decoded and endpoint-signature-verified relay receipt.
Enums§
- Cross
Chain Message - Deadline
Kind - Funding
State - Marketplace
Error - Name
Market Message - Redeem
State - Refund
State - Shakescape
Publication Message Kind - Shakescape
Registry Version - Swap
Asset Side - Selects the maker-offered or maker-received side of a swap agreement.
Constants§
- CROSS_
CHAIN_ MARKET_ PROTOCOL_ VERSION - HNSA_
NAMED_ SERVICE_ RESOURCE_ PROFILE - Draft HRM/HNSA profile carried by Shakescape relay-acceptance receipts.
- MARKETPLACE_
PROTOCOL_ VERSION - MAX_
DIRECT_ OFFER_ SIZE - MAX_
INVENTORY_ ENTRIES - MAX_
NAME_ OFFERS_ PER_ MESSAGE - MAX_
PRIMITIVE_ SIZE - MAX_
SETTLEMENT_ UNIX_ TIME - MAX_
SHAKESCAPE_ MARKET_ PAYLOAD - MAX_
SHAKESCAPE_ PUBLICATION_ ACCEPTANCE_ BYTES - Maximum canonical size of one endpoint-signed publication receipt.
- MAX_
SHAKESCAPE_ PUBLICATION_ ACCEPTANCE_ LIFETIME_ SECONDS - Maximum lifetime admitted by the receipt codec, independent of a stricter caller-selected policy.
- MAX_
SWAP_ MESSAGE_ SIZE - NAME_
MARKET_ PROTOCOL_ VERSION
Functions§
- hns_
refund_ time_ lock - Convert a marketplace Unix safety deadline to HSD’s encoded median-time lock without allowing 512-second granularity to shorten the promise.
- sign_
shakescape_ publication_ acceptance - Create a canonical, low-S DER endpoint receipt for one exact handoff.
- verify_
expected_ shakescape_ publication_ acceptance - Verify and bind a receipt to the caller’s exact configured policy, durable handoff, and trusted acceptance time.
- verify_
shakescape_ publication_ acceptance - Decode, canonicalize, and verify one endpoint receipt.