Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PublicKey

A public key

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Create a new PublicKey object

    Parameters

    Returns PublicKey

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

Accessors

[toStringTag]

  • get [toStringTag](): string

  • Returns string

Methods

encode

  • encode(): Buffer

  • Returns Buffer

equals

  • Checks if two publicKeys are equal

    Parameters

    Returns boolean

toBase58

  • toBase58(): string

  • Return the base-58 representation of the public key

    Returns string

toBuffer

  • toBuffer(): Buffer

  • Return the Buffer representation of the public key in big endian

    Returns Buffer

toBytes

  • toBytes(): Uint8Array

  • Return the byte array representation of the public key in big endian

    Returns Uint8Array

toJSON

  • toJSON(): string

  • Returns string

toString

  • toString(): string

  • Return the base-58 representation of the public key

    Returns string

Static createProgramAddress

  • createProgramAddress(seeds: (Buffer | Uint8Array)[], programId: PublicKey): Promise<PublicKey>

  • Async version of createProgramAddressSync For backwards compatibility

    deprecated

    Use createProgramAddressSync instead

    Parameters

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

    Returns Promise<PublicKey>

Static createProgramAddressSync

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

    Parameters

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

    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 decode

  • decode(data: Buffer): any

  • Parameters

    • data: Buffer

    Returns any

Static decodeUnchecked

  • decodeUnchecked(data: Buffer): any

  • Parameters

    • data: Buffer

    Returns any

Static findProgramAddress

  • findProgramAddress(seeds: (Buffer | Uint8Array)[], programId: PublicKey): Promise<[PublicKey, number]>

  • Async version of findProgramAddressSync For backwards compatibility

    deprecated

    Use findProgramAddressSync instead

    Parameters

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

    Returns Promise<[PublicKey, number]>

Static findProgramAddressSync

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

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

  • Check that a pubkey is on the ed25519 curve.

    Parameters

    Returns boolean

Static unique

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

    Returns PublicKey

Generated using TypeDoc