<p align="center"><a href="https://marinade.finance/"></a>

marinade-ts-sdk

Marinade.finance is a liquid staking protocol built on Solana. People stake their Solana tokens with Marinade using automatic staking strategies and receive "staked SOL" tokens they can use in the world of DeFi or to swap any time back to original SOL tokens to unstake.

This SDK wraps the staking protocol and allows you to start marinading from your applications.

!Build
<a href="https://www.npmjs.com/package/@marinade.finance/marinade-ts-sdk"></a>

Contents:

Installation

Examples

- Initialize the library
- Staking
- Liquidity pool

Learn more

Installation

$ npm install @marinade.finance/marinade-ts-sdk

Examples

Initialize the library

1) Use the default configuration (with Solana devnet):

import { Marinade } from '@marinade.finance/marinade-ts-sdk'
const marinade = new Marinade()

or using plain HTML (do not forget to replace <VERSION>):

2) Extend your configuration with other options:

import { Marinade, MarinadeConfig, Wallet, Provider } from '@marinade.finance/marinade-ts-sdk'
const config = new MarinadeConfig({
  connection: currentConnection,
  publicKey: wallet.pubKey
})
const marinade = new Marinade(config)

3) When you use the referral code, staking/unstaking functions are run against the Marinade Referral Program.

import { Marinade, MarinadeConfig } from '@marinade.finance/marinade-ts-sdk'
const MY_REFERRAL_ACCOUNT = "...." // <-- your referral account
const config = new MarinadeConfig({
  connection: currentConnection,
  publicKey: wallet.pubKey,
  referralCode: new web3.PublicKey(MY_REFERRAL_ACCOUNT),
})
const marinade = new Marinade(config)

Staking

Stake SOL and get your mSOL:

...
const {
  associatedMSolTokenAccountAddress,
  transaction,
} = await marinade.deposit(amountLamports)
// sign and send the transaction
const signature = await provider.send(transaction)

Swap your mSOL to get back SOL immediately using the liquidity pool:

...
const {
  associatedMSolTokenAccountAddress,
  transaction,
} = await marinade.liquidUnstake(amountLamports)
// sign and send the transaction
const signature = await provider.send(transaction)

... [truncated — view full README on GitHub]