aiia-vault-sdk 1.3.3 → 1.4.1

package/dist/Erc20Staking.d.ts

@@ -0,0 +1,367 @@
+import { ethers } from "ethers";
+import { ParsedErc20StakingEvent, ParsedErc20StakingEventRaw, RawErc20StakingEventTypes } from "./types";
+import { type SendTransactionMutateAsync } from "@wagmi/core/query";
+import { Config } from "@wagmi/core/dist/types/createConfig";
+export declare class Erc20StakingSDK {
+    name: string;
+    private contract;
+    private providers;
+    private contractAddress;
+    private tokenContract;
+    private tokenAddress;
+    private tokenDecimals;
+    private isBootstrapped;
+    constructor(rpcUrls: string | string[], contractAddress?: string, tokenAddress?: string);
+    private loadTokenAddress;
+    private getRandomProvider;
+    private getContractWithRandomProvider;
+    bootstrap(): Promise<void>;
+    signAndSendTransaction(tx: ethers.ContractTransaction, wallet: ethers.Wallet | SendTransactionMutateAsync<Config, any>, callbacks?: {
+        onSubmit?: (tx: string) => void | Promise<void>;
+        onFinally?: (status: {
+            status: boolean | null;
+            confirmations: number;
+            txHash: string;
+            isCompleted: boolean;
+            attempts: number;
+        }) => void | Promise<void>;
+        onError?: (error: Error) => void | Promise<void>;
+    }): Promise<{
+        transaction: {
+            hash: string;
+        };
+        status: {
+            status: boolean | null;
+            confirmations: number;
+            isCompleted: boolean;
+            attempts: number;
+        };
+    }>;
+    /**
+     * Get token decimals
+     * @returns Number of token decimals
+     */
+    getTokenDecimals(): number;
+    /**
+     * Get token address
+     * @returns Address of the staking token
+     */
+    getTokenAddress(): Promise<string>;
+    /**
+     * Format token amount from human-readable to raw (with decimals)
+     * @param amount Amount in human-readable format
+     * @returns Amount in raw format with proper decimals
+     */
+    formatTokenAmount(amount: number): Promise<bigint>;
+    /**
+     * Parse token amount from raw to human-readable
+     * @param amount Amount in raw format with decimals
+     * @returns Amount in human-readable format
+     */
+    parseTokenAmount(amount: bigint): number;
+    /**
+     * Get token balance of an address
+     * @param address Address to check balance for
+     * @returns Balance in raw format (with decimals)
+     */
+    getTokenBalanceRaw(address: string): Promise<bigint>;
+    /**
+     * Get token balance of an address in human-readable format
+     * @param address Address to check balance for
+     * @returns Balance in human-readable format
+     */
+    getTokenBalance(address: string): Promise<number>;
+    /**
+     * Get token allowance for the staking contract
+     * @param owner Address of the token owner
+     * @returns Allowance in raw format (with decimals)
+     */
+    getTokenAllowanceRaw(owner: string): Promise<bigint>;
+    /**
+     * Get token allowance for the staking contract in human-readable format
+     * @param owner Address of the token owner
+     * @returns Allowance in human-readable format
+     */
+    getTokenAllowance(owner: string): Promise<number>;
+    /**
+     * Build a transaction to approve token spending
+     * @param amount Amount to approve in human-readable format
+     * @returns Populated transaction
+     */
+    buildApproveTokenTx(amount: number): Promise<ethers.ContractTransaction>;
+    /**
+     * Build a transaction to approve unlimited token spending
+     * @returns Populated transaction
+     */
+    buildApproveUnlimitedTokenTx(): Promise<ethers.ContractTransaction>;
+    /**
+     * Builds a transaction to stake tokens to the contract
+     * @param amount Amount of tokens to stake in raw format (with decimals)
+     * @returns Populated transaction
+     */
+    buildStakeTxRaw(amount: bigint): Promise<ethers.ContractTransaction>;
+    /**
+     * Builds a transaction to stake tokens to the contract
+     * @param amount Amount of tokens to stake in human-readable format
+     * @returns Populated transaction
+     */
+    buildStakeTx(amount: number): Promise<ethers.ContractTransaction>;
+    /**
+     * Builds a transaction to unstake tokens
+     * @param amount Amount to unstake in raw format (with decimals)
+     * @returns Populated transaction
+     */
+    buildUnstakeTxRaw(amount: bigint): Promise<ethers.ContractTransaction>;
+    /**
+     * Builds a transaction to unstake tokens
+     * @param amount Amount to unstake in human-readable format
+     * @returns Populated transaction
+     */
+    buildUnstakeTx(amount: number): Promise<ethers.ContractTransaction>;
+    /**
+     * Builds a transaction to harvest rewards
+     * @param amount Reward amount to harvest in raw format (with decimals)
+     * @param nonce Unique nonce to prevent replay attacks
+     * @param deadline Timestamp after which signature is invalid
+     * @param signature Signature from authorized signer
+     * @returns Populated transaction
+     */
+    buildHarvestRewardTxRaw(amount: bigint, nonce: bigint, deadline: bigint, signature: string): Promise<ethers.ContractTransaction>;
+    /**
+     * Builds a transaction to harvest rewards
+     * @param amount Reward amount to harvest in human-readable format
+     * @param nonce Unique nonce to prevent replay attacks
+     * @param deadline Timestamp after which signature is invalid
+     * @param signature Signature from authorized signer
+     * @returns Populated transaction
+     */
+    buildHarvestRewardTx(amount: number, nonce: number, deadline: number, signature: string): Promise<ethers.ContractTransaction>;
+    /**
+     * Builds a transaction to unstake and harvest in one transaction
+     * @param unstakeAmount Unstake amount in raw format (with decimals)
+     * @param rewardAmount Reward amount in raw format (with decimals)
+     * @param nonce Unique nonce to prevent replay attacks
+     * @param deadline Timestamp after which signature is invalid
+     * @param signature Signature from authorized signer
+     * @returns Populated transaction
+     */
+    buildUnstakeAndHarvestTxRaw(unstakeAmount: bigint, rewardAmount: bigint, nonce: bigint, deadline: bigint, signature: string): Promise<ethers.ContractTransaction>;
+    /**
+     * Builds a transaction to unstake and harvest in one transaction
+     * @param unstakeAmount Unstake amount in human-readable format
+     * @param rewardAmount Reward amount in human-readable format
+     * @param nonce Unique nonce to prevent replay attacks
+     * @param deadline Timestamp after which signature is invalid
+     * @param signature Signature from authorized signer
+     * @returns Populated transaction
+     */
+    buildUnstakeAndHarvestTx(unstakeAmount: number, rewardAmount: number, nonce: number, deadline: number, signature: string): Promise<ethers.ContractTransaction>;
+    /**
+     * Builds a transaction to add rewards to the contract
+     * @param amount Amount to add in raw format (with decimals)
+     * @returns Populated transaction
+     */
+    buildAddRewardsTxRaw(amount: bigint): Promise<ethers.ContractTransaction>;
+    /**
+     * Builds a transaction to add rewards to the contract
+     * @param amount Amount to add in human-readable format
+     * @returns Populated transaction
+     */
+    buildAddRewardsTx(amount: number): Promise<ethers.ContractTransaction>;
+    /**
+     * Builds a transaction to update the maximum reward amount
+     * @param newMaxReward New maximum reward amount in raw format (with decimals)
+     * @returns Populated transaction
+     */
+    buildUpdateMaxRewardAmountTxRaw(newMaxReward: bigint): Promise<ethers.ContractTransaction>;
+    /**
+     * Builds a transaction to update the maximum reward amount
+     * @param newMaxReward New maximum reward amount in human-readable format
+     * @returns Populated transaction
+     */
+    buildUpdateMaxRewardAmountTx(newMaxReward: number): Promise<ethers.ContractTransaction>;
+    /**
+     * Builds a transaction to set the minimum stake amount
+     * @param newMinStake New minimum stake amount in raw format (with decimals)
+     * @returns Populated transaction
+     */
+    buildSetMinStakeAmountTxRaw(newMinStake: bigint): Promise<ethers.ContractTransaction>;
+    /**
+     * Builds a transaction to set the minimum stake amount
+     * @param newMinStake New minimum stake amount in human-readable format
+     * @returns Populated transaction
+     */
+    buildSetMinStakeAmountTx(newMinStake: number): Promise<ethers.ContractTransaction>;
+    /**
+     * Builds a transaction to update the staking token
+     * @param newToken New ERC20 token address
+     * @returns Populated transaction
+     */
+    buildUpdateStakingTokenTx(newToken: string): Promise<ethers.ContractTransaction>;
+    /**
+     * Builds a transaction to add a new signer
+     * @param signer Address of the new signer
+     * @returns Populated transaction
+     */
+    buildAddSignerTx(signer: string): Promise<ethers.ContractTransaction>;
+    /**
+     * Builds a transaction to remove a signer
+     * @param signer Address of the signer to remove
+     * @returns Populated transaction
+     */
+    buildRemoveSignerTx(signer: string): Promise<ethers.ContractTransaction>;
+    /**
+     * Builds a transaction to pause the contract
+     * @returns Populated transaction
+     */
+    buildPauseTx(): Promise<ethers.ContractTransaction>;
+    /**
+     * Builds a transaction to unpause the contract
+     * @returns Populated transaction
+     */
+    buildUnpauseTx(): Promise<ethers.ContractTransaction>;
+    /**
+     * Builds a transaction to emergency withdraw all tokens
+     * @param recipient Address to receive the funds
+     * @returns Populated transaction
+     */
+    buildEmergencyWithdrawTx(recipient: string): Promise<ethers.ContractTransaction>;
+    /**
+     * Gets total staked tokens in the contract in raw format (with decimals)
+     * @returns Total staked amount as bigint
+     */
+    getTotalStakedRaw(): Promise<bigint>;
+    /**
+     * Gets total staked tokens in the contract in human-readable format
+     * @returns Total staked amount as number
+     */
+    getTotalStaked(): Promise<number>;
+    /**
+     * Gets total rewards distributed in raw format (with decimals)
+     * @returns Total rewards as bigint
+     */
+    getTotalRewardsRaw(): Promise<bigint>;
+    /**
+     * Gets total rewards distributed in human-readable format
+     * @returns Total rewards as number
+     */
+    getTotalRewards(): Promise<number>;
+    /**
+     * Gets maximum reward amount allowed in a single harvest in raw format (with decimals)
+     * @returns Maximum reward amount as bigint
+     */
+    getMaxRewardAmountRaw(): Promise<bigint>;
+    /**
+     * Gets maximum reward amount allowed in a single harvest in human-readable format
+     * @returns Maximum reward amount as number
+     */
+    getMaxRewardAmount(): Promise<number>;
+    /**
+     * Gets minimum stake amount in raw format (with decimals)
+     * @returns Minimum stake amount as bigint
+     */
+    getMinStakeAmountRaw(): Promise<bigint>;
+    /**
+     * Gets minimum stake amount in human-readable format
+     * @returns Minimum stake amount as number
+     */
+    getMinStakeAmount(): Promise<number>;
+    /**
+     * Gets user's stake and total harvested rewards in raw format (with decimals)
+     * @param user Address of the user
+     * @returns Object containing stake and harvested rewards as bigint
+     */
+    getUserInfoRaw(user: string): Promise<{
+        stake: bigint;
+        harvested: bigint;
+    }>;
+    /**
+     * Gets user's stake and total harvested rewards in human-readable format
+     * @param user Address of the user
+     * @returns Object containing stake and harvested rewards as number
+     */
+    getUserInfo(user: string): Promise<{
+        stake: number;
+        harvested: number;
+    }>;
+    /**
+     * Gets user's stake in raw format (with decimals)
+     * @param user Address of the user
+     * @returns User's stake as bigint
+     */
+    getUserStakeRaw(user: string): Promise<bigint>;
+    /**
+     * Gets user's stake in human-readable format
+     * @param user Address of the user
+     * @returns User's stake as number
+     */
+    getUserStake(user: string): Promise<number>;
+    /**
+     * Gets user's total rewards harvested in raw format (with decimals)
+     * @param user Address of the user
+     * @returns User's total rewards harvested as bigint
+     */
+    getUserTotalRewardsHarvestedRaw(user: string): Promise<bigint>;
+    /**
+     * Gets user's total rewards harvested in human-readable format
+     * @param user Address of the user
+     * @returns User's total rewards harvested as number
+     */
+    getUserTotalRewardsHarvested(user: string): Promise<number>;
+    /**
+     * Checks if the contract is paused
+     * @returns Boolean indicating if contract is paused
+     */
+    isPaused(): Promise<boolean>;
+    /**
+     * Gets the OPERATOR_ROLE hash
+     * @returns The OPERATOR_ROLE hash
+     */
+    getOperatorRoleHash(): Promise<string>;
+    /**
+     * Gets the SIGNER_ROLE hash
+     * @returns The SIGNER_ROLE hash
+     */
+    getSignerRoleHash(): Promise<string>;
+    /**
+     * Gets the DEFAULT_ADMIN_ROLE hash
+     * @returns The DEFAULT_ADMIN_ROLE hash
+     */
+    getAdminRoleHash(): Promise<string>;
+    /**
+     * Checks if an address has the operator role
+     * @param address Address to check
+     * @returns Boolean indicating if the address has operator role
+     */
+    hasOperatorRole(address: string): Promise<boolean>;
+    /**
+     * Checks if an address has the signer role
+     * @param address Address to check
+     * @returns Boolean indicating if the address has signer role
+     */
+    hasSignerRole(address: string): Promise<boolean>;
+    /**
+     * Checks if an address has the admin role
+     * @param address Address to check
+     * @returns Boolean indicating if the address has admin role
+     */
+    hasAdminRole(address: string): Promise<boolean>;
+    /**
+     * Creates a signature for harvesting rewards
+     * @param contractAddress Address of the Erc20Staking contract
+     * @param userAddress Address of the user harvesting rewards
+     * @param amount Reward amount in human-readable format
+     * @param nonce Unique nonce to prevent replay attacks
+     * @param deadline Timestamp after which signature is invalid
+     * @param signerPrivateKey Private key of the authorized signer
+     * @returns Signature and message hash
+     */
+    createRewardSignature(contractAddress: string, userAddress: string, amount: number, nonce: number, deadline: number, signerPrivateKey: string): Promise<{
+        signature: string;
+        messageHash: string;
+    }>;
+    getContractAddress(): string;
+    getAllEvents(fromBlock: number, toBlock: number, whitelistEvents?: Array<keyof RawErc20StakingEventTypes>): Promise<ParsedErc20StakingEventRaw[]>;
+    streamEvents(fromBlock: number, onEvent: (event: ParsedErc20StakingEvent) => Promise<void>, saveLatestBlock: (blockNumber: number) => Promise<void>, batchSize?: number, sleepTime?: number, blockGap?: number, shouldContinue?: () => Promise<boolean> | boolean): Promise<void>;
+    formatEventArgs: (event: ParsedErc20StakingEventRaw) => ParsedErc20StakingEvent;
+}

package/dist/Erc20Staking.js

@@ -0,0 +1 @@
+"use strict";var t=this&&this.__importDefault||function(t){return t&&t.__esModule?t:{default:t}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.Erc20StakingSDK=void 0;const e=require("ethers"),a=t(require("./abis/Erc20Staking.json")),s=t(require("./contracts.json")),n=require("./utils");exports.Erc20StakingSDK=class{constructor(t,r,o){this.name="Erc20Staking",this.tokenAddress=e.ethers.ZeroAddress,this.tokenDecimals=18,this.isBootstrapped=!1,this.formatEventArgs=t=>{const{eventName:e,args:a}=t;switch(e){case"Staked":case"Unstaked":return{...t,args:{...a,user:a.user.toLowerCase(),amount:this.parseTokenAmount(a.amount),timestamp:Number(a.timestamp)}};case"RewardHarvested":return{...t,args:{...a,user:a.user.toLowerCase(),amount:this.parseTokenAmount(a.amount),timestamp:Number(a.timestamp),signatureHash:a.signatureHash}};case"SignerUpdated":return{...t,args:{...a,newSigner:a.newSigner.toLowerCase()}};case"MinStakeUpdated":return{...t,args:{...a,oldAmount:this.parseTokenAmount(a.oldAmount),newAmount:this.parseTokenAmount(a.newAmount)}};case"TokenUpdated":return{...t,args:{...a,newToken:a.newToken.toLowerCase()}};default:return t}};const i=Array.isArray(t)?t:[t];this.providers=i.map((t=>new e.ethers.JsonRpcProvider(t,void 0,{staticNetwork:!0})));const d=(0,n.getRandomProvider)(this.providers);this.contractAddress=(0,n.resolveContractAddress)(i[0],this.name,s.default,r),this.contract=new e.ethers.Contract(this.contractAddress,a.default.abi,d),o?this.tokenAddress=o:this.loadTokenAddress()}async loadTokenAddress(){try{this.tokenAddress=await this.contract.stakingToken(),this.tokenContract=new e.ethers.Contract(this.tokenAddress,["function decimals() view returns (uint8)","function symbol() view returns (string)","function balanceOf(address owner) view returns (uint256)","function allowance(address owner, address spender) view returns (uint256)","function approve(address spender, uint256 amount) returns (bool)"],this.getRandomProvider());try{this.tokenDecimals=await this.tokenContract.decimals()}catch(t){console.warn("Could not load token decimals, defaulting to 18")}}catch(t){console.error("Could not load token address from contract")}}getRandomProvider(){return(0,n.getRandomProvider)(this.providers)}getContractWithRandomProvider(){return new e.ethers.Contract(this.contractAddress,a.default.abi,this.getRandomProvider())}async bootstrap(){if(this.isBootstrapped)return;const t=await Promise.all(this.providers.map(((t,e)=>(0,n.checkRpcHealth)(t,e))));if(this.providers=this.providers.filter(((e,a)=>t[a])),0===this.providers.length)throw new Error("No active RPC providers available");this.tokenAddress===e.ethers.ZeroAddress&&await this.loadTokenAddress(),this.isBootstrapped=!0}async signAndSendTransaction(t,e,a={}){return(0,n.signAndSendTransaction)(t,e,(()=>this.getRandomProvider()),a,this.contract)}getTokenDecimals(){return this.tokenAddress&&this.tokenAddress!==e.ethers.ZeroAddress||this.loadTokenAddress(),this.tokenDecimals}async getTokenAddress(){return this.tokenAddress&&this.tokenAddress!==e.ethers.ZeroAddress||await this.loadTokenAddress(),this.tokenAddress}async formatTokenAmount(t){const a=await this.getTokenDecimals();return e.ethers.parseUnits(t.toString(),a)}parseTokenAmount(t){const a=this.getTokenDecimals();return Number(e.ethers.formatUnits(t,a))}async getTokenBalanceRaw(t){return this.tokenAddress&&this.tokenAddress!==e.ethers.ZeroAddress||await this.loadTokenAddress(),await this.tokenContract.balanceOf(t)}async getTokenBalance(t){const e=await this.getTokenBalanceRaw(t);return this.parseTokenAmount(e)}async getTokenAllowanceRaw(t){return this.tokenAddress&&this.tokenAddress!==e.ethers.ZeroAddress||await this.loadTokenAddress(),await this.tokenContract.allowance(t,this.contractAddress)}async getTokenAllowance(t){const e=await this.getTokenAllowanceRaw(t);return this.parseTokenAmount(e)}async buildApproveTokenTx(t){const e=await this.formatTokenAmount(t);return(0,n.buildApproveERC20Tx)(this.tokenAddress,this.contractAddress,e,this.getRandomProvider())}async buildApproveUnlimitedTokenTx(){return await this.buildApproveTokenTx(1e6)}async buildStakeTxRaw(t){return await this.contract.stake.populateTransaction(t)}async buildStakeTx(t){const e=await this.formatTokenAmount(t);return await this.buildStakeTxRaw(e)}async buildUnstakeTxRaw(t){return await this.contract.unstake.populateTransaction(t)}async buildUnstakeTx(t){const e=await this.formatTokenAmount(t);return await this.buildUnstakeTxRaw(e)}async buildHarvestRewardTxRaw(t,e,a,s){return await this.contract.harvestReward.populateTransaction(t,e,a,s)}async buildHarvestRewardTx(t,e,a,s){const n=await this.formatTokenAmount(t);return await this.buildHarvestRewardTxRaw(n,BigInt(e),BigInt(a),s)}async buildUnstakeAndHarvestTxRaw(t,e,a,s,n){return await this.contract.unstakeAndHarvest.populateTransaction(t,e,a,s,n)}async buildUnstakeAndHarvestTx(t,e,a,s,n){const r=await this.formatTokenAmount(t),o=await this.formatTokenAmount(e);return await this.buildUnstakeAndHarvestTxRaw(r,o,BigInt(a),BigInt(s),n)}async buildAddRewardsTxRaw(t){return await this.contract.addRewards.populateTransaction(t)}async buildAddRewardsTx(t){const e=await this.formatTokenAmount(t);return await this.buildAddRewardsTxRaw(e)}async buildUpdateMaxRewardAmountTxRaw(t){return await this.contract.updateMaxRewardAmount.populateTransaction(t)}async buildUpdateMaxRewardAmountTx(t){const e=await this.formatTokenAmount(t);return await this.buildUpdateMaxRewardAmountTxRaw(e)}async buildSetMinStakeAmountTxRaw(t){return await this.contract.setMinStakeAmount.populateTransaction(t)}async buildSetMinStakeAmountTx(t){const e=await this.formatTokenAmount(t);return await this.buildSetMinStakeAmountTxRaw(e)}async buildUpdateStakingTokenTx(t){return await this.contract.updateStakingToken.populateTransaction(t)}async buildAddSignerTx(t){return await this.contract.addSigner.populateTransaction(t)}async buildRemoveSignerTx(t){return await this.contract.removeSigner.populateTransaction(t)}async buildPauseTx(){return await this.contract.pause.populateTransaction()}async buildUnpauseTx(){return await this.contract.unpause.populateTransaction()}async buildEmergencyWithdrawTx(t){return await this.contract.emergencyWithdraw.populateTransaction(t)}async getTotalStakedRaw(){return await this.contract.totalStaked()}async getTotalStaked(){const t=await this.getTotalStakedRaw();return this.parseTokenAmount(t)}async getTotalRewardsRaw(){return await this.contract.totalRewards()}async getTotalRewards(){const t=await this.getTotalRewardsRaw();return this.parseTokenAmount(t)}async getMaxRewardAmountRaw(){return await this.contract.maxRewardAmount()}async getMaxRewardAmount(){const t=await this.getMaxRewardAmountRaw();return this.parseTokenAmount(t)}async getMinStakeAmountRaw(){return await this.contract.minStakeAmount()}async getMinStakeAmount(){const t=await this.getMinStakeAmountRaw();return this.parseTokenAmount(t)}async getUserInfoRaw(t){const[e,a]=await this.contract.getUserInfo(t);return{stake:e,harvested:a}}async getUserInfo(t){const{stake:e,harvested:a}=await this.getUserInfoRaw(t);return{stake:await this.parseTokenAmount(e),harvested:await this.parseTokenAmount(a)}}async getUserStakeRaw(t){return await this.contract.userStakes(t)}async getUserStake(t){const e=await this.getUserStakeRaw(t);return this.parseTokenAmount(e)}async getUserTotalRewardsHarvestedRaw(t){return await this.contract.userTotalRewardsHarvested(t)}async getUserTotalRewardsHarvested(t){const e=await this.getUserTotalRewardsHarvestedRaw(t);return this.parseTokenAmount(e)}async isPaused(){return await this.contract.paused()}async getOperatorRoleHash(){return await this.contract.OPERATOR_ROLE()}async getSignerRoleHash(){return await this.contract.SIGNER_ROLE()}async getAdminRoleHash(){return await this.contract.DEFAULT_ADMIN_ROLE()}async hasOperatorRole(t){const e=await this.contract.OPERATOR_ROLE();return await this.contract.hasRole(e,t)}async hasSignerRole(t){const e=await this.contract.SIGNER_ROLE();return await this.contract.hasRole(e,t)}async hasAdminRole(t){const e=await this.contract.DEFAULT_ADMIN_ROLE();return await this.contract.hasRole(e,t)}async createRewardSignature(t,a,s,n,r,o){const i=await this.formatTokenAmount(s),d=e.ethers.solidityPackedKeccak256(["address","address","uint256","uint256","uint256"],[t,a,i,n,r]),c=new e.ethers.Wallet(o);return{signature:await c.signMessage(e.ethers.getBytes(d)),messageHash:d.toString()}}getContractAddress(){return this.contractAddress}async getAllEvents(t,e,a){return await this.bootstrap(),(0,n.getAllEvents)(this.contract,(()=>this.getRandomProvider()),(()=>this.getContractWithRandomProvider()),t,e,a)}async streamEvents(t,e,a,s=1e3,r=5e3,o=0,i){const d=["Staked","Unstaked","RewardHarvested"];return await this.bootstrap(),(0,n.streamEvents)({getProvider:()=>this.getRandomProvider(),getAllEvents:(t,e)=>this.getAllEvents(t,e,d),formatEvent:t=>this.formatEventArgs(t),onEvent:e,saveLatestBlock:a,fromBlock:t,batchSize:s,sleepTime:r,blockGap:o,shouldContinue:i})}};

package/dist/EthStaking.d.ts

@@ -295,6 +295,6 @@ export declare class EthStakingSDK {
     }>;
     getContractAddress(): string;
     getAllEvents(fromBlock: number, toBlock: number, whitelistEvents?: Array<keyof RawEthStakingEventTypes>): Promise<ParsedEthStakingEventRaw[]>;
-    streamEvents(fromBlock: number, onEvent: (event: ParsedEthStakingEvent) => Promise<void>, saveLatestBlock: (blockNumber: number) => Promise<void>, batchSize?: number, sleepTime?: number, blockGap?: number): Promise<void>;
+    streamEvents(fromBlock: number, onEvent: (event: ParsedEthStakingEvent) => Promise<void>, saveLatestBlock: (blockNumber: number) => Promise<void>, batchSize?: number, sleepTime?: number, blockGap?: number, shouldContinue?: () => Promise<boolean> | boolean): Promise<void>;
     formatEventArgs: (event: ParsedEthStakingEventRaw) => ParsedEthStakingEvent;
 }

package/dist/EthStaking.js

@@ -1 +1 @@
-"use strict";var t=this&&this.__importDefault||function(t){return t&&t.__esModule?t:{default:t}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.EthStakingSDK=void 0;const e=require("ethers"),a=t(require("./abis/EthStaking.json")),r=t(require("./contracts.json")),s=require("./utils");exports.EthStakingSDK=class{constructor(t,n){this.name="EthStaking",this.isBootstrapped=!1,this.formatEventArgs=t=>{const{eventName:a,args:r}=t;switch(a){case"Staked":case"Unstaked":return{...t,args:{...r,user:r.user.toLowerCase(),amount:Number(e.ethers.formatEther(r.amount)),timestamp:Number(r.timestamp)}};case"RewardHarvested":return{...t,args:{...r,user:r.user.toLowerCase(),amount:Number(e.ethers.formatEther(r.amount)),timestamp:Number(r.timestamp),signatureHash:r.signatureHash}};case"SignerUpdated":return{...t,args:{...r,newSigner:r.newSigner.toLowerCase()}};case"MinStakeUpdated":return{...t,args:{...r,oldAmount:Number(e.ethers.formatEther(r.oldAmount)),newAmount:Number(e.ethers.formatEther(r.newAmount))}};default:return t}};const i=Array.isArray(t)?t:[t];this.providers=i.map((t=>new e.ethers.JsonRpcProvider(t,void 0,{staticNetwork:!0})));const o=(0,s.getRandomProvider)(this.providers);this.contractAddress=(0,s.resolveContractAddress)(i[0],this.name,r.default,n),this.contract=new e.ethers.Contract(this.contractAddress,a.default.abi,o)}getRandomProvider(){return(0,s.getRandomProvider)(this.providers)}getContractWithRandomProvider(){return new e.ethers.Contract(this.contractAddress,a.default.abi,this.getRandomProvider())}async bootstrap(){if(this.isBootstrapped)return;const t=await Promise.all(this.providers.map(((t,e)=>(0,s.checkRpcHealth)(t,e))));if(this.providers=this.providers.filter(((e,a)=>t[a])),0===this.providers.length)throw new Error("No active RPC providers available");this.isBootstrapped=!0}async signAndSendTransaction(t,e,a={}){return(0,s.signAndSendTransaction)(t,e,(()=>this.getRandomProvider()),a,this.contract)}async buildStakeTxRaw(t){return await this.contract.stake.populateTransaction({value:t})}async buildStakeTx(t){return await this.buildStakeTxRaw(e.ethers.parseEther(t.toString()))}async buildUnstakeTxRaw(t){return await this.contract.unstake.populateTransaction(t)}async buildUnstakeTx(t){return await this.buildUnstakeTxRaw(e.ethers.parseEther(t.toString()))}async buildHarvestRewardTxRaw(t,e,a,r){return await this.contract.harvestReward.populateTransaction(t,e,a,r)}async buildHarvestRewardTx(t,a,r,s){return await this.buildHarvestRewardTxRaw(e.ethers.parseEther(t.toString()),BigInt(a),BigInt(r),s)}async buildUnstakeAndHarvestTxRaw(t,e,a,r,s){return await this.contract.unstakeAndHarvest.populateTransaction(t,e,a,r,s)}async buildUnstakeAndHarvestTx(t,a,r,s,n){return await this.buildUnstakeAndHarvestTxRaw(e.ethers.parseEther(t.toString()),e.ethers.parseEther(a.toString()),BigInt(r),BigInt(s),n)}async buildAddRewardsTxRaw(t){return await this.contract.addRewards.populateTransaction({value:t})}async buildAddRewardsTx(t){return await this.buildAddRewardsTxRaw(e.ethers.parseEther(t.toString()))}async buildUpdateMaxRewardAmountTxRaw(t){return await this.contract.updateMaxRewardAmount.populateTransaction(t)}async buildUpdateMaxRewardAmountTx(t){return await this.buildUpdateMaxRewardAmountTxRaw(e.ethers.parseEther(t.toString()))}async buildSetMinStakeAmountTxRaw(t){return await this.contract.setMinStakeAmount.populateTransaction(t)}async buildSetMinStakeAmountTx(t){return await this.buildSetMinStakeAmountTxRaw(e.ethers.parseEther(t.toString()))}async buildAddSignerTx(t){return await this.contract.addSigner.populateTransaction(t)}async buildRemoveSignerTx(t){return await this.contract.removeSigner.populateTransaction(t)}async buildPauseTx(){return await this.contract.pause.populateTransaction()}async buildUnpauseTx(){return await this.contract.unpause.populateTransaction()}async buildEmergencyUnstakeTx(t){return await this.contract.emergencyUnstake.populateTransaction(t)}async getTotalStakedRaw(){return await this.contract.totalStaked()}async getTotalStaked(){const t=await this.getTotalStakedRaw();return Number(e.ethers.formatEther(t))}async getTotalRewardsRaw(){return await this.contract.totalRewards()}async getTotalRewards(){const t=await this.getTotalRewardsRaw();return Number(e.ethers.formatEther(t))}async getMaxRewardAmountRaw(){return await this.contract.maxRewardAmount()}async getMaxRewardAmount(){const t=await this.getMaxRewardAmountRaw();return Number(e.ethers.formatEther(t))}async getMinStakeAmountRaw(){return await this.contract.minStakeAmount()}async getMinStakeAmount(){const t=await this.getMinStakeAmountRaw();return Number(e.ethers.formatEther(t))}async getUserInfoRaw(t){const[e,a]=await this.contract.getUserInfo(t);return{stake:e,harvested:a}}async getUserInfo(t){const{stake:a,harvested:r}=await this.getUserInfoRaw(t);return{stake:Number(e.ethers.formatEther(a)),harvested:Number(e.ethers.formatEther(r))}}async getUserStakeRaw(t){return await this.contract.userStakes(t)}async getUserStake(t){const a=await this.getUserStakeRaw(t);return Number(e.ethers.formatEther(a))}async getUserTotalRewardsHarvestedRaw(t){return await this.contract.userTotalRewardsHarvested(t)}async getUserTotalRewardsHarvested(t){const a=await this.getUserTotalRewardsHarvestedRaw(t);return Number(e.ethers.formatEther(a))}async isPaused(){return await this.contract.paused()}async getOperatorRoleHash(){return await this.contract.OPERATOR_ROLE()}async getSignerRoleHash(){return await this.contract.SIGNER_ROLE()}async getAdminRoleHash(){return await this.contract.DEFAULT_ADMIN_ROLE()}async hasOperatorRole(t){const e=await this.contract.OPERATOR_ROLE();return await this.contract.hasRole(e,t)}async hasSignerRole(t){const e=await this.contract.SIGNER_ROLE();return await this.contract.hasRole(e,t)}async hasAdminRole(t){const e=await this.contract.DEFAULT_ADMIN_ROLE();return await this.contract.hasRole(e,t)}async createRewardSignature(t,a,r,s,n,i){const o=e.ethers.parseEther(r.toString()),c=e.ethers.solidityPackedKeccak256(["address","address","uint256","uint256","uint256"],[t,a,o,s,n]),u=new e.ethers.Wallet(i);return{signature:await u.signMessage(e.ethers.getBytes(c)),messageHash:c.toString()}}getContractAddress(){return this.contractAddress}async getAllEvents(t,e,a){return await this.bootstrap(),(0,s.getAllEvents)(this.contract,(()=>this.getRandomProvider()),(()=>this.getContractWithRandomProvider()),t,e,a)}async streamEvents(t,e,a,r=1e3,n=5e3,i=0){const o=["Staked","Unstaked","RewardHarvested","SignerUpdated","MinStakeUpdated"];return await this.bootstrap(),(0,s.streamEvents)({getProvider:()=>this.getRandomProvider(),getAllEvents:(t,e)=>this.getAllEvents(t,e,o),formatEvent:t=>this.formatEventArgs(t),onEvent:e,saveLatestBlock:a,fromBlock:t,batchSize:r,sleepTime:n,blockGap:i})}};
+"use strict";var t=this&&this.__importDefault||function(t){return t&&t.__esModule?t:{default:t}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.EthStakingSDK=void 0;const e=require("ethers"),a=t(require("./abis/EthStaking.json")),r=t(require("./contracts.json")),s=require("./utils");exports.EthStakingSDK=class{constructor(t,n){this.name="EthStaking",this.isBootstrapped=!1,this.formatEventArgs=t=>{const{eventName:a,args:r}=t;switch(a){case"Staked":case"Unstaked":return{...t,args:{...r,user:r.user.toLowerCase(),amount:Number(e.ethers.formatEther(r.amount)),timestamp:Number(r.timestamp)}};case"RewardHarvested":return{...t,args:{...r,user:r.user.toLowerCase(),amount:Number(e.ethers.formatEther(r.amount)),timestamp:Number(r.timestamp),signatureHash:r.signatureHash}};case"SignerUpdated":return{...t,args:{...r,newSigner:r.newSigner.toLowerCase()}};case"MinStakeUpdated":return{...t,args:{...r,oldAmount:Number(e.ethers.formatEther(r.oldAmount)),newAmount:Number(e.ethers.formatEther(r.newAmount))}};default:return t}};const i=Array.isArray(t)?t:[t];this.providers=i.map((t=>new e.ethers.JsonRpcProvider(t,void 0,{staticNetwork:!0})));const o=(0,s.getRandomProvider)(this.providers);this.contractAddress=(0,s.resolveContractAddress)(i[0],this.name,r.default,n),this.contract=new e.ethers.Contract(this.contractAddress,a.default.abi,o)}getRandomProvider(){return(0,s.getRandomProvider)(this.providers)}getContractWithRandomProvider(){return new e.ethers.Contract(this.contractAddress,a.default.abi,this.getRandomProvider())}async bootstrap(){if(this.isBootstrapped)return;const t=await Promise.all(this.providers.map(((t,e)=>(0,s.checkRpcHealth)(t,e))));if(this.providers=this.providers.filter(((e,a)=>t[a])),0===this.providers.length)throw new Error("No active RPC providers available");this.isBootstrapped=!0}async signAndSendTransaction(t,e,a={}){return(0,s.signAndSendTransaction)(t,e,(()=>this.getRandomProvider()),a,this.contract)}async buildStakeTxRaw(t){return await this.contract.stake.populateTransaction({value:t})}async buildStakeTx(t){return await this.buildStakeTxRaw(e.ethers.parseEther(t.toString()))}async buildUnstakeTxRaw(t){return await this.contract.unstake.populateTransaction(t)}async buildUnstakeTx(t){return await this.buildUnstakeTxRaw(e.ethers.parseEther(t.toString()))}async buildHarvestRewardTxRaw(t,e,a,r){return await this.contract.harvestReward.populateTransaction(t,e,a,r)}async buildHarvestRewardTx(t,a,r,s){return await this.buildHarvestRewardTxRaw(e.ethers.parseEther(t.toString()),BigInt(a),BigInt(r),s)}async buildUnstakeAndHarvestTxRaw(t,e,a,r,s){return await this.contract.unstakeAndHarvest.populateTransaction(t,e,a,r,s)}async buildUnstakeAndHarvestTx(t,a,r,s,n){return await this.buildUnstakeAndHarvestTxRaw(e.ethers.parseEther(t.toString()),e.ethers.parseEther(a.toString()),BigInt(r),BigInt(s),n)}async buildAddRewardsTxRaw(t){return await this.contract.addRewards.populateTransaction({value:t})}async buildAddRewardsTx(t){return await this.buildAddRewardsTxRaw(e.ethers.parseEther(t.toString()))}async buildUpdateMaxRewardAmountTxRaw(t){return await this.contract.updateMaxRewardAmount.populateTransaction(t)}async buildUpdateMaxRewardAmountTx(t){return await this.buildUpdateMaxRewardAmountTxRaw(e.ethers.parseEther(t.toString()))}async buildSetMinStakeAmountTxRaw(t){return await this.contract.setMinStakeAmount.populateTransaction(t)}async buildSetMinStakeAmountTx(t){return await this.buildSetMinStakeAmountTxRaw(e.ethers.parseEther(t.toString()))}async buildAddSignerTx(t){return await this.contract.addSigner.populateTransaction(t)}async buildRemoveSignerTx(t){return await this.contract.removeSigner.populateTransaction(t)}async buildPauseTx(){return await this.contract.pause.populateTransaction()}async buildUnpauseTx(){return await this.contract.unpause.populateTransaction()}async buildEmergencyUnstakeTx(t){return await this.contract.emergencyUnstake.populateTransaction(t)}async getTotalStakedRaw(){return await this.contract.totalStaked()}async getTotalStaked(){const t=await this.getTotalStakedRaw();return Number(e.ethers.formatEther(t))}async getTotalRewardsRaw(){return await this.contract.totalRewards()}async getTotalRewards(){const t=await this.getTotalRewardsRaw();return Number(e.ethers.formatEther(t))}async getMaxRewardAmountRaw(){return await this.contract.maxRewardAmount()}async getMaxRewardAmount(){const t=await this.getMaxRewardAmountRaw();return Number(e.ethers.formatEther(t))}async getMinStakeAmountRaw(){return await this.contract.minStakeAmount()}async getMinStakeAmount(){const t=await this.getMinStakeAmountRaw();return Number(e.ethers.formatEther(t))}async getUserInfoRaw(t){const[e,a]=await this.contract.getUserInfo(t);return{stake:e,harvested:a}}async getUserInfo(t){const{stake:a,harvested:r}=await this.getUserInfoRaw(t);return{stake:Number(e.ethers.formatEther(a)),harvested:Number(e.ethers.formatEther(r))}}async getUserStakeRaw(t){return await this.contract.userStakes(t)}async getUserStake(t){const a=await this.getUserStakeRaw(t);return Number(e.ethers.formatEther(a))}async getUserTotalRewardsHarvestedRaw(t){return await this.contract.userTotalRewardsHarvested(t)}async getUserTotalRewardsHarvested(t){const a=await this.getUserTotalRewardsHarvestedRaw(t);return Number(e.ethers.formatEther(a))}async isPaused(){return await this.contract.paused()}async getOperatorRoleHash(){return await this.contract.OPERATOR_ROLE()}async getSignerRoleHash(){return await this.contract.SIGNER_ROLE()}async getAdminRoleHash(){return await this.contract.DEFAULT_ADMIN_ROLE()}async hasOperatorRole(t){const e=await this.contract.OPERATOR_ROLE();return await this.contract.hasRole(e,t)}async hasSignerRole(t){const e=await this.contract.SIGNER_ROLE();return await this.contract.hasRole(e,t)}async hasAdminRole(t){const e=await this.contract.DEFAULT_ADMIN_ROLE();return await this.contract.hasRole(e,t)}async createRewardSignature(t,a,r,s,n,i){const o=e.ethers.parseEther(r.toString()),c=e.ethers.solidityPackedKeccak256(["address","address","uint256","uint256","uint256"],[t,a,o,s,n]),u=new e.ethers.Wallet(i);return{signature:await u.signMessage(e.ethers.getBytes(c)),messageHash:c.toString()}}getContractAddress(){return this.contractAddress}async getAllEvents(t,e,a){return await this.bootstrap(),(0,s.getAllEvents)(this.contract,(()=>this.getRandomProvider()),(()=>this.getContractWithRandomProvider()),t,e,a)}async streamEvents(t,e,a,r=1e3,n=5e3,i=0,o){const c=["Staked","Unstaked","RewardHarvested","SignerUpdated","MinStakeUpdated"];return await this.bootstrap(),(0,s.streamEvents)({getProvider:()=>this.getRandomProvider(),getAllEvents:(t,e)=>this.getAllEvents(t,e,c),formatEvent:t=>this.formatEventArgs(t),onEvent:e,saveLatestBlock:a,fromBlock:t,batchSize:r,sleepTime:n,blockGap:i,shouldContinue:o})}};