Class Admin

Admin class has to be initialized to call admin functions specific to your lst.

Example

const admin = new Admin({
   lstCointype:
     "0xabcd2358cebfdf4ee29534f906cbb36a78dfaaa256e7d9ddb7e789e2dd8abcd::demo::DEMO",
   treasuryCap:
     "0xabcdc88f4ac2eeeb5ac13917c4d3ce147228b62295d51dff4950abd3bb4cabcd",
 });
 const txb = await admin.createLst(
   0,
   1,
   600,
   10000,
   address,
 );

Constructors

constructor

Properties

lst

Methods

collectFee createLst setValidators updateFee

Constructors

constructor

Properties

lst

lst: LstParams

Methods

collectFee

  • collectFee(address: string): Promise<undefined | Transaction>

  • note: collection fee cap is required to be set in LstParams

    Parameters

    • address: string

      address where the collected fee will be transferred

    Returns Promise<undefined | Transaction>

    transaction block

createLst

  • createLst(
        mintFeeBps: number,
        redeemFeeBps: number,
        spreadFeeBps: number,
        redistributionFeeBps: number,
        address: string,
    ): Promise<undefined | Transaction>

  • Parameters

    • mintFeeBps: number

      fee to be levied upon minting your lst

    • redeemFeeBps: number

      fee to be levied upon unstaking your lst

    • spreadFeeBps: number

      performance fee that can be charged by your lst on validator rewards

    • redistributionFeeBps: number

      percentage of redeem fee that will be redistributed among the stakers

    • address: string

      address where the admin cap and collection fee cap will be transferred

    Returns Promise<undefined | Transaction>

    transaction block

setValidators

  • setValidators(
        addresses: string[],
        weights: number[],
    ): Promise<undefined | Transaction>

  • Parameters

    • addresses: string[]

      list of validator addresses

    • weights: number[]

      list of weights corresponding to the i'th validator address

    Returns Promise<undefined | Transaction>

    transaction block

updateFee

  • updateFee(
        mintFeeBps: number,
        redeemFeeBps: number,
        spreadFeeBps: number,
        redistributionFeeBps: number,
    ): Promise<undefined | Transaction>

  • refer createLst for info on params

    Parameters

    • mintFeeBps: number
    • redeemFeeBps: number
    • spreadFeeBps: number
    • redistributionFeeBps: number

    Returns Promise<undefined | Transaction>

    transaction block

Settings

Member Visibility

On This Page

Constructors
Properties
Methods