Class PublicKey

A public key

Hierarchy

  • Struct

Methods

  • Parameters

    • data: Buffer

    Returns any

  • Parameters

    • data: Buffer

    Returns any

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

    Returns PublicKey

  • 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>

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

    Parameters

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

    Returns PublicKey

  • Async version of createProgramAddressSync For backwards compatibility

    Deprecated

    Use createProgramAddressSync instead

    Parameters

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

    Returns Promise<PublicKey>

  • 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: (Uint8Array | Buffer)[]
    • programId: PublicKey

    Returns [PublicKey, number]

  • Async version of findProgramAddressSync For backwards compatibility

    Deprecated

    Use findProgramAddressSync instead

    Parameters

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

    Returns Promise<[PublicKey, number]>

  • Check that a pubkey is on the ed25519 curve.

    Parameters

    • pubkeyData: PublicKeyInitData

    Returns boolean

  • Returns Buffer

  • Checks if two publicKeys are equal

    Parameters

    Returns boolean

  • Return the base-58 representation of the public key

    Returns string

  • Returns string

  • Return the byte array representation of the public key

    Returns Uint8Array

  • Return the Buffer representation of the public key

    Returns Buffer

  • Return the base-58 representation of the public key

    Returns string

Properties

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

  • Create a new PublicKey object

    Parameters

    • value: PublicKeyInitData

      ed25519 public key as buffer or base-58 encoded string

    Returns PublicKey

Generated using TypeDoc