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

package/dist/index.d.ts

@@ -0,0 +1,866 @@
+import { BN, Program, AnchorProvider, Wallet } from '@coral-xyz/anchor';
+import { PublicKey, Connection, Keypair, TransactionInstruction } from '@solana/web3.js';
+
+type Config = {
+    rpcUrl: string;
+    programId: PublicKey;
+    reserveAddress: PublicKey;
+};
+type ValidatorBondAccount = {
+    identity: PublicKey;
+    voteAccount: PublicKey;
+    withdrawalAuthority?: string;
+    totalWithdrawn: number;
+    lastWithdrawalEpoch: number;
+    isActive: boolean;
+    createdAt: number;
+    bump: number;
+};
+type InitializeProps = {
+    authority: PublicKey;
+};
+type RegisterValidatorProps = {
+    creator: PublicKey;
+    identity: PublicKey;
+    voteAccount: PublicKey;
+    initialCollateral: number;
+    withdrawalAuthority?: PublicKey;
+};
+type TopUpCollateralProps = {
+    user: PublicKey;
+    voteAccount: PublicKey;
+    amount: number;
+};
+type WithdrawCollateralProps = {
+    withdrawalAuthority: PublicKey;
+    voteAccount: PublicKey;
+    destination: PublicKey;
+    amount: number;
+};
+type WithdrawCompensationProps = {
+    authority: PublicKey;
+    voteAccount: PublicKey;
+    amount: number;
+};
+type GetHistoryProps = {
+    voteAccount: PublicKey;
+    options?: {
+        limit?: number;
+        before?: string;
+        until?: string;
+    };
+};
+type GetHistoryGroupedProps = {
+    voteAccount: PublicKey;
+    epochsCount?: number;
+};
+type GlobalState = {
+    authority: PublicKey;
+    totalValidators: number;
+    totalCollateral: BN;
+    totalWithdrawn: BN;
+    bump: number;
+};
+type EpochHistoryItem = {
+    epoch: number;
+    deposits: number;
+    withdrawals: number;
+    balanceChange: number;
+    signatures: string[];
+};
+type TransactionHistoryItem = {
+    signature: string;
+    slot: number;
+    epoch: number;
+    type: BondTransactionType;
+    amount: number;
+    beforeBalance?: number;
+    afterBalance?: number;
+};
+declare enum BondTransactionType {
+    Deposit = "deposit",
+    Withdrawal = "withdrawal",
+    Compensation = "compensation"
+}
+
+/**
+ * Program IDL in camelCase format in order to be used in JS/TS.
+ *
+ * Note that this is only a type helper and is not the actual IDL. The original
+ * IDL can be found at `target/idl/jbond.json`.
+ */
+type Jbond = {
+    address: '4a3YovKEfm4jWhczCzJciHXL1xVkXWfGQjRCaMft7M4G';
+    metadata: {
+        name: 'jbond';
+        version: '0.1.0';
+        spec: '0.1.0';
+        description: 'Validator compensation program for boosting APR';
+    };
+    instructions: [
+        {
+            name: 'bondInit';
+            docs: [
+                'Register validator and fund initial collateral'
+            ];
+            discriminator: [
+                220,
+                108,
+                156,
+                81,
+                16,
+                185,
+                144,
+                157
+            ];
+            accounts: [
+                {
+                    name: 'globalState';
+                    writable: true;
+                    pda: {
+                        seeds: [
+                            {
+                                kind: 'const';
+                                value: [
+                                    103,
+                                    108,
+                                    111,
+                                    98,
+                                    97,
+                                    108,
+                                    95,
+                                    115,
+                                    116,
+                                    97,
+                                    116,
+                                    101
+                                ];
+                            }
+                        ];
+                    };
+                },
+                {
+                    name: 'validatorBondAccount';
+                    writable: true;
+                    pda: {
+                        seeds: [
+                            {
+                                kind: 'const';
+                                value: [
+                                    118,
+                                    97,
+                                    108,
+                                    105,
+                                    100,
+                                    97,
+                                    116,
+                                    111,
+                                    114,
+                                    95,
+                                    98,
+                                    111,
+                                    110,
+                                    100
+                                ];
+                            },
+                            {
+                                kind: 'account';
+                                path: 'voteAccount';
+                            }
+                        ];
+                    };
+                },
+                {
+                    name: 'identity';
+                },
+                {
+                    name: 'voteAccount';
+                },
+                {
+                    name: 'creator';
+                    docs: [
+                        'The account creating the bond (pays for account creation and initial collateral)'
+                    ];
+                    writable: true;
+                    signer: true;
+                },
+                {
+                    name: 'systemProgram';
+                    address: '11111111111111111111111111111111';
+                }
+            ];
+            args: [
+                {
+                    name: 'initialCollateral';
+                    type: 'u64';
+                },
+                {
+                    name: 'withdrawalAuthority';
+                    type: {
+                        option: 'pubkey';
+                    };
+                }
+            ];
+        },
+        {
+            name: 'bondTopUp';
+            docs: [
+                'Top up collateral for existing validator'
+            ];
+            discriminator: [
+                132,
+                225,
+                254,
+                187,
+                152,
+                162,
+                176,
+                66
+            ];
+            accounts: [
+                {
+                    name: 'validatorBondAccount';
+                    writable: true;
+                    pda: {
+                        seeds: [
+                            {
+                                kind: 'const';
+                                value: [
+                                    118,
+                                    97,
+                                    108,
+                                    105,
+                                    100,
+                                    97,
+                                    116,
+                                    111,
+                                    114,
+                                    95,
+                                    98,
+                                    111,
+                                    110,
+                                    100
+                                ];
+                            },
+                            {
+                                kind: 'account';
+                                path: 'validator_bond_account.vote_account';
+                                account: 'validatorBondAccount';
+                            }
+                        ];
+                    };
+                },
+                {
+                    name: 'depositor';
+                    writable: true;
+                    signer: true;
+                },
+                {
+                    name: 'systemProgram';
+                    address: '11111111111111111111111111111111';
+                }
+            ];
+            args: [
+                {
+                    name: 'amount';
+                    type: 'u64';
+                }
+            ];
+        },
+        {
+            name: 'bondWithdraw';
+            discriminator: [
+                99,
+                64,
+                127,
+                178,
+                53,
+                117,
+                70,
+                204
+            ];
+            accounts: [
+                {
+                    name: 'validatorBondAccount';
+                    writable: true;
+                    pda: {
+                        seeds: [
+                            {
+                                kind: 'const';
+                                value: [
+                                    118,
+                                    97,
+                                    108,
+                                    105,
+                                    100,
+                                    97,
+                                    116,
+                                    111,
+                                    114,
+                                    95,
+                                    98,
+                                    111,
+                                    110,
+                                    100
+                                ];
+                            },
+                            {
+                                kind: 'account';
+                                path: 'validator_bond_account.vote_account';
+                                account: 'validatorBondAccount';
+                            }
+                        ];
+                    };
+                },
+                {
+                    name: 'withdrawalAuthority';
+                    writable: true;
+                    signer: true;
+                },
+                {
+                    name: 'destination';
+                    writable: true;
+                },
+                {
+                    name: 'systemProgram';
+                    address: '11111111111111111111111111111111';
+                }
+            ];
+            args: [
+                {
+                    name: 'amount';
+                    type: 'u64';
+                }
+            ];
+        },
+        {
+            name: 'initialize';
+            docs: [
+                'Initialize the global state and reserve vault'
+            ];
+            discriminator: [
+                175,
+                175,
+                109,
+                31,
+                13,
+                152,
+                155,
+                237
+            ];
+            accounts: [
+                {
+                    name: 'globalState';
+                    writable: true;
+                    pda: {
+                        seeds: [
+                            {
+                                kind: 'const';
+                                value: [
+                                    103,
+                                    108,
+                                    111,
+                                    98,
+                                    97,
+                                    108,
+                                    95,
+                                    115,
+                                    116,
+                                    97,
+                                    116,
+                                    101
+                                ];
+                            }
+                        ];
+                    };
+                },
+                {
+                    name: 'authority';
+                    writable: true;
+                    signer: true;
+                },
+                {
+                    name: 'reserve';
+                },
+                {
+                    name: 'systemProgram';
+                    address: '11111111111111111111111111111111';
+                }
+            ];
+            args: [];
+        },
+        {
+            name: 'withdrawCompensation';
+            docs: [
+                'Withdraw compensation from validator to reserve (oracle only)'
+            ];
+            discriminator: [
+                10,
+                228,
+                22,
+                213,
+                205,
+                117,
+                181,
+                75
+            ];
+            accounts: [
+                {
+                    name: 'globalState';
+                    writable: true;
+                    pda: {
+                        seeds: [
+                            {
+                                kind: 'const';
+                                value: [
+                                    103,
+                                    108,
+                                    111,
+                                    98,
+                                    97,
+                                    108,
+                                    95,
+                                    115,
+                                    116,
+                                    97,
+                                    116,
+                                    101
+                                ];
+                            }
+                        ];
+                    };
+                },
+                {
+                    name: 'validatorBondAccount';
+                    writable: true;
+                    pda: {
+                        seeds: [
+                            {
+                                kind: 'const';
+                                value: [
+                                    118,
+                                    97,
+                                    108,
+                                    105,
+                                    100,
+                                    97,
+                                    116,
+                                    111,
+                                    114,
+                                    95,
+                                    98,
+                                    111,
+                                    110,
+                                    100
+                                ];
+                            },
+                            {
+                                kind: 'account';
+                                path: 'validator_bond_account.vote_account';
+                                account: 'validatorBondAccount';
+                            }
+                        ];
+                    };
+                },
+                {
+                    name: 'reserve';
+                    writable: true;
+                },
+                {
+                    name: 'authority';
+                    docs: [
+                        'Authority that can trigger claims'
+                    ];
+                    signer: true;
+                },
+                {
+                    name: 'systemProgram';
+                    address: '11111111111111111111111111111111';
+                }
+            ];
+            args: [
+                {
+                    name: 'amount';
+                    type: 'u64';
+                }
+            ];
+        }
+    ];
+    accounts: [
+        {
+            name: 'globalState';
+            discriminator: [
+                163,
+                46,
+                74,
+                168,
+                216,
+                123,
+                133,
+                98
+            ];
+        },
+        {
+            name: 'validatorBondAccount';
+            discriminator: [
+                25,
+                67,
+                241,
+                227,
+                226,
+                104,
+                108,
+                73
+            ];
+        }
+    ];
+    events: [
+        {
+            name: 'collateralToppedUp';
+            discriminator: [
+                189,
+                137,
+                204,
+                58,
+                135,
+                182,
+                19,
+                176
+            ];
+        },
+        {
+            name: 'collateralWithdrawn';
+            discriminator: [
+                51,
+                224,
+                133,
+                106,
+                74,
+                173,
+                72,
+                82
+            ];
+        },
+        {
+            name: 'compensationClaimed';
+            discriminator: [
+                36,
+                159,
+                41,
+                178,
+                104,
+                135,
+                220,
+                32
+            ];
+        },
+        {
+            name: 'validatorRegistered';
+            discriminator: [
+                20,
+                20,
+                190,
+                191,
+                53,
+                174,
+                95,
+                72
+            ];
+        }
+    ];
+    errors: [
+        {
+            code: 6000;
+            name: 'invalidVoteAccount';
+            msg: 'Invalid vote account';
+        },
+        {
+            code: 6001;
+            name: 'identityMismatch';
+            msg: 'Identity does not match vote account';
+        },
+        {
+            code: 6002;
+            name: 'insufficientCollateral';
+            msg: 'Insufficient collateral amount';
+        },
+        {
+            code: 6003;
+            name: 'targetAprTooLow';
+            msg: 'Target APR is below minimum threshold';
+        },
+        {
+            code: 6004;
+            name: 'mathOverflow';
+            msg: 'Math overflow';
+        },
+        {
+            code: 6005;
+            name: 'invalidAmount';
+            msg: 'Invalid amount';
+        },
+        {
+            code: 6006;
+            name: 'validatorNotActive';
+            msg: 'Validator boost account is not active';
+        },
+        {
+            code: 6007;
+            name: 'validatorAlreadyRegistered';
+            msg: 'Validator already registered';
+        },
+        {
+            code: 6008;
+            name: 'unauthorized';
+            msg: 'unauthorized';
+        }
+    ];
+    types: [
+        {
+            name: 'collateralToppedUp';
+            type: {
+                kind: 'struct';
+                fields: [
+                    {
+                        name: 'validator';
+                        type: 'pubkey';
+                    },
+                    {
+                        name: 'amount';
+                        type: 'u64';
+                    },
+                    {
+                        name: 'newTotal';
+                        type: 'u64';
+                    },
+                    {
+                        name: 'timestamp';
+                        type: 'i64';
+                    }
+                ];
+            };
+        },
+        {
+            name: 'collateralWithdrawn';
+            type: {
+                kind: 'struct';
+                fields: [
+                    {
+                        name: 'validator';
+                        type: 'pubkey';
+                    },
+                    {
+                        name: 'amount';
+                        type: 'u64';
+                    },
+                    {
+                        name: 'remainingCollateral';
+                        type: 'u64';
+                    },
+                    {
+                        name: 'timestamp';
+                        type: 'i64';
+                    }
+                ];
+            };
+        },
+        {
+            name: 'compensationClaimed';
+            type: {
+                kind: 'struct';
+                fields: [
+                    {
+                        name: 'validator';
+                        type: 'pubkey';
+                    },
+                    {
+                        name: 'amount';
+                        type: 'u64';
+                    },
+                    {
+                        name: 'remainingCollateral';
+                        type: 'u64';
+                    },
+                    {
+                        name: 'totalWithdrawn';
+                        type: 'u64';
+                    },
+                    {
+                        name: 'epoch';
+                        type: 'u64';
+                    },
+                    {
+                        name: 'timestamp';
+                        type: 'i64';
+                    }
+                ];
+            };
+        },
+        {
+            name: 'globalState';
+            type: {
+                kind: 'struct';
+                fields: [
+                    {
+                        name: 'authority';
+                        type: 'pubkey';
+                    },
+                    {
+                        name: 'reserve';
+                        type: 'pubkey';
+                    },
+                    {
+                        name: 'totalValidators';
+                        type: 'u32';
+                    },
+                    {
+                        name: 'totalWithdrawn';
+                        type: 'u64';
+                    },
+                    {
+                        name: 'bump';
+                        type: 'u8';
+                    }
+                ];
+            };
+        },
+        {
+            name: 'validatorBondAccount';
+            type: {
+                kind: 'struct';
+                fields: [
+                    {
+                        name: 'identity';
+                        type: 'pubkey';
+                    },
+                    {
+                        name: 'voteAccount';
+                        type: 'pubkey';
+                    },
+                    {
+                        name: 'creator';
+                        type: 'pubkey';
+                    },
+                    {
+                        name: 'withdrawalAuthority';
+                        type: {
+                            option: 'pubkey';
+                        };
+                    },
+                    {
+                        name: 'totalWithdrawn';
+                        type: 'u64';
+                    },
+                    {
+                        name: 'lastWithdrawalEpoch';
+                        type: 'u64';
+                    },
+                    {
+                        name: 'isActive';
+                        type: 'bool';
+                    },
+                    {
+                        name: 'createdAt';
+                        type: 'i64';
+                    },
+                    {
+                        name: 'bump';
+                        type: 'u8';
+                    }
+                ];
+            };
+        },
+        {
+            name: 'validatorRegistered';
+            type: {
+                kind: 'struct';
+                fields: [
+                    {
+                        name: 'validator';
+                        type: 'pubkey';
+                    },
+                    {
+                        name: 'voteAccount';
+                        type: 'pubkey';
+                    },
+                    {
+                        name: 'collateralAmount';
+                        type: 'u64';
+                    },
+                    {
+                        name: 'timestamp';
+                        type: 'i64';
+                    }
+                ];
+            };
+        }
+    ];
+};
+
+declare class JBondClient {
+    connection: Connection;
+    program: Program<Jbond>;
+    provider: AnchorProvider;
+    config: Config;
+    constructor(config: Config, wallet?: Wallet);
+    /**
+     * Creates an instance of `JBondClient` using a provided connection and wallet.
+     */
+    static fromWallet(config: Config, wallet?: Wallet): JBondClient;
+    /**
+     * Creates an instance of `JBondClient` using the provided connection and keypair.
+     */
+    static fromKeypair(config: Config, keypair: Keypair): JBondClient;
+    getGlobalStatePDA(): [PublicKey, number];
+    getValidatorBondPDA(voteAccount: PublicKey): [PublicKey, number];
+    buildInitializeInstruction(props: InitializeProps): Promise<TransactionInstruction>;
+    buildRegisterValidatorInstruction(props: RegisterValidatorProps): Promise<TransactionInstruction>;
+    buildTopUpCollateralInstruction(props: TopUpCollateralProps): Promise<TransactionInstruction>;
+    buildWithdrawCollateralInstruction(props: WithdrawCollateralProps): Promise<TransactionInstruction>;
+    buildWithdrawCompensationInstruction(props: WithdrawCompensationProps): Promise<TransactionInstruction>;
+    buildWithdrawCompensationsInstructions(authority: PublicKey, withdrawals: Array<{
+        voteAccount: PublicKey;
+        amount: number;
+    }>): Promise<TransactionInstruction[]>;
+    getValidatorBondAccount(voteAccount: PublicKey): Promise<ValidatorBondAccount | null>;
+    /**
+     * Get the collateral balance of a validator bond account
+     * @param voteAccount - The vote account public key
+     * @returns The available collateral balance in SOL (excluding rent-exempt amount)
+     */
+    getValidatorCollateralBalance(voteAccount: PublicKey): Promise<number>;
+    getGlobalState(): Promise<{
+        authority: string;
+        totalValidators: number;
+        totalWithdrawn: number;
+    } | null>;
+    getCurrentEpoch(): Promise<number>;
+    initialize(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>;
+    claimCompensation(voteAccount: PublicKey, amount: number, authority?: PublicKey): Promise<string>;
+    /**
+     * Get transaction history grouped by epochs
+     * @param voteAccount - The vote account to get history for
+     * @param epochsCount - Number of recent epochs to return (default: 10)
+     * @returns Array of epoch history items sorted by epoch (descending)
+     */
+    getHistoryGroupedByEpochs(voteAccount: PublicKey, epochsCount?: number): Promise<EpochHistoryItem[]>;
+    getHistory(voteAccount: PublicKey, options?: {
+        cluster?: 'mainnet-beta' | 'testnet' | 'devnet';
+        limit?: number;
+        before?: string;
+        until?: string;
+    }): Promise<TransactionHistoryItem[]>;
+    getFullHistory(voteAccount: PublicKey, pageSize?: number): Promise<TransactionHistoryItem[]>;
+    private getInstructionDiscriminator;
+}
+
+declare const PROGRAM_ID = "4a3YovKEfm4jWhczCzJciHXL1xVkXWfGQjRCaMft7M4G";
+declare const RESERVE_ADDRESS = "61mS9nEir6jx6cvte6NzQpyrFk3Fj4krMNLuHhi4tjJz";
+
+declare function loadConfig(): Config;
+declare function loadKeypair(keypairPath: string): Keypair;
+
+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 };