Class PublicKey

A public key

Hierarchy

  • Struct

Methods

decode decodeUnchecked unique createWithSeed createProgramAddressSync createProgramAddress findProgramAddressSync findProgramAddress isOnCurve encode equals toBase58 toJSON toBytes toBuffer toString

Properties

default

Constructors

constructor

Methods

Static decode

  • Parameters

    • data: Buffer

    Returns any

Static decodeUnchecked

  • Parameters

    • data: Buffer

    Returns any

Static unique

  • Returns a unique PublicKey for tests and benchmarks using a counter

    Returns PublicKey

Static createWithSeed

  • Derive a public key from another key, a seed, and a program ID. The program ID will also serve as the owner of the public key, giving it permission to write data to the account.

    Parameters

    Returns Promise<PublicKey>

Static createProgramAddressSync

  • Derive a program address from seeds and a program ID.

    Parameters

    • seeds: (Buffer | Uint8Array)[]
    • programId: PublicKey

    Returns PublicKey

Static createProgramAddress

  • Async version of createProgramAddressSync For backwards compatibility

    Deprecated

    Use createProgramAddressSync instead

    Parameters

    • seeds: (Buffer | Uint8Array)[]
    • programId: PublicKey

    Returns Promise<PublicKey>

Static findProgramAddressSync

  • Find a valid program address

    Valid program addresses must fall off the ed25519 curve. This function iterates a nonce until it finds one that when combined with the seeds results in a valid program address.

    Parameters

    • seeds: (Buffer | Uint8Array)[]
    • programId: PublicKey

    Returns [PublicKey, number]

Static findProgramAddress

  • Async version of findProgramAddressSync For backwards compatibility

    Deprecated

    Use findProgramAddressSync instead

    Parameters

    • seeds: (Buffer | Uint8Array)[]
    • programId: PublicKey

    Returns Promise<[PublicKey, number]>

Static isOnCurve

  • Check that a pubkey is on the ed25519 curve.

    Parameters

    • pubkeyData: PublicKeyInitData

    Returns boolean

encode

  • Returns Buffer

equals

  • Checks if two publicKeys are equal

    Parameters

    Returns boolean

toBase58

  • Return the base-58 representation of the public key

    Returns string

toJSON

  • Returns string

toBytes

  • Return the byte array representation of the public key

    Returns Uint8Array

toBuffer

  • Return the Buffer representation of the public key

    Returns Buffer

toString

  • Return the base-58 representation of the public key

    Returns string

Properties

Static default

default: PublicKey

Default public key value. The base58-encoded string representation is all ones (as seen below) The underlying BN number is 32 bytes that are all zeros

Constructors

constructor

  • Create a new PublicKey object

    Parameters

    • value: PublicKeyInitData

      ed25519 public key as buffer or base-58 encoded string

    Returns PublicKey

Settings

Member Visibility

Theme

Generated using TypeDoc