Hierarchy

  • QuarryWrapper

Constructors

Properties

key: PublicKey

The key of the quarry.

quarryData: AnchorTypeDef<Object, AnchorDefined<AnchorQuarryMine, Record<string, never>>>

The data of the quarry.

rewarderData: AnchorTypeDef<Object, AnchorDefined<AnchorQuarryMine, Record<string, never>>>

The data of the rewarder.

token: Token

The token being staked.

Accessors

Methods

  • Get the computed rewards rate of the quarry.

    This is used for tests, so you probably don't want this. You want quarryData.annualRewardsRate.

    Returns

    annualRewardsRate

    Returns u64

  • Creates the miner of the provided wallet.

    Parameters

    • __namedParameters: { authority?: PublicKey } = {}
      • Optional authority?: PublicKey

    Returns Promise<PendingMiner>

  • Creates a miner wrapper

    Returns

    Parameters

    • authority: PublicKey
    • minerKey: PublicKey
    • tokenVaultKey: PublicKey
    • stakedTokenATA: PublicKey

    Returns MinerWrapper

  • Get the miner data associated with the authority account

    Returns

    Parameters

    • authority: PublicKey

    Returns Promise<null | AnchorTypeDef<Object, AnchorDefined<AnchorQuarryMine, Record<string, never>>>>

  • Get the public key of the miner assocaited with the authority account

    Returns

    miner public key

    Parameters

    • authority: PublicKey

      who owns the miner

    Returns Promise<PublicKey>

  • Sets the famine timestampe for this mine.

    Parameters

    • famineTs: u64

    Returns TransactionEnvelope

  • Sets the rewards share of this mine.

    Parameters

    • share: u64

    Returns TransactionEnvelope

Generated using TypeDoc