Struct sugar_cli::sign::process::Keypair

pub struct Keypair(_);

A vanilla Ed25519 key pair

Implementations

impl Keypair

pub fn generate<R>(csprng: &mut R) -> Keypairwhere
    R: CryptoRng + RngCore,

Constructs a new, random Keypair using a caller-proveded RNG

pub fn new() -> Keypair

Constructs a new, random Keypair using OsRng

pub fn from_bytes(bytes: &[u8]) -> Result<Keypair, Error>

Recovers a Keypair from a byte array

pub fn to_bytes(&self) -> [u8; 64]

Returns this Keypair as a byte array

pub fn from_base58_string(s: &str) -> Keypair

Recovers a Keypair from a base58-encoded string

pub fn to_base58_string(&self) -> String

Returns this Keypair as a base58-encoded string

pub fn secret(&self) -> &SecretKey

Gets this Keypair’s SecretKey

Trait Implementations

impl Debug for Keypair

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

Formats the value using the given formatter.

impl FromWasmAbi for Keypair

type Abi = u32

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Keypair

Recover a Self from Self::Abi.

impl IntoWasmAbi for Keypair

type Abi = u32

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl OptionFromWasmAbi for Keypair

fn is_none(abi: &<Keypair as FromWasmAbi>::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for Keypair

fn none() -> <Keypair as IntoWasmAbi>::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl<T> PartialEq<T> for Keypairwhere
    T: Signer,

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl RefFromWasmAbi for Keypair

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, Keypair>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(
    js: <Keypair as RefFromWasmAbi>::Abi
) -> <Keypair as RefFromWasmAbi>::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for Keypair

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RefMut<'static, Keypair>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(
    js: <Keypair as RefMutFromWasmAbi>::Abi
) -> <Keypair as RefMutFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl Signer for Keypair

fn pubkey(&self) -> Pubkey

Infallibly gets the implementor’s public key. Returns the all-zeros Pubkey if the implementor has none.

fn try_pubkey(&self) -> Result<Pubkey, SignerError>

Fallibly gets the implementor’s public key

fn sign_message(&self, message: &[u8]) -> Signature

Infallibly produces an Ed25519 signature over the provided message bytes. Returns the all-zeros Signature if signing is not possible.

fn try_sign_message(&self, message: &[u8]) -> Result<Signature, SignerError>

Fallibly produces an Ed25519 signature over the provided message bytes.

fn is_interactive(&self) -> bool

Whether the impelmentation requires user interaction to sign