Struct ArkNote 

pub struct ArkNote { /* private fields */ }

ArkNote is a bearer token that can be redeemed by revealing its preimage.

The note encodes:

• A 32-byte preimage (the secret)
• A value in satoshis (up to u32::MAX)

The on-chain representation is a hash-locked taproot script that checks SHA256(witness) == hash(preimage).

Implementations

impl ArkNote

pub fn new(preimage: [u8; 32], value: Amount) -> Result<Self, Error>

Create a new ArkNote with the default HRP.

pub fn new_with_hrp( preimage: [u8; 32], value: Amount, hrp: String, ) -> Result<Self, Error>

Create a new ArkNote with a custom HRP.

pub fn from_string(s: &str) -> Result<Self, Error>

Parse an ArkNote from its string representation.

pub fn from_string_with_hrp(s: &str, hrp: &str) -> Result<Self, Error>

Parse an ArkNote from its string representation with a custom HRP.

pub fn to_encoded_string(&self) -> String

Encode the ArkNote to its string representation.

pub fn preimage(&self) -> &[u8; 32]

Get the preimage.

pub fn preimage_hash(&self) -> Hash

Get the preimage hash.

pub fn value(&self) -> Amount

Get the value in satoshis.

pub fn hrp(&self) -> &str

Get the HRP.

pub fn script(&self) -> ScriptBuf

Get the script that locks this note (spendable by revealing the preimage).

pub fn txid(&self) -> Txid

Get a synthetic txid derived from the preimage hash.

This is used to create a unique identifier for the note in the VTXO system.

pub fn outpoint(&self) -> OutPoint

Get a synthetic outpoint for this note.

pub fn to_intent_input(&self) -> Result<Input, Error>

Convert this ArkNote to an intent input for settlement.

The note creates a fake VTXO with a hash-lock script. When settling, the preimage is revealed as the witness instead of a signature.

Trait Implementations

impl Clone for ArkNote

fn clone(&self) -> ArkNote

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ArkNote

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for ArkNote

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for ArkNote

impl PartialEq for ArkNote

fn eq(&self, other: &ArkNote) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ArkNote