Skip to main content

Secp256k1PrivateKey

Struct Secp256k1PrivateKey 

Source
pub struct Secp256k1PrivateKey { /* private fields */ }
Available on crate feature secp256k1 only.
Expand description

A Secp256k1 ECDSA private key.

The private key is zeroized when dropped.

Implementations§

Source§

impl Secp256k1PrivateKey

Source

pub fn generate() -> Self

Generates a new random Secp256k1 private key.

Source

pub fn from_bytes(bytes: &[u8]) -> AptosResult<Self>

Creates a private key from raw bytes.

§Errors

Returns AptosError::InvalidPrivateKey if:

  • The byte slice length is not exactly 32 bytes
  • The bytes do not represent a valid Secp256k1 private key
Source

pub fn from_hex(hex_str: &str) -> AptosResult<Self>

Creates a private key from a hex string.

§Errors

Returns AptosError::Hex if the hex string is invalid. Returns AptosError::InvalidPrivateKey if the decoded bytes are not exactly 32 bytes or do not represent a valid Secp256k1 private key.

Source

pub fn from_aip80(s: &str) -> AptosResult<Self>

Creates a private key from AIP-80 format string.

AIP-80 format: secp256k1-priv-0x{hex_bytes}

§Errors

Returns an error if the format is invalid or the key bytes are invalid.

Source

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

Returns the private key as bytes.

Source

pub fn to_hex(&self) -> String

Returns the private key as a hex string.

Source

pub fn to_aip80(&self) -> String

Returns the private key in AIP-80 format.

AIP-80 format: secp256k1-priv-0x{hex_bytes}

Source

pub fn public_key(&self) -> Secp256k1PublicKey

Returns the corresponding public key.

Source

pub fn sign(&self, message: &[u8]) -> Secp256k1Signature

Signs message and returns a low-S ECDSA signature over the SHA3-256 digest of message.

Aptos on-chain verification (see aptos-crypto::secp256k1_ecdsa::Signature::verify) hashes the signing-message preimage with SHA-3-256 before invoking ECDSA on the 32-byte digest. We mirror that flow exactly: compute the SHA-3-256 digest first, then sign it via PrehashSigner so the k256 crate does not apply its default SHA-256 internally.

Historical note: prior versions of this SDK relied on Signer::sign which does an internal SHA-256, producing a signature over SHA-256(message) (or, with a SHA-256 pre-hash, over SHA-256(SHA-256(message))). Both forms verified internally but were rejected by the chain because the chain hashes with SHA-3-256.

§Panics

Panics only in the (mathematically impossible) case that k256::ecdsa::SigningKey::sign_prehash returns Err for a 32-byte prehash, which the signature::hazmat::PrehashSigner contract for secp256k1 does not produce.

Source

pub fn sign_prehashed(&self, digest: &[u8; 32]) -> Secp256k1Signature

Signs a 32-byte pre-computed digest directly, with NO further hashing.

The caller is responsible for ensuring digest is the correct hash for the on-chain verification scheme (Aptos uses SHA-3-256).

§Panics

Panics only if k256::ecdsa::SigningKey::sign_prehash returns Err for the supplied 32-byte digest, which the signature::hazmat::PrehashSigner contract for secp256k1 does not produce.

Trait Implementations§

Source§

impl Clone for Secp256k1PrivateKey

Source§

fn clone(&self) -> Secp256k1PrivateKey

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Secp256k1PrivateKey

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Signer for Secp256k1PrivateKey

Source§

type Signature = Secp256k1Signature

The signature type produced by this signer.
Source§

fn sign(&self, message: &[u8]) -> Secp256k1Signature

Signs the given message and returns a signature.
Source§

fn public_key(&self) -> Secp256k1PublicKey

Returns the public key corresponding to this signer.
Source§

impl Zeroize for Secp256k1PrivateKey

Source§

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more