Appearance

Getting Started ​

Welcome, developers! JPool is a Solana stake pool that mints JSOL when users deposit SOL. This section covers the tools for integrating JPool into your application or operating the pool from the command line.

Choose your integration path ​

Stake Pool SDK
Deposit, withdraw, and query the JPool stake pool programmatically with @jpool/sdk.
Direct Stake Integration
Integrate JPool direct stake via signMessage and on-chain transactions.
CLI Reference
Command-line operations for stake pool deposits, withdrawals, and bond management.
  • Building an app or service? Use the Stake Pool SDK. It wraps deposits, withdrawals, direct staking, and pool queries behind a typed client.
  • Adding direct staking to a wallet or frontend? Follow the Direct Stake Integration guide for the signMessage flow and on-chain transactions.
  • Running one-off operations? Reach for the CLI Reference to deposit, withdraw, and manage bonds without writing code.

Quick start with the SDK ​

Install the package and its peer dependency, then query the pool:

bash
npm install @jpool/sdk
bash
pnpm add @jpool/sdk
bash
yarn add @jpool/sdk
typescript
import { Connection, clusterApiUrl, LAMPORTS_PER_SOL } from '@solana/web3.js'
import { JPoolClient } from '@jpool/sdk'

const connection = new Connection(clusterApiUrl('mainnet-beta'))
const client = new JPoolClient(connection)

const poolInfo = await client.poolInfo()
console.log('Total staked:', Number(poolInfo.totalLamports) / LAMPORTS_PER_SOL, 'SOL')

Peer dependency: @solana/web3.js v1.x. For the full API, configuration, and more examples, continue to the Stake Pool SDK.

New to JPool? ​

If you want to understand the product before integrating, start with the User Docs for an overview of staking strategies and JSOL, or the Validator Docs for the delegation program.