Class LST

LST class has to be initialized to call key lst functions like mint, redeem and refresh.

Example

const lst = new LST({
   lstInfo:
     "0xc1d996e18df1cc82a8c014c6d8290048ed30dafb34cd6b43ab9fde77f7eabcde",
   lstCointype:
     "0x34732358cebfdf4ee29534f906cbb36a78dfaaa256e7d9ddb7e789e2ddabcse::demo::DEMO",
 });
 * const txb = await lst.mint("100000000", address);

Constructors

constructor

Properties

lst

Methods

mint redeem refresh

Constructors

constructor

Properties

lst

lst: LstParams

Methods

mint

  • mint(suiAmount: string, address: string): Promise<undefined | Transaction>

  • Parameters

    • suiAmount: string

      amount of sui to stake

    • address: string

      address where the minted stsui will be transferred.

    Returns Promise<undefined | Transaction>

    transaction block

redeem

  • redeem(stSuiAmount: string, address: string): Promise<undefined | Transaction>

  • Parameters

    • stSuiAmount: string

      amount of stsui to unstake

    • address: string

      address where the redemmed sui will be transferred.

    Returns Promise<undefined | Transaction>

    transaction block

refresh

  • refresh(): Promise<undefined | Transaction>

  • Multipurpose onchain function that ideally has to be called right before and after change of epoch. Used to stake all the pending sui to the updated set of validators and convert all the staked sui to fungible sui when eligible.

    Returns Promise<undefined | Transaction>

    transaction block

Settings

Member Visibility

On This Page

Constructors
Properties
Methods