Skip to content

Latest commit

 

History

History
78 lines (63 loc) · 3.83 KB

README.md

File metadata and controls

78 lines (63 loc) · 3.83 KB
Raw

marinade-ts-cli

Marinade typescript based CLI for user commands.

Quick start

npm i -g @marinade.finance/marinade-ts-cli
marinade --help
Usage: marinade [options] [command]

Options:
  -V, --version                                    output the version number
  -u, --url <url-or-moniker>                       URL of Solana cluster or moniker (m/mainnet/mainnet-beta, d/devnet, t/testnet) (default: "m")
  --commitment <commitment>                        Commitment (default: "confirmed")
  -k, --keypair <keypair-or-ledger>                Wallet keypair (path or ledger url in format usb://ledger/[<pubkey>][?key=<derivedPath>])  (default:
                                                   ~/.config/solana/id.json)
  -s, --simulate                                   Simulate (default: false)
  -p, --print-only                                 Print only mode, no execution, instructions are printed in base64 to output. This can be used for
                                                   placing the admin commands to SPL Governance UI by hand. (default: false)
  --skip-preflight                                 setting transaction execution flag "skip-preflight" (default: false)
  -d, --debug                                      Debug (default: false)
  -v, --verbose                                    Verbose (the same as --debug) (default: false)
  -h, --help                                       display help for command

Commands:
  balance [account-pubkey]                         Show account balance
  show-referral-state <referral-code>              Show Marinade referral partner's state
  show [options] [state-address]                   Show marinade state
  add-liquidity <amount-sol>                       Provide liquidity to the liquidity pool
  remove-liquidity <amount-sol>                    Remove liquidity from the liquidity pool
  deposit [options] <amount-sol>                   Deposit SOL
  liquid-unstake [options] <amount-msol>           Unstake mSOL using liquidity pool
  deposit-stake-account [options] <stake-account>  Deposit stake account
  claim <ticket>                                   Claim ordered unstake ticket
  order-unstake <amount-msol>                      Order unstake to get a ticket that can be claimed later
  withdraw-stake-account [options] <amount-msol>   Withdraw stake account
  show-tickets [options]                           Show delayed unstake tickets for a beneficiary (initialized by order-unstake)
  show-event <event-data>                          Showing data of anchor event
  help [command]                                   display help for command

Develop & Test

git clone https://github.com/marinade-finance/marinade-ts-cli.git
cd marinade-ts-cli
pnpm install

pnpm cli --help

# to test Solana CLI tools and Anchor in version 0.28.0 is required
pnpm test

To get the latest version from npm and run it

npm i @marinade.finance/marinade-ts-cli
npx @marinade.finance/marinade-ts-cli

Repository structure

The repository is split to few separate projects that can be reused by other CLI tooling and is composited into the resulted marinade user CLI @marinade.finance/marinade-ts-cli.

  • ts-common — few reusable TypeScript utilities
  • web3js-common — utility functions used with solana/web3.js library
  • cli-common — consists of utilities when building a CLI app
  • jest-utils — jest equality tester and typings for a matcher for CLI
  • ledger-utils — utilities when using ledger TypeScript library in CLI
  • spl-gov-utils — utilities when working with SPL Governance
  • marinade-ts-cli — the user related CLI for Marinade.Finance