@jpool/bond-sdk 0.1.0-next.2 → 0.1.0-next.4

package/README.md

@@ -1,126 +1,6 @@
-# JBond CLI
+# @jpool/bond-sdk
 
-Command-line interface for interacting with the JBond Solana contract.
+![https://img.shields.io/npm/v/@jpool/bond-sdk.svg](https://img.shields.io/npm/v/@jpool/bond-sdk.svg?style=flat-square)
+[![npm downloads](https://img.shields.io/npm/dt/@jpool/bond-sdk.svg?maxAge=2592000&style=flat-square)](https://npm-stat.com/charts.html?package=@jpool/bond-sdk)
 
-## Installation
-
-```bash
-cd app
-npm install
-npm run build
-```
-
-## Configuration
-
-1. Copy `.env.example` to `.env`:
-
-```bash
-cp .env.example .env
-```
-
-2. Edit `.env` with your configuration:
-
-- `SOLANA_RPC_URL`: Solana RPC endpoint
-- `PROGRAM_ID`: JBond program ID
-- `RESERVE_ADDRESS`: Reserve vault address
-- `KEYPAIR_PATH`: Path to your Solana keypair (optional)
-
-## Usage
-
-### Initialize Compensation Pool (First time setup)
-
-```bash
-npm run dev initialize
-# or with custom keypair
-npm run dev initialize --keypair /path/to/authority.json
-```
-
-### Register Validator
-
-```bash
-# Register with vote account and 10 SOL initial collateral
-npm run dev register-validator <vote-account-pubkey> 10
-```
-
-### Top Up Collateral
-
-```bash
-# Add 5 SOL to existing collateral
-npm run dev topup-collateral <vote-account-pubkey> 5
-```
-
-### Withdraw Compensation (Oracle only)
-
-```bash
-# Withdraw 2 SOL from validator
-npm run dev withdraw-compensation <validator-pubkey> <vote-account-pubkey> 2
-```
-
-### Check Validator Info
-
-```bash
-# Check validator boost account
-npm run dev validator-info <vote-account-pubkey>
-
-# Check specific validator
-npm run dev validator-info <vote-account-pubkey> --validator <validator-pubkey>
-```
-
-### Check Pool Info
-
-```bash
-npm run dev pool-info
-```
-
-## Building for Production
-
-```bash
-npm run build
-npm link  # Make 'jbond' command available globally
-```
-
-Then you can use:
-
-```bash
-jbond validator-info <vote-account-pubkey>
-jbond register-validator <vote-account-pubkey> 10
-# etc...
-```
-
-## Project Structure
-
-```
-app/
-├── src/
-│   ├── cli.ts           # Main CLI entry point
-│   ├── client.ts        # JBond client implementation
-│   ├── config.ts        # Configuration loader
-│   ├── types/           # TypeScript types
-│   └── idl/             # Contract IDL
-├── package.json
-├── tsconfig.json
-├── .env.example
-└── README.md
-```
-
-## Development
-
-```bash
-# Run in development mode
-npm run dev <command>
-
-# Build
-npm run build
-
-# Lint
-npm run lint
-
-# Format
-npm run format
-```
-
-## Important Notes
-
-1. Before registering a validator, make sure you have your vote account public key
-2. The authority keypair is required for initialize and withdraw-compensation commands
-3. Make sure to copy your program's IDL file to `src/idl/jbond.json` after building the Anchor program
+> The bond module of [jpool](https://jpool.one/).

package/dist/index.d.mts

@@ -3,8 +3,6 @@ import { PublicKey, Connection, Keypair, TransactionInstruction } from '@solana/
 
 type Config = {
     rpcUrl: string;
-    programId: PublicKey;
-    reserveAddress: PublicKey;
 };
 type ValidatorBondAccount = {
     identity: PublicKey;
@@ -18,6 +16,7 @@ type ValidatorBondAccount = {
 };
 type InitializeProps = {
     authority: PublicKey;
+    reserveAddress: PublicKey;
 };
 type RegisterValidatorProps = {
     creator: PublicKey;
@@ -90,7 +89,7 @@ declare enum BondTransactionType {
  * IDL can be found at `target/idl/jbond.json`.
  */
 type Jbond = {
-    address: '4a3YovKEfm4jWhczCzJciHXL1xVkXWfGQjRCaMft7M4G';
+    address: '8vrqsFHnDdjMYMwahytRzmmYgRqCMmka8X6DJUXGQzWr';
     metadata: {
         name: 'jbond';
         version: '0.1.0';
@@ -321,6 +320,10 @@ type Jbond = {
                     name: 'destination';
                     writable: true;
                 },
+                {
+                    name: 'epochSchedule';
+                    address: 'SysvarEpochSchedu1e111111111111111111111111';
+                },
                 {
                     name: 'systemProgram';
                     address: '11111111111111111111111111111111';
@@ -389,6 +392,60 @@ type Jbond = {
             ];
             args: [];
         },
+        {
+            name: 'setAuthority';
+            docs: [
+                'Change the bond authority'
+            ];
+            discriminator: [
+                133,
+                250,
+                37,
+                21,
+                110,
+                163,
+                26,
+                121
+            ];
+            accounts: [
+                {
+                    name: 'globalState';
+                    writable: true;
+                    pda: {
+                        seeds: [
+                            {
+                                kind: 'const';
+                                value: [
+                                    103,
+                                    108,
+                                    111,
+                                    98,
+                                    97,
+                                    108,
+                                    95,
+                                    115,
+                                    116,
+                                    97,
+                                    116,
+                                    101
+                                ];
+                            }
+                        ];
+                    };
+                },
+                {
+                    name: 'authority';
+                    signer: true;
+                    relations: [
+                        'globalState'
+                    ];
+                },
+                {
+                    name: 'newAuthority';
+                }
+            ];
+            args: [];
+        },
         {
             name: 'withdrawCompensation';
             docs: [
@@ -613,6 +670,11 @@ type Jbond = {
             code: 6008;
             name: 'unauthorized';
             msg: 'unauthorized';
+        },
+        {
+            code: 6009;
+            name: 'withdrawalLockedNearEpochEnd';
+            msg: 'Withdrawals are locked near the end of the epoch.';
         }
     ];
     types: [
@@ -797,20 +859,37 @@ type Jbond = {
     ];
 };
 
+declare enum BondClientEnv {
+    DEV = "dev",
+    PROD = "prod"
+}
 declare class JBondClient {
     connection: Connection;
     program: Program<Jbond>;
     provider: AnchorProvider;
     config: Config;
-    constructor(config: Config, wallet?: Wallet);
+    readonly options: ClientOptions;
+    constructor(config: Config, wallet?: Wallet, options?: ClientOptions);
     /**
      * Creates an instance of `JBondClient` using a provided connection and wallet.
      */
-    static fromWallet(config: Config, wallet?: Wallet): JBondClient;
+    static fromWallet(config: Config, wallet?: Wallet, options?: ClientOptions): JBondClient;
     /**
      * Creates an instance of `JBondClient` using the provided connection and keypair.
      */
-    static fromKeypair(config: Config, keypair: Keypair): JBondClient;
+    static fromKeypair(config: Config, keypair: Keypair, options?: ClientOptions): JBondClient;
+    /**
+     * Get the current program ID.
+     */
+    get programId(): PublicKey;
+    /**
+     * Set the environment.
+     */
+    env(env: BondClientEnv): this;
+    /**
+     * Configure a specific option.
+     */
+    configure<K extends keyof ClientOptions>(key: K, val: ClientOptions[K]): this;
     getGlobalStatePDA(): [PublicKey, number];
     getValidatorBondPDA(voteAccount: PublicKey): [PublicKey, number];
     buildInitializeInstruction(props: InitializeProps): Promise<TransactionInstruction>;
@@ -823,6 +902,10 @@ declare class JBondClient {
         amount: number;
     }>): Promise<TransactionInstruction[]>;
     getValidatorBondAccount(voteAccount: PublicKey): Promise<ValidatorBondAccount | null>;
+    buildSetAuthorityInstruction(props: {
+        authority: PublicKey;
+        newAuthority: PublicKey;
+    }): Promise<TransactionInstruction>;
     /**
      * Get the collateral balance of a validator bond account
      * @param voteAccount - The vote account public key
@@ -833,9 +916,10 @@ declare class JBondClient {
         authority: string;
         totalValidators: number;
         totalWithdrawn: number;
+        reserveAddress: string;
     } | null>;
     getCurrentEpoch(): Promise<number>;
-    initialize(authority?: PublicKey): Promise<string>;
+    initialize(reserveAddress: PublicKey, authority?: PublicKey): Promise<string>;
     registerValidator(voteAccount: PublicKey, initialCollateral: number, withdrawalAuthority?: PublicKey, identity?: PublicKey): Promise<string>;
     topUpCollateral(voteAccount: PublicKey, amount: number, validator?: PublicKey): Promise<string>;
     withdrawCollateral(voteAccount: PublicKey, destination: PublicKey, amount: number, withdrawalAuthority?: PublicKey): Promise<string>;
@@ -856,11 +940,12 @@ declare class JBondClient {
     getFullHistory(voteAccount: PublicKey, pageSize?: number): Promise<TransactionHistoryItem[]>;
     private getInstructionDiscriminator;
 }
+type ClientOptions = {
+    programId?: PublicKey;
+    debug?: boolean;
+} & Record<string, any>;
 
-declare const PROGRAM_ID = "4a3YovKEfm4jWhczCzJciHXL1xVkXWfGQjRCaMft7M4G";
-declare const RESERVE_ADDRESS = "61mS9nEir6jx6cvte6NzQpyrFk3Fj4krMNLuHhi4tjJz";
-
-declare function loadConfig(): Config;
-declare function loadKeypair(keypairPath: string): Keypair;
+declare const PROGRAM_ID: PublicKey;
+declare const DEV_PROGRAM_ID: PublicKey;
 
-export { BondTransactionType, type Config, type EpochHistoryItem, type GetHistoryGroupedProps, type GetHistoryProps, type GlobalState, type InitializeProps, JBondClient, type Jbond, PROGRAM_ID, RESERVE_ADDRESS, type RegisterValidatorProps, type TopUpCollateralProps, type TransactionHistoryItem, type ValidatorBondAccount, type WithdrawCollateralProps, type WithdrawCompensationProps, loadConfig, loadKeypair };
+export { BondClientEnv, BondTransactionType, type ClientOptions, type Config, DEV_PROGRAM_ID, type EpochHistoryItem, type GetHistoryGroupedProps, type GetHistoryProps, type GlobalState, type InitializeProps, JBondClient, type Jbond, PROGRAM_ID, type RegisterValidatorProps, type TopUpCollateralProps, type TransactionHistoryItem, type ValidatorBondAccount, type WithdrawCollateralProps, type WithdrawCompensationProps };

package/dist/index.d.ts

@@ -3,8 +3,6 @@ import { PublicKey, Connection, Keypair, TransactionInstruction } from '@solana/
 
 type Config = {
     rpcUrl: string;
-    programId: PublicKey;
-    reserveAddress: PublicKey;
 };
 type ValidatorBondAccount = {
     identity: PublicKey;
@@ -18,6 +16,7 @@ type ValidatorBondAccount = {
 };
 type InitializeProps = {
     authority: PublicKey;
+    reserveAddress: PublicKey;
 };
 type RegisterValidatorProps = {
     creator: PublicKey;
@@ -90,7 +89,7 @@ declare enum BondTransactionType {
  * IDL can be found at `target/idl/jbond.json`.
  */
 type Jbond = {
-    address: '4a3YovKEfm4jWhczCzJciHXL1xVkXWfGQjRCaMft7M4G';
+    address: '8vrqsFHnDdjMYMwahytRzmmYgRqCMmka8X6DJUXGQzWr';
     metadata: {
         name: 'jbond';
         version: '0.1.0';
@@ -321,6 +320,10 @@ type Jbond = {
                     name: 'destination';
                     writable: true;
                 },
+                {
+                    name: 'epochSchedule';
+                    address: 'SysvarEpochSchedu1e111111111111111111111111';
+                },
                 {
                     name: 'systemProgram';
                     address: '11111111111111111111111111111111';
@@ -389,6 +392,60 @@ type Jbond = {
             ];
             args: [];
         },
+        {
+            name: 'setAuthority';
+            docs: [
+                'Change the bond authority'
+            ];
+            discriminator: [
+                133,
+                250,
+                37,
+                21,
+                110,
+                163,
+                26,
+                121
+            ];
+            accounts: [
+                {
+                    name: 'globalState';
+                    writable: true;
+                    pda: {
+                        seeds: [
+                            {
+                                kind: 'const';
+                                value: [
+                                    103,
+                                    108,
+                                    111,
+                                    98,
+                                    97,
+                                    108,
+                                    95,
+                                    115,
+                                    116,
+                                    97,
+                                    116,
+                                    101
+                                ];
+                            }
+                        ];
+                    };
+                },
+                {
+                    name: 'authority';
+                    signer: true;
+                    relations: [
+                        'globalState'
+                    ];
+                },
+                {
+                    name: 'newAuthority';
+                }
+            ];
+            args: [];
+        },
         {
             name: 'withdrawCompensation';
             docs: [
@@ -613,6 +670,11 @@ type Jbond = {
             code: 6008;
             name: 'unauthorized';
             msg: 'unauthorized';
+        },
+        {
+            code: 6009;
+            name: 'withdrawalLockedNearEpochEnd';
+            msg: 'Withdrawals are locked near the end of the epoch.';
         }
     ];
     types: [
@@ -797,20 +859,37 @@ type Jbond = {
     ];
 };
 
+declare enum BondClientEnv {
+    DEV = "dev",
+    PROD = "prod"
+}
 declare class JBondClient {
     connection: Connection;
     program: Program<Jbond>;
     provider: AnchorProvider;
     config: Config;
-    constructor(config: Config, wallet?: Wallet);
+    readonly options: ClientOptions;
+    constructor(config: Config, wallet?: Wallet, options?: ClientOptions);
     /**
      * Creates an instance of `JBondClient` using a provided connection and wallet.
      */
-    static fromWallet(config: Config, wallet?: Wallet): JBondClient;
+    static fromWallet(config: Config, wallet?: Wallet, options?: ClientOptions): JBondClient;
     /**
      * Creates an instance of `JBondClient` using the provided connection and keypair.
      */
-    static fromKeypair(config: Config, keypair: Keypair): JBondClient;
+    static fromKeypair(config: Config, keypair: Keypair, options?: ClientOptions): JBondClient;
+    /**
+     * Get the current program ID.
+     */
+    get programId(): PublicKey;
+    /**
+     * Set the environment.
+     */
+    env(env: BondClientEnv): this;
+    /**
+     * Configure a specific option.
+     */
+    configure<K extends keyof ClientOptions>(key: K, val: ClientOptions[K]): this;
     getGlobalStatePDA(): [PublicKey, number];
     getValidatorBondPDA(voteAccount: PublicKey): [PublicKey, number];
     buildInitializeInstruction(props: InitializeProps): Promise<TransactionInstruction>;
@@ -823,6 +902,10 @@ declare class JBondClient {
         amount: number;
     }>): Promise<TransactionInstruction[]>;
     getValidatorBondAccount(voteAccount: PublicKey): Promise<ValidatorBondAccount | null>;
+    buildSetAuthorityInstruction(props: {
+        authority: PublicKey;
+        newAuthority: PublicKey;
+    }): Promise<TransactionInstruction>;
     /**
      * Get the collateral balance of a validator bond account
      * @param voteAccount - The vote account public key
@@ -833,9 +916,10 @@ declare class JBondClient {
         authority: string;
         totalValidators: number;
         totalWithdrawn: number;
+        reserveAddress: string;
     } | null>;
     getCurrentEpoch(): Promise<number>;
-    initialize(authority?: PublicKey): Promise<string>;
+    initialize(reserveAddress: PublicKey, authority?: PublicKey): Promise<string>;
     registerValidator(voteAccount: PublicKey, initialCollateral: number, withdrawalAuthority?: PublicKey, identity?: PublicKey): Promise<string>;
     topUpCollateral(voteAccount: PublicKey, amount: number, validator?: PublicKey): Promise<string>;
     withdrawCollateral(voteAccount: PublicKey, destination: PublicKey, amount: number, withdrawalAuthority?: PublicKey): Promise<string>;
@@ -856,11 +940,12 @@ declare class JBondClient {
     getFullHistory(voteAccount: PublicKey, pageSize?: number): Promise<TransactionHistoryItem[]>;
     private getInstructionDiscriminator;
 }
+type ClientOptions = {
+    programId?: PublicKey;
+    debug?: boolean;
+} & Record<string, any>;
 
-declare const PROGRAM_ID = "4a3YovKEfm4jWhczCzJciHXL1xVkXWfGQjRCaMft7M4G";
-declare const RESERVE_ADDRESS = "61mS9nEir6jx6cvte6NzQpyrFk3Fj4krMNLuHhi4tjJz";
-
-declare function loadConfig(): Config;
-declare function loadKeypair(keypairPath: string): Keypair;
+declare const PROGRAM_ID: PublicKey;
+declare const DEV_PROGRAM_ID: PublicKey;
 
-export { BondTransactionType, type Config, type EpochHistoryItem, type GetHistoryGroupedProps, type GetHistoryProps, type GlobalState, type InitializeProps, JBondClient, type Jbond, PROGRAM_ID, RESERVE_ADDRESS, type RegisterValidatorProps, type TopUpCollateralProps, type TransactionHistoryItem, type ValidatorBondAccount, type WithdrawCollateralProps, type WithdrawCompensationProps, loadConfig, loadKeypair };
+export { BondClientEnv, BondTransactionType, type ClientOptions, type Config, DEV_PROGRAM_ID, type EpochHistoryItem, type GetHistoryGroupedProps, type GetHistoryProps, type GlobalState, type InitializeProps, JBondClient, type Jbond, PROGRAM_ID, type RegisterValidatorProps, type TopUpCollateralProps, type TransactionHistoryItem, type ValidatorBondAccount, type WithdrawCollateralProps, type WithdrawCompensationProps };