Trait Signer

pub trait Signer {
    // Required methods
    fn try_pubkey(&self) -> Result<Pubkey, SignerError>;
    fn try_sign_message(&self, message: &[u8]) -> Result<Signature, SignerError>;
    fn is_interactive(&self) -> bool;

    // Provided methods
    fn pubkey(&self) -> Pubkey { ... }
    fn sign_message(&self, message: &[u8]) -> Signature { ... }
}

The Signer trait declares operations that all digital signature providers must support. It is the primary interface by which signers are specified in Transaction signing interfaces

Required Methods

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

Fallibly gets the implementor’s public key

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 implementation requires user interaction to sign

Provided Methods

fn pubkey(&self) -> Pubkey

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

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.

Trait Implementations

impl Debug for dyn Signer

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

Formats the value using the given formatter.

impl<T> From<T> for Box<dyn Signer>

where T: Signer + 'static,

fn from(signer: T) -> Self

Converts to this type from the input type.

impl PartialEq for dyn Signer

fn eq(&self, other: &dyn Signer) -> 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 Eq for dyn Signer

Implementors

impl Signer for Keypair

impl Signer for NullSigner

impl Signer for Presigner

impl<Container: Deref<Target = impl Signer>> Signer for Container

This impl allows using Signer with types like Box/Rc/Arc.