Class Secp256k1Keypair

An Secp256k1 Keypair used for signing transactions.

Hierarchy (view full)

Constructors

constructor

Methods

getKeyScheme getPublicKey getSecretKey sign signPersonalMessage signTransaction signWithIntent toSuiAddress deriveKeypair fromSecretKey fromSeed generate

Constructors

constructor

Methods

getKeyScheme

getPublicKey

getSecretKey

  • getSecretKey(): string

  • The Bech32 secret key string for this Secp256k1 keypair

    Returns string

sign

  • sign(data): Promise<Uint8Array>

  • Return the signature for the provided data.

    Parameters

    • data: Uint8Array

    Returns Promise<Uint8Array>

signPersonalMessage

  • signPersonalMessage(bytes): Promise<{
        bytes: string;
        signature: string;
    }>

  • Signs provided personal message by calling signWithIntent() with a PersonalMessage provided as intent scope

    Parameters

    • bytes: Uint8Array

    Returns Promise<{
        bytes: string;
        signature: string;
    }>

signTransaction

  • signTransaction(bytes): Promise<SignatureWithBytes>

  • Signs provided transaction by calling signWithIntent() with a TransactionData provided as intent scope

    Parameters

    • bytes: Uint8Array

    Returns Promise<SignatureWithBytes>

signWithIntent

  • signWithIntent(bytes, intent): Promise<SignatureWithBytes>

  • Sign messages with a specific intent. By combining the message bytes with the intent before hashing and signing, it ensures that a signed message is tied to a specific purpose and domain separator is provided

    Parameters

    Returns Promise<SignatureWithBytes>

toSuiAddress

  • toSuiAddress(): string

  • Returns string

Static deriveKeypair

  • deriveKeypair(mnemonics, path?): Secp256k1Keypair

  • Derive Secp256k1 keypair from mnemonics and path. The mnemonics must be normalized and validated against the english wordlist.

    If path is none, it will default to m/54'/784'/0'/0/0, otherwise the path must be compliant to BIP-32 in form m/54'/784'/{account_index}'/{change_index}/{address_index}.

    Parameters

    • mnemonics: string
    • Optional path: string

    Returns Secp256k1Keypair

Static fromSecretKey

  • fromSecretKey(secretKey, options?): Secp256k1Keypair

  • Create a keypair from a raw secret key byte array.

    This method should only be used to recreate a keypair from a previously generated secret key. Generating keypairs from a random seed should be done with the Keypair.fromSeed method.

    Parameters

    • secretKey: Uint8Array

      secret key byte array

    • Optional options: {
          skipValidation?: boolean;
      }
      • Optional skipValidation?: boolean

    Returns Secp256k1Keypair

    Throws

    error if the provided secret key is invalid and validation is not skipped.

Static fromSeed

  • fromSeed(seed): Secp256k1Keypair

  • Generate a keypair from a 32 byte seed.

    Parameters

    • seed: Uint8Array

      seed byte array

    Returns Secp256k1Keypair

Static generate

Settings

Member Visibility

Theme

On This Page

constructorgetKeySchemegetPublicKeygetSecretKeysignsignPersonalMessagesignTransactionsignWithIntenttoSuiAddressderiveKeypairfromSecretKeyfromSeedgenerate