Class PublicKey

constructor

• new PublicKey(value: PublicKeyInitData): PublicKey

  Create a new PublicKey object

  Parameters

  • value: PublicKeyInitData

    ed25519 public key as bytes or base-58 encoded string

  Returns PublicKey

Staticdefault

[toStringTag]

• get "[toStringTag]"(): string

  Returns string

address

• get address(): Address

  The base-58 representation of the public key as a Kit Address branded string. Satisfies Kit's HasAddress interface so a PublicKey can be passed anywhere Kit accepts an address-bearing object.

  Returns Address

encode

• encode(): Uint8Array

  Borsh-compatible encoding (little-endian)

  Returns Uint8Array

equals

• equals(address: PublicKey): boolean

  Checks if two publicKeys are equal

  Parameters

  • address: PublicKey

  Returns boolean

toBase58

• toBase58(): Address

  Return the base-58 representation of the public key as a Kit Address branded string, suitable for passing to @solana/kit APIs or generated program clients that expect an Address.

  Returns Address

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

verifySignature

• verifySignature(
      signature: ReadonlyUint8Array,
      message: ReadonlyUint8Array,
  ): Promise<boolean>

  Verify a signature for the provided message with this public key.

  Parameters

  • signature: ReadonlyUint8Array
  • message: ReadonlyUint8Array

  Returns Promise<boolean>

  Since

  2.0.0

StaticcreateProgramAddress

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

  Derive a program address from seeds and a program ID.

  Parameters

  • seeds: (Uint8Array<ArrayBufferLike> | ReadonlyUint8Array<ArrayBufferLike>)[]
  • programId: PublicKey

  Returns Promise<PublicKey>

  Throws

  SolanaError with SOLANA_ERROR__SUBTLE_CRYPTO__DIGEST_UNIMPLEMENTED from @solana/errors if crypto.subtle.digest() is unavailable.

  Throws

  SolanaError with SOLANA_ERROR__ADDRESSES__MAX_NUMBER_OF_PDA_SEEDS_EXCEEDED from @solana/errors if the supplied seeds exceed the PDA count limit.

  Throws

  SolanaError with SOLANA_ERROR__ADDRESSES__MAX_PDA_SEED_LENGTH_EXCEEDED from @solana/errors if any supplied seed exceeds the PDA seed-length limit.

  Throws

  SolanaError with SOLANA_ERROR__ADDRESSES__INVALID_SEEDS_POINT_ON_CURVE from @solana/errors if the derived address falls on the Ed25519 curve.

StaticcreateWithSeed

• createWithSeed(
      fromPublicKey: PublicKey,
      seed: string,
      programId: PublicKey,
  ): Promise<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

  • fromPublicKey: PublicKey
  • seed: string
  • programId: PublicKey

  Returns Promise<PublicKey>

  Throws

  SolanaError with SOLANA_ERROR__ADDRESSES__MAX_PDA_SEED_LENGTH_EXCEEDED from @solana/errors if the seed exceeds 32 bytes.

  Throws

  SolanaError with SOLANA_ERROR__ADDRESSES__PDA_ENDS_WITH_PDA_MARKER from @solana/errors if the program address ends with the PDA marker bytes.

Staticdecode

• decode(data: number[] | Uint8Array<ArrayBufferLike>): PublicKey

  Borsh-compatible decoding (little-endian)

  Parameters

  • data: number[] | Uint8Array<ArrayBufferLike>

  Returns PublicKey

StaticdecodeUnchecked

• decodeUnchecked(data: number[] | Uint8Array<ArrayBufferLike>): PublicKey

  Borsh-compatible unchecked decoding (little-endian)

  Parameters

  • data: number[] | Uint8Array<ArrayBufferLike>

  Returns PublicKey

StaticfindProgramAddress

• findProgramAddress(
      seeds: (
          Uint8Array<ArrayBufferLike>
          | ReadonlyUint8Array<ArrayBufferLike>
      )[],
      programId: PublicKey,
  ): Promise<[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: (Uint8Array<ArrayBufferLike> | ReadonlyUint8Array<ArrayBufferLike>)[]
  • programId: PublicKey

  Returns Promise<[PublicKey, number]>

  Throws

  SolanaError with SOLANA_ERROR__ADDRESSES__MAX_NUMBER_OF_PDA_SEEDS_EXCEEDED from @solana/errors if the supplied seeds exceed the PDA count limit.

  Throws

  SolanaError with SOLANA_ERROR__ADDRESSES__MAX_PDA_SEED_LENGTH_EXCEEDED from @solana/errors if any supplied seed exceeds the PDA seed-length limit.

  Throws

  SolanaError with SOLANA_ERROR__ADDRESSES__FAILED_TO_FIND_VIABLE_PDA_BUMP_SEED from @solana/errors if no viable bump seed exists.

StaticisOnCurve

• isOnCurve(addressData: PublicKeyInitData): boolean

  Check that a pubkey is on the ed25519 curve.

  Parameters

  • addressData: PublicKeyInitData

  Returns boolean