Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Coin

Hierarchy

  • Coin

Index

Constructors

Properties

Accessors

Methods

Constructors

Private constructor

  • new Coin(symbol: string, decimals: number, mint: PublicKey, mintAuthority: Keypair, freezeAuthority: null | Keypair): Coin

  • Parameters

    • symbol: string
    • decimals: number
    • mint: PublicKey
    • mintAuthority: Keypair
    • freezeAuthority: null | Keypair

    Returns Coin

Properties

Private _decimals

_decimals: number

Private _freezeAuthority

_freezeAuthority: null | Keypair

Private _mint

_mint: PublicKey

Private _mintAuthority

_mintAuthority: Keypair

Private _symbol

_symbol: string

Accessors

decimals

  • get decimals(): number

freezeAuthority

  • get freezeAuthority(): null | Keypair

mint

  • get mint(): PublicKey

mintAuthority

  • get mintAuthority(): Keypair

symbol

  • get symbol(): string

Methods

fundAccount

  • fundAccount(decimalAmount: number, owner: Keypair, connection: Connection): Promise<void>

  • Fund the owner key-pair with the specified amount of this coin.

    Parameters

    • decimalAmount: number

      The amount of tokens to fund account with, in decimal notation.

    • owner: Keypair

      The Keypair to fund.

    • connection: Connection

      The Connection object to connect to Solana.

    Returns Promise<void>

getBalance

  • getBalance(owner: Keypair, connection: Connection): Promise<RpcResponseAndContext<TokenAmount>>

  • Get the token balance for the specified owner.

    Parameters

    • owner: Keypair

      The Keypair whose balance to fetch.

    • connection: Connection

      The Connection object to connect to Solana.

    Returns Promise<RpcResponseAndContext<TokenAmount>>

isEqual

  • isEqual(to: Coin): boolean

  • Equality check between two Coins.

    Parameters

    • to: Coin

      The Coin object to compare to.

    Returns boolean

Static load

  • load(connection: Connection, symbol: string, mint: PublicKey, mintAuthority: Keypair, freezeAuthority: null | Keypair): Promise<Coin>

  • Load an exisiting mint as a Coin.

    Parameters

    • connection: Connection

      The Connection object to connect to Solana.

    • symbol: string

      The symbol to assign to the coin.

    • mint: PublicKey

      The PublicKey of the Mint for the coin.

    • mintAuthority: Keypair

      The minting authority Keypair for the coin.

    • freezeAuthority: null | Keypair

      The optional freezing authority Keypair for the coin.

    Returns Promise<Coin>

Generated using TypeDoc