Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StakingContract

Hierarchy

  • StakingContract

Index

Constructors

Properties

Methods

Constructors

constructor

  • new StakingContract(algodClient: default, historicalIndexerClient: default): StakingContract

  • This is the constructor for the StakingContract class.

    Note, do not call this to create a new staking contract. Instead call the static method init as there are asynchronous set up steps in creating an staking contract and a constructor can only return an instance of the class and not a promise.

    Example

     
    //Correct way to instantiate new staking contract
    const newStakingContract = await StakingContract.init(algodClient, historicalIndexerClient, stakingContractInfo)

    //Incorrect way to instantiate new staking contract
    const newStakingContract = new StakingContract(algodClient, historicalIndexerClient)

    Parameters

    • algodClient: default

      algod client

    • historicalIndexerClient: default

      historical indexer client

    Returns StakingContract

Properties

algodClient

algodClient: default

historicalIndexerClient

historicalIndexerClient: default

manager

manager: Manager

market

market: Market

Methods

getAsset

getManager

getManagerAddress

  • getManagerAddress(): string

getManagerAppId

  • getManagerAppId(): number

getMarket

getMarketAddress

  • getMarketAddress(): string

getMarketAppId

  • getMarketAppId(): number

getOracleAppId

  • getOracleAppId(): number

getRewardsProgram

getStaked

  • getStaked(): number

getStorageAddress

  • getStorageAddress(address: string): Promise<string>

  • Return the staking contract storage address for given address or null if it does not exist

    Parameters

    • address: string

      address to get info for

    Returns Promise<string>

    storage account address for user

getStorageState

  • getStorageState(storageAddress: string): Promise<{}>

  • Return the staking contract local state for storage address

    Parameters

    • storageAddress: string

      -storage address to get info for

    Returns Promise<{}>

    staking contract local state for address

getUserState

  • getUserState(address: string): Promise<{}>

  • Return the staking contract local state for address

    Parameters

    • address: string

      address to get info for

    Returns Promise<{}>

    staking contract local state for address

updateGlobalState

  • updateGlobalState(): Promise<void>

Static init

  • init(algodClient: default, historicalIndexerClient: default, stakingContractInfo: {}): Promise<StakingContract>

  • This is the function that should be called when creating a new staking contract. You pass everything you would to the constructor with an additional staking contract info dictionary, but to this function instead and this returns the new and created staking contract.

    Example

     
    //Correct way to instantiate new staking contract
    const newStakingContract = await StakingContract.init(algodClient, historicalIndexerClient, stakingContractInfo)

    //Incorrect way to instantiate new staking contract
    const newStakingContract = new StakingContract(algodClient, historicalIndexerClient)

    Parameters

    • algodClient: default

      algod client

    • historicalIndexerClient: default

      historical indexer client

    • stakingContractInfo: {}

      dictionary of information on staking contract

      • [key: string]: number

    Returns Promise<StakingContract>

Generated using TypeDoc