@pufferfinance/puffer-sdk 1.5.1 → 1.5.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (26) hide show
  1. package/dist/contracts/abis/l1-reward-manager-abis.cjs +1 -1
  2. package/dist/contracts/abis/l1-reward-manager-abis.cjs.map +1 -1
  3. package/dist/contracts/abis/l1-reward-manager-abis.js +6 -5
  4. package/dist/contracts/abis/l1-reward-manager-abis.js.map +1 -1
  5. package/dist/contracts/abis/l2-reward-manager-abis.cjs +1 -1
  6. package/dist/contracts/abis/l2-reward-manager-abis.cjs.map +1 -1
  7. package/dist/contracts/abis/l2-reward-manager-abis.d.ts +500 -476
  8. package/dist/contracts/abis/l2-reward-manager-abis.js +7 -5
  9. package/dist/contracts/abis/l2-reward-manager-abis.js.map +1 -1
  10. package/dist/contracts/abis/mainnet/L2RewardManager.cjs +1 -1
  11. package/dist/contracts/abis/mainnet/L2RewardManager.cjs.map +1 -1
  12. package/dist/contracts/abis/mainnet/L2RewardManager.d.ts +500 -476
  13. package/dist/contracts/abis/mainnet/L2RewardManager.js +404 -358
  14. package/dist/contracts/abis/mainnet/L2RewardManager.js.map +1 -1
  15. package/dist/contracts/addresses.cjs +1 -1
  16. package/dist/contracts/addresses.cjs.map +1 -1
  17. package/dist/contracts/addresses.d.ts +0 -21
  18. package/dist/contracts/addresses.js +7 -9
  19. package/dist/contracts/addresses.js.map +1 -1
  20. package/dist/contracts/handlers/l2-reward-manager-handler.cjs.map +1 -1
  21. package/dist/contracts/handlers/l2-reward-manager-handler.d.ts +495 -468
  22. package/dist/contracts/handlers/l2-reward-manager-handler.js +2 -0
  23. package/dist/contracts/handlers/l2-reward-manager-handler.js.map +1 -1
  24. package/dist/utils/version.cjs +1 -1
  25. package/dist/utils/version.js +1 -1
  26. package/package.json +1 -1
@@ -107,6 +107,8 @@ class f {
107
107
  * @param claimOrders[].amount Amount of the claim order.
108
108
  * @param claimOrders[].intervalId Interval ID of the claim order. See
109
109
  * `getIntervalId`.
110
+ * @param claimOrders[].isL1Contract Whether the claim order is for an
111
+ * L1 contract.
110
112
  * @param claimOrders[].merkleProof Merkle proof of the claim order.
111
113
  * @returns `transact: () => Promise<Address>` - Used to make the
112
114
  * transaction.
@@ -1 +1 @@
1
- {"version":3,"file":"l2-reward-manager-handler.js","sources":["../../../lib/contracts/handlers/l2-reward-manager-handler.ts"],"sourcesContent":["import {\n Address,\n WalletClient,\n PublicClient,\n getContract,\n GetContractReturnType,\n} from 'viem';\nimport { ViemChain, VIEM_CHAINS, Chain } from '../../chains/constants';\nimport { CONTRACT_ADDRESSES } from '../addresses';\nimport { L2_REWARD_MANAGER_ABIS } from '../abis/l2-reward-manager-abis';\nimport { InvalidInputError } from '../../errors/validation-errors';\n\nexport type ClaimOrder = {\n account: Address;\n amount: bigint;\n intervalId: Address;\n merkleProof: Address[];\n};\n\n/**\n * Handler for the `L2RewardManager` contract.\n */\nexport class L2RewardManagerHandler {\n private viemChain: ViemChain;\n\n /**\n * Create the handler for the `L2RewardManager` contract exposing\n * methods to interact with the contract.\n *\n * @param chain Chain to use for the client.\n * @param walletClient The wallet client to use for wallet\n * interactions.\n * @param publicClient The public client to use for public\n * interactions.\n */\n constructor(\n private chain: Chain,\n private walletClient: WalletClient,\n private publicClient: PublicClient,\n ) {\n this.viemChain = VIEM_CHAINS[chain];\n }\n\n /**\n * Get the contract. This is a method because the typings are complex\n * and lost when trying to make it a member.\n *\n * @returns The viem contract.\n */\n public getContract() {\n const address = CONTRACT_ADDRESSES[this.chain].L2RewardManager as Address;\n const abi = L2_REWARD_MANAGER_ABIS[this.chain].L2RewardManager;\n const client = { public: this.publicClient, wallet: this.walletClient };\n\n return getContract({ address, abi, client }) as GetContractReturnType<\n typeof abi,\n typeof client,\n Address\n >;\n }\n\n /**\n * Get the authority address.\n *\n * @returns The authority address.\n */\n public authority() {\n return this.getContract().read.authority();\n }\n\n /**\n * Get the claiming delay.\n *\n * @returns The claiming delay.\n */\n public getClaimingDelay() {\n return this.getContract().read.getClaimingDelay();\n }\n\n /**\n * Get the epoch record for a specific period.\n *\n * @param intervalId The interval ID for a given start and end epoch.\n * See `getInternvalId`.\n * @returns The epoch record of exchange rate and reward root.\n */\n public getEpochRecord(intervalId: Address) {\n return this.getContract().read.getEpochRecord([intervalId]);\n }\n\n /**\n * Returns the interval ID for a given start and end epoch.\n *\n * @param startEpoch Start epoch of the interval.\n * @param endEpoch End epoch of the interval.\n * @returns Interval ID for the given start and end epoch.\n */\n public getIntervalId(startEpoch: bigint, endEpoch: bigint) {\n return this.getContract().read.getIntervalId([startEpoch, endEpoch]);\n }\n\n /**\n * Get the rewards claimer for a specific `account`.\n *\n * @param account Account for which to get the rewards claimer.\n * @returns Rewards claimer address.\n */\n public getRewardsClaimer(account: Address) {\n return this.getContract().read.getRewardsClaimer([account]);\n }\n\n /**\n * Check if the reward has been claimed for an account and a specific\n * interval.\n *\n * @param account The address of the account to check.\n * @param intervalId The claiming interval ID. See `getIntervalId`.\n * @returns Whether the reward has been claimed.\n */\n public isClaimed(account: Address, intervalId: Address) {\n return this.getContract().read.isClaimed([intervalId, account]);\n }\n\n /**\n * Check whether the claiming is locked for the given interval.\n *\n * @param intervalId The interval to check the claiming lock for. See\n * `getIntervalId`.\n * @returns Whether the claiming is locked for the given interval.\n */\n public isClaimingLocked(intervalId: Address) {\n return this.getContract().read.isClaimingLocked([intervalId]);\n }\n\n /**\n * Claims the rewards for a specific epoch range based on the\n * `ClaimOrder`.\n *\n * @param account The account using which to claim the rewards.\n * @param claimOrders One or more claim orders.\n * @param claimOrders[].account Account of the claim order.\n * @param claimOrders[].amount Amount of the claim order.\n * @param claimOrders[].intervalId Interval ID of the claim order. See\n * `getIntervalId`.\n * @param claimOrders[].merkleProof Merkle proof of the claim order.\n * @returns `transact: () => Promise<Address>` - Used to make the\n * transaction.\n *\n * `estimate: () => Promise<bigint>` - Gas estimate of the\n * transaction.\n * @throws {InvalidInputError} If `claimOrders` is empty.\n */\n public claimRewards(account: Address, claimOrders: ClaimOrder[]) {\n if (claimOrders.length === 0) {\n throw new InvalidInputError(\n '`claimOrders` cannot be empty and must be specified',\n {\n fixMessage:\n 'Specify at least one or more claim orders to claim rewards',\n },\n );\n }\n\n const transact = () =>\n this.getContract().write.claimRewards([claimOrders], {\n chain: this.viemChain,\n account,\n });\n const estimate = () =>\n this.getContract().estimateGas.claimRewards([claimOrders], {\n account,\n });\n\n return { transact, estimate };\n }\n}\n"],"names":["L2RewardManagerHandler","chain","walletClient","publicClient","__publicField","VIEM_CHAINS","address","CONTRACT_ADDRESSES","abi","L2_REWARD_MANAGER_ABIS","client","getContract","intervalId","startEpoch","endEpoch","account","claimOrders","InvalidInputError"],"mappings":";;;;;;;;AAsBO,MAAMA,EAAuB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAalC,YACUC,GACAC,GACAC,GACR;AAhBM,IAAAC,EAAA;AAaE,SAAA,QAAAH,GACA,KAAA,eAAAC,GACA,KAAA,eAAAC,GAEH,KAAA,YAAYE,EAAYJ,CAAK;AAAA,EACpC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQO,cAAc;AACnB,UAAMK,IAAUC,EAAmB,KAAK,KAAK,EAAE,iBACzCC,IAAMC,EAAuB,KAAK,KAAK,EAAE,iBACzCC,IAAS,EAAE,QAAQ,KAAK,cAAc,QAAQ,KAAK;AAEzD,WAAOC,EAAY,EAAE,SAAAL,GAAS,KAAAE,GAAK,QAAAE,EAAQ,CAAA;AAAA,EAK7C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,YAAY;AACjB,WAAO,KAAK,YAAA,EAAc,KAAK,UAAU;AAAA,EAC3C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,mBAAmB;AACxB,WAAO,KAAK,YAAA,EAAc,KAAK,iBAAiB;AAAA,EAClD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASO,eAAeE,GAAqB;AACzC,WAAO,KAAK,cAAc,KAAK,eAAe,CAACA,CAAU,CAAC;AAAA,EAC5D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASO,cAAcC,GAAoBC,GAAkB;AAClD,WAAA,KAAK,cAAc,KAAK,cAAc,CAACD,GAAYC,CAAQ,CAAC;AAAA,EACrE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQO,kBAAkBC,GAAkB;AACzC,WAAO,KAAK,cAAc,KAAK,kBAAkB,CAACA,CAAO,CAAC;AAAA,EAC5D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUO,UAAUA,GAAkBH,GAAqB;AAC/C,WAAA,KAAK,cAAc,KAAK,UAAU,CAACA,GAAYG,CAAO,CAAC;AAAA,EAChE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASO,iBAAiBH,GAAqB;AAC3C,WAAO,KAAK,cAAc,KAAK,iBAAiB,CAACA,CAAU,CAAC;AAAA,EAC9D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAoBO,aAAaG,GAAkBC,GAA2B;AAC3D,QAAAA,EAAY,WAAW;AACzB,YAAM,IAAIC;AAAA,QACR;AAAA,QACA;AAAA,UACE,YACE;AAAA,QACJ;AAAA,MAAA;AAcG,WAAA,EAAE,UAVQ,MACf,KAAK,YAAA,EAAc,MAAM,aAAa,CAACD,CAAW,GAAG;AAAA,MACnD,OAAO,KAAK;AAAA,MACZ,SAAAD;AAAA,IAAA,CACD,GAMgB,UALF,MACf,KAAK,YAAA,EAAc,YAAY,aAAa,CAACC,CAAW,GAAG;AAAA,MACzD,SAAAD;AAAA,IAAA,CACD;EAGL;AACF;"}
1
+ {"version":3,"file":"l2-reward-manager-handler.js","sources":["../../../lib/contracts/handlers/l2-reward-manager-handler.ts"],"sourcesContent":["import {\n Address,\n WalletClient,\n PublicClient,\n getContract,\n GetContractReturnType,\n} from 'viem';\nimport { ViemChain, VIEM_CHAINS, Chain } from '../../chains/constants';\nimport { CONTRACT_ADDRESSES } from '../addresses';\nimport { L2_REWARD_MANAGER_ABIS } from '../abis/l2-reward-manager-abis';\nimport { InvalidInputError } from '../../errors/validation-errors';\n\nexport type ClaimOrder = {\n account: Address;\n amount: bigint;\n intervalId: Address;\n isL1Contract: boolean;\n merkleProof: Address[];\n};\n\n/**\n * Handler for the `L2RewardManager` contract.\n */\nexport class L2RewardManagerHandler {\n private viemChain: ViemChain;\n\n /**\n * Create the handler for the `L2RewardManager` contract exposing\n * methods to interact with the contract.\n *\n * @param chain Chain to use for the client.\n * @param walletClient The wallet client to use for wallet\n * interactions.\n * @param publicClient The public client to use for public\n * interactions.\n */\n constructor(\n private chain: Chain,\n private walletClient: WalletClient,\n private publicClient: PublicClient,\n ) {\n this.viemChain = VIEM_CHAINS[chain];\n }\n\n /**\n * Get the contract. This is a method because the typings are complex\n * and lost when trying to make it a member.\n *\n * @returns The viem contract.\n */\n public getContract() {\n const address = CONTRACT_ADDRESSES[this.chain].L2RewardManager as Address;\n const abi = L2_REWARD_MANAGER_ABIS[this.chain].L2RewardManager;\n const client = { public: this.publicClient, wallet: this.walletClient };\n\n return getContract({ address, abi, client }) as GetContractReturnType<\n typeof abi,\n typeof client,\n Address\n >;\n }\n\n /**\n * Get the authority address.\n *\n * @returns The authority address.\n */\n public authority() {\n return this.getContract().read.authority();\n }\n\n /**\n * Get the claiming delay.\n *\n * @returns The claiming delay.\n */\n public getClaimingDelay() {\n return this.getContract().read.getClaimingDelay();\n }\n\n /**\n * Get the epoch record for a specific period.\n *\n * @param intervalId The interval ID for a given start and end epoch.\n * See `getInternvalId`.\n * @returns The epoch record of exchange rate and reward root.\n */\n public getEpochRecord(intervalId: Address) {\n return this.getContract().read.getEpochRecord([intervalId]);\n }\n\n /**\n * Returns the interval ID for a given start and end epoch.\n *\n * @param startEpoch Start epoch of the interval.\n * @param endEpoch End epoch of the interval.\n * @returns Interval ID for the given start and end epoch.\n */\n public getIntervalId(startEpoch: bigint, endEpoch: bigint) {\n return this.getContract().read.getIntervalId([startEpoch, endEpoch]);\n }\n\n /**\n * Get the rewards claimer for a specific `account`.\n *\n * @param account Account for which to get the rewards claimer.\n * @returns Rewards claimer address.\n */\n public getRewardsClaimer(account: Address) {\n return this.getContract().read.getRewardsClaimer([account]);\n }\n\n /**\n * Check if the reward has been claimed for an account and a specific\n * interval.\n *\n * @param account The address of the account to check.\n * @param intervalId The claiming interval ID. See `getIntervalId`.\n * @returns Whether the reward has been claimed.\n */\n public isClaimed(account: Address, intervalId: Address) {\n return this.getContract().read.isClaimed([intervalId, account]);\n }\n\n /**\n * Check whether the claiming is locked for the given interval.\n *\n * @param intervalId The interval to check the claiming lock for. See\n * `getIntervalId`.\n * @returns Whether the claiming is locked for the given interval.\n */\n public isClaimingLocked(intervalId: Address) {\n return this.getContract().read.isClaimingLocked([intervalId]);\n }\n\n /**\n * Claims the rewards for a specific epoch range based on the\n * `ClaimOrder`.\n *\n * @param account The account using which to claim the rewards.\n * @param claimOrders One or more claim orders.\n * @param claimOrders[].account Account of the claim order.\n * @param claimOrders[].amount Amount of the claim order.\n * @param claimOrders[].intervalId Interval ID of the claim order. See\n * `getIntervalId`.\n * @param claimOrders[].isL1Contract Whether the claim order is for an\n * L1 contract.\n * @param claimOrders[].merkleProof Merkle proof of the claim order.\n * @returns `transact: () => Promise<Address>` - Used to make the\n * transaction.\n *\n * `estimate: () => Promise<bigint>` - Gas estimate of the\n * transaction.\n * @throws {InvalidInputError} If `claimOrders` is empty.\n */\n public claimRewards(account: Address, claimOrders: ClaimOrder[]) {\n if (claimOrders.length === 0) {\n throw new InvalidInputError(\n '`claimOrders` cannot be empty and must be specified',\n {\n fixMessage:\n 'Specify at least one or more claim orders to claim rewards',\n },\n );\n }\n\n const transact = () =>\n this.getContract().write.claimRewards([claimOrders], {\n chain: this.viemChain,\n account,\n });\n const estimate = () =>\n this.getContract().estimateGas.claimRewards([claimOrders], {\n account,\n });\n\n return { transact, estimate };\n }\n}\n"],"names":["L2RewardManagerHandler","chain","walletClient","publicClient","__publicField","VIEM_CHAINS","address","CONTRACT_ADDRESSES","abi","L2_REWARD_MANAGER_ABIS","client","getContract","intervalId","startEpoch","endEpoch","account","claimOrders","InvalidInputError"],"mappings":";;;;;;;;AAuBO,MAAMA,EAAuB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAalC,YACUC,GACAC,GACAC,GACR;AAhBM,IAAAC,EAAA;AAaE,SAAA,QAAAH,GACA,KAAA,eAAAC,GACA,KAAA,eAAAC,GAEH,KAAA,YAAYE,EAAYJ,CAAK;AAAA,EACpC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQO,cAAc;AACnB,UAAMK,IAAUC,EAAmB,KAAK,KAAK,EAAE,iBACzCC,IAAMC,EAAuB,KAAK,KAAK,EAAE,iBACzCC,IAAS,EAAE,QAAQ,KAAK,cAAc,QAAQ,KAAK;AAEzD,WAAOC,EAAY,EAAE,SAAAL,GAAS,KAAAE,GAAK,QAAAE,EAAQ,CAAA;AAAA,EAK7C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,YAAY;AACjB,WAAO,KAAK,YAAA,EAAc,KAAK,UAAU;AAAA,EAC3C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,mBAAmB;AACxB,WAAO,KAAK,YAAA,EAAc,KAAK,iBAAiB;AAAA,EAClD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASO,eAAeE,GAAqB;AACzC,WAAO,KAAK,cAAc,KAAK,eAAe,CAACA,CAAU,CAAC;AAAA,EAC5D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASO,cAAcC,GAAoBC,GAAkB;AAClD,WAAA,KAAK,cAAc,KAAK,cAAc,CAACD,GAAYC,CAAQ,CAAC;AAAA,EACrE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQO,kBAAkBC,GAAkB;AACzC,WAAO,KAAK,cAAc,KAAK,kBAAkB,CAACA,CAAO,CAAC;AAAA,EAC5D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUO,UAAUA,GAAkBH,GAAqB;AAC/C,WAAA,KAAK,cAAc,KAAK,UAAU,CAACA,GAAYG,CAAO,CAAC;AAAA,EAChE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASO,iBAAiBH,GAAqB;AAC3C,WAAO,KAAK,cAAc,KAAK,iBAAiB,CAACA,CAAU,CAAC;AAAA,EAC9D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBO,aAAaG,GAAkBC,GAA2B;AAC3D,QAAAA,EAAY,WAAW;AACzB,YAAM,IAAIC;AAAA,QACR;AAAA,QACA;AAAA,UACE,YACE;AAAA,QACJ;AAAA,MAAA;AAcG,WAAA,EAAE,UAVQ,MACf,KAAK,YAAA,EAAc,MAAM,aAAa,CAACD,CAAW,GAAG;AAAA,MACnD,OAAO,KAAK;AAAA,MACZ,SAAAD;AAAA,IAAA,CACD,GAMgB,UALF,MACf,KAAK,YAAA,EAAc,YAAY,aAAa,CAACC,CAAW,GAAG;AAAA,MACzD,SAAAD;AAAA,IAAA,CACD;EAGL;AACF;"}
@@ -1,2 +1,2 @@
1
- "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e="1.5.0",o=e;exports.version=o;
1
+ "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e="1.5.2",o=e;exports.version=o;
2
2
  //# sourceMappingURL=version.cjs.map
@@ -1,4 +1,4 @@
1
- const o = "1.5.0", n = o;
1
+ const o = "1.5.2", n = o;
2
2
  export {
3
3
  n as version
4
4
  };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@pufferfinance/puffer-sdk",
3
3
  "description": "SDK for interacting with the puffer smart contracts",
4
- "version": "1.5.1",
4
+ "version": "1.5.3",
5
5
  "repository": {
6
6
  "type": "git",
7
7
  "url": "https://github.com/PufferFinance/puffer-sdk.git"