Struct bip47::PrivateCode

pub struct PrivateCode { /* private fields */ }

Represents the private side of a payment code, as seen from the perspective of the sender. This is what the sender will use in conjunction with a receiver’s public payment code in order to be able to send funds.

Implementations

impl PrivateCode

pub fn from_seed(
    seed: &[u8],
    account: u32,
    network: Network
) -> Result<Self, Error>

Constructs a new payment code from the private side using a BIP32 seed.

pub fn from_seed_ephemeral(
    seed: &[u8],
    account: u32,
    network: Network,
    ephemeral_index: u32
) -> Result<Self, Error>

Constructs a new ephemeral payment code at the given index from the private side using a BIP32 seed.

pub fn v1_public_code(
    &self,
    bitmessage: Option<BitMessagePreference>
) -> PublicCode

Generates a version 1 public payment code matching this private payment code, optionally with bitmessage.

pub fn v2_public_code(&self) -> PublicCode

Generates a version 2 public payment code matching this private payment code.

pub fn private_key(
    &self,
    sender_code: &PublicCode,
    i: u32
) -> Result<PrivateKey, Error>

Derives a receive private key at the given index, with respect to a public payment code. Used for spending purposes. If the index is invalid, it should be incremented.

pub fn address(
    &self,
    sender_code: &PublicCode,
    i: u32,
    segwit: bool
) -> Result<Address, Error>

Derives a receive address at the given index. If the index is invalid, it should be incremented.