@pufferfinance/puffer-sdk 1.27.0 → 1.28.0

package/dist/contracts/handlers/carrot-vesting-handler.js

@@ -0,0 +1,201 @@
+var o = Object.defineProperty;
+var c = (a, t, e) => t in a ? o(a, t, { enumerable: !0, configurable: !0, writable: !0, value: e }) : a[t] = e;
+var n = (a, t, e) => c(a, typeof t != "symbol" ? t + "" : t, e);
+import { V as h } from "../../constants-C9YZ6Ewc.js";
+import { CarrotVesting as m } from "../abis/mainnet/CarrotVesting.js";
+import { CONTRACT_ADDRESSES as C } from "../addresses.js";
+import { Token as l } from "../tokens.js";
+import { ERC20PermitHandler as u } from "./erc20-permit-handler.js";
+import { g as d } from "../../getContract-DEPNMZxg.js";
+class V {
+  /**
+   * Create the handler for the `CarrotVesting` contract exposing methods to
+   * interact with the contract.
+   *
+   * @param chain Chain to use for the client.
+   * @param walletClient The wallet client to use for wallet
+   * interactions.
+   * @param publicClient The public client to use for public
+   * interactions.
+   */
+  constructor(t, e, r) {
+    n(this, "viemChain");
+    n(this, "erc20PermitHandler");
+    this.chain = t, this.walletClient = e, this.publicClient = r, this.viemChain = h[t], this.erc20PermitHandler = new u(
+      t,
+      e,
+      r
+    );
+  }
+  /**
+   * Get the contract.
+   *
+   * @returns The viem contract.
+   */
+  getContract() {
+    const t = C[this.chain].CarrotVesting, e = m, r = { public: this.publicClient, wallet: this.walletClient };
+    return d({ address: t, abi: e, client: r });
+  }
+  /**
+   * Get the owner of the contract.
+   *
+   * @returns The owner address.
+   */
+  owner() {
+    return this.getContract().read.owner();
+  }
+  /**
+   * Calculate the claimable amount for a user.
+   *
+   * @param user The user address.
+   * @returns The claimable amount.
+   */
+  calculateClaimableAmount(t) {
+    return this.getContract().read.calculateClaimableAmount([t]);
+  }
+  /**
+   * Get the exchange rate.
+   *
+   * @returns The exchange rate.
+   */
+  exchangeRate() {
+    return this.getContract().read.EXCHANGE_RATE();
+  }
+  /**
+   * Claim vested tokens.
+   *
+   * @returns The transaction.
+   */
+  claim() {
+    return this.getContract().write.claim({
+      account: this.walletClient.account,
+      chain: this.viemChain
+    });
+  }
+  /**
+   * Get the CARROT token address.
+   *
+   * @returns The CARROT token address.
+   */
+  getCarrotAddress() {
+    return this.getContract().read.CARROT();
+  }
+  /**
+   * Get the PUFFER token address.
+   *
+   * @returns The PUFFER token address.
+   */
+  getPufferAddress() {
+    return this.getContract().read.PUFFER();
+  }
+  /**
+   * Get the total puffer rewards.
+   *
+   * @returns The total puffer rewards.
+   */
+  totalPufferRewards() {
+    return this.getContract().read.TOTAL_PUFFER_REWARDS();
+  }
+  /**
+   * Get the number of vesting steps.
+   *
+   * @returns The number of vesting steps.
+   */
+  steps() {
+    return this.getContract().read.steps();
+  }
+  /**
+   * Get the maximum carrot amount.
+   *
+   * @returns The maximum carrot amount.
+   */
+  maxCarrotAmount() {
+    return this.getContract().read.MAX_CARROT_AMOUNT();
+  }
+  /**
+   * Get vesting information for a user.
+   *
+   * @param user The user address.
+   * @returns The vesting information including deposited amount, claimed amount, last claimed timestamp, and deposited timestamp.
+   */
+  async vestings(t) {
+    const [
+      e,
+      r,
+      i,
+      s
+    ] = await this.getContract().read.vestings([t]);
+    return {
+      depositedAmount: e,
+      claimedAmount: r,
+      lastClaimedTimestamp: i,
+      depositedTimestamp: s
+    };
+  }
+  /**
+   * Get the start timestamp.
+   *
+   * @returns The start timestamp.
+   */
+  startTimestamp() {
+    return this.getContract().read.startTimestamp();
+  }
+  /**
+   * Start vesting for a user.
+   *
+   * @param amount The amount to vest.
+   * @returns The transaction.
+   */
+  startVestingPreapproved(t) {
+    return this.getContract().write.startVesting([t], {
+      account: this.walletClient.account,
+      chain: this.viemChain
+    });
+  }
+  /**
+   * Start vesting with permit.
+   *
+   * @param permitData The permit data including deadline, amount, v, r, and s values.
+   * @returns The transaction.
+   */
+  startVestingWithPermit(t) {
+    return this.getContract().write.startVestingWithPermit([t], {
+      account: this.walletClient.account,
+      chain: this.viemChain
+    });
+  }
+  /**
+   * Start vesting.
+   *
+   * @param amount The amount to vest.
+   * @param isPreapproved Whether the CARROT token is preapproved or
+   * should use permit.
+   * @returns The transaction.
+   */
+  async startVesting(t, e) {
+    if (e)
+      return this.startVestingPreapproved(t);
+    const r = this.walletClient.account, i = await this.erc20PermitHandler.withToken(l.CARROT).getPermitData(r.address, this.getContract().address, t);
+    return this.startVestingWithPermit(i);
+  }
+  /**
+   * Get the total deposited amount.
+   *
+   * @returns The total deposited amount.
+   */
+  totalDepositedAmount() {
+    return this.getContract().read.totalDepositedAmount();
+  }
+  /**
+   * Get the duration of the vesting period.
+   *
+   * @returns The duration of the vesting period.
+   */
+  duration() {
+    return this.getContract().read.duration();
+  }
+}
+export {
+  V as CarrotVestingHandler
+};
+//# sourceMappingURL=carrot-vesting-handler.js.map

package/dist/contracts/handlers/carrot-vesting-handler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"carrot-vesting-handler.js","sources":["../../../lib/contracts/handlers/carrot-vesting-handler.ts"],"sourcesContent":["import {\n  Address,\n  GetContractReturnType,\n  PublicClient,\n  Chain as ViemChain,\n  WalletClient,\n  getContract,\n  Account,\n} from 'viem';\nimport { Chain, VIEM_CHAINS } from '../../chains/constants';\nimport { CarrotVesting } from '../abis/mainnet/CarrotVesting';\nimport { CONTRACT_ADDRESSES } from '../addresses';\nimport { PermitData } from '../common/lib/types';\nimport { Token } from '../tokens';\nimport { ERC20PermitHandler } from './erc20-permit-handler';\n\n/**\n * Handler for the `CarrotVesting` contract exposing methods to interact\n * with the contract.\n */\nexport class CarrotVestingHandler {\n  private viemChain: ViemChain;\n  private erc20PermitHandler: ERC20PermitHandler;\n\n  /**\n   * Create the handler for the `CarrotVesting` contract exposing methods to\n   * 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    this.erc20PermitHandler = new ERC20PermitHandler(\n      chain,\n      walletClient,\n      publicClient,\n    );\n  }\n\n  /**\n   * Get the contract.\n   *\n   * @returns The viem contract.\n   */\n  public getContract() {\n    const address = CONTRACT_ADDRESSES[this.chain].CarrotVesting as Address;\n    const abi = CarrotVesting;\n    const client = { public: this.publicClient, wallet: this.walletClient };\n\n    return getContract({ address, abi, client }) as GetContractReturnType<\n      typeof CarrotVesting,\n      typeof client,\n      Address\n    >;\n  }\n\n  /**\n   * Get the owner of the contract.\n   *\n   * @returns The owner address.\n   */\n  public owner() {\n    return this.getContract().read.owner();\n  }\n\n  /**\n   * Calculate the claimable amount for a user.\n   *\n   * @param user The user address.\n   * @returns The claimable amount.\n   */\n  public calculateClaimableAmount(user: Address) {\n    return this.getContract().read.calculateClaimableAmount([user]);\n  }\n\n  /**\n   * Get the exchange rate.\n   *\n   * @returns The exchange rate.\n   */\n  public exchangeRate() {\n    return this.getContract().read.EXCHANGE_RATE();\n  }\n\n  /**\n   * Claim vested tokens.\n   *\n   * @returns The transaction.\n   */\n  public claim() {\n    return this.getContract().write.claim({\n      account: this.walletClient.account as Account,\n      chain: this.viemChain,\n    });\n  }\n\n  /**\n   * Get the CARROT token address.\n   *\n   * @returns The CARROT token address.\n   */\n  public getCarrotAddress() {\n    return this.getContract().read.CARROT();\n  }\n\n  /**\n   * Get the PUFFER token address.\n   *\n   * @returns The PUFFER token address.\n   */\n  public getPufferAddress() {\n    return this.getContract().read.PUFFER();\n  }\n\n  /**\n   * Get the total puffer rewards.\n   *\n   * @returns The total puffer rewards.\n   */\n  public totalPufferRewards() {\n    return this.getContract().read.TOTAL_PUFFER_REWARDS();\n  }\n\n  /**\n   * Get the number of vesting steps.\n   *\n   * @returns The number of vesting steps.\n   */\n  public steps() {\n    return this.getContract().read.steps();\n  }\n\n  /**\n   * Get the maximum carrot amount.\n   *\n   * @returns The maximum carrot amount.\n   */\n  public maxCarrotAmount() {\n    return this.getContract().read.MAX_CARROT_AMOUNT();\n  }\n\n  /**\n   * Get vesting information for a user.\n   *\n   * @param user The user address.\n   * @returns The vesting information including deposited amount, claimed amount, last claimed timestamp, and deposited timestamp.\n   */\n  public async vestings(user: Address) {\n    const [\n      depositedAmount,\n      claimedAmount,\n      lastClaimedTimestamp,\n      depositedTimestamp,\n    ] = await this.getContract().read.vestings([user]);\n\n    return {\n      depositedAmount,\n      claimedAmount,\n      lastClaimedTimestamp,\n      depositedTimestamp,\n    };\n  }\n\n  /**\n   * Get the start timestamp.\n   *\n   * @returns The start timestamp.\n   */\n  public startTimestamp() {\n    return this.getContract().read.startTimestamp();\n  }\n\n  /**\n   * Start vesting for a user.\n   *\n   * @param amount The amount to vest.\n   * @returns The transaction.\n   */\n  public startVestingPreapproved(amount: bigint) {\n    return this.getContract().write.startVesting([amount], {\n      account: this.walletClient.account as Account,\n      chain: this.viemChain,\n    });\n  }\n\n  /**\n   * Start vesting with permit.\n   *\n   * @param permitData The permit data including deadline, amount, v, r, and s values.\n   * @returns The transaction.\n   */\n  public startVestingWithPermit(permitData: PermitData) {\n    return this.getContract().write.startVestingWithPermit([permitData], {\n      account: this.walletClient.account as Account,\n      chain: this.viemChain,\n    });\n  }\n\n  /**\n   * Start vesting.\n   *\n   * @param amount The amount to vest.\n   * @param isPreapproved Whether the CARROT token is preapproved or\n   * should use permit.\n   * @returns The transaction.\n   */\n  public async startVesting(amount: bigint, isPreapproved: boolean) {\n    if (isPreapproved) {\n      return this.startVestingPreapproved(amount);\n    }\n\n    const account = this.walletClient.account as Account;\n    const permitData = await this.erc20PermitHandler\n      .withToken(Token.CARROT)\n      .getPermitData(account.address, this.getContract().address, amount);\n\n    return this.startVestingWithPermit(permitData);\n  }\n\n  /**\n   * Get the total deposited amount.\n   *\n   * @returns The total deposited amount.\n   */\n  public totalDepositedAmount() {\n    return this.getContract().read.totalDepositedAmount();\n  }\n\n  /**\n   * Get the duration of the vesting period.\n   *\n   * @returns The duration of the vesting period.\n   */\n  public duration() {\n    return this.getContract().read.duration();\n  }\n}\n"],"names":["CarrotVestingHandler","chain","walletClient","publicClient","__publicField","VIEM_CHAINS","ERC20PermitHandler","address","CONTRACT_ADDRESSES","abi","CarrotVesting","client","getContract","user","depositedAmount","claimedAmount","lastClaimedTimestamp","depositedTimestamp","amount","permitData","isPreapproved","account","Token"],"mappings":";;;;;;;;;AAoBO,MAAMA,EAAqB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAchC,YACUC,GACAC,GACAC,GACR;AAjBM,IAAAC,EAAA;AACA,IAAAA,EAAA;AAaE,SAAA,QAAAH,GACA,KAAA,eAAAC,GACA,KAAA,eAAAC,GAEH,KAAA,YAAYE,EAAYJ,CAAK,GAClC,KAAK,qBAAqB,IAAIK;AAAA,MAC5BL;AAAA,MACAC;AAAA,MACAC;AAAA,IACF;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQK,cAAc;AACnB,UAAMI,IAAUC,EAAmB,KAAK,KAAK,EAAE,eACzCC,IAAMC,GACNC,IAAS,EAAE,QAAQ,KAAK,cAAc,QAAQ,KAAK,aAAa;AAEtE,WAAOC,EAAY,EAAE,SAAAL,GAAS,KAAAE,GAAK,QAAAE,GAAQ;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYtC,QAAQ;AACb,WAAO,KAAK,cAAc,KAAK,MAAM;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAShC,yBAAyBE,GAAe;AAC7C,WAAO,KAAK,YAAY,EAAE,KAAK,yBAAyB,CAACA,CAAI,CAAC;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQzD,eAAe;AACpB,WAAO,KAAK,cAAc,KAAK,cAAc;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQxC,QAAQ;AACb,WAAO,KAAK,cAAc,MAAM,MAAM;AAAA,MACpC,SAAS,KAAK,aAAa;AAAA,MAC3B,OAAO,KAAK;AAAA,IAAA,CACb;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQI,mBAAmB;AACxB,WAAO,KAAK,cAAc,KAAK,OAAO;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQjC,mBAAmB;AACxB,WAAO,KAAK,cAAc,KAAK,OAAO;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQjC,qBAAqB;AAC1B,WAAO,KAAK,cAAc,KAAK,qBAAqB;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ/C,QAAQ;AACb,WAAO,KAAK,cAAc,KAAK,MAAM;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQhC,kBAAkB;AACvB,WAAO,KAAK,cAAc,KAAK,kBAAkB;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASnD,MAAa,SAASA,GAAe;AAC7B,UAAA;AAAA,MACJC;AAAA,MACAC;AAAA,MACAC;AAAA,MACAC;AAAA,IAAA,IACE,MAAM,KAAK,cAAc,KAAK,SAAS,CAACJ,CAAI,CAAC;AAE1C,WAAA;AAAA,MACL,iBAAAC;AAAA,MACA,eAAAC;AAAA,MACA,sBAAAC;AAAA,MACA,oBAAAC;AAAA,IACF;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQK,iBAAiB;AACtB,WAAO,KAAK,cAAc,KAAK,eAAe;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASzC,wBAAwBC,GAAgB;AAC7C,WAAO,KAAK,YAAY,EAAE,MAAM,aAAa,CAACA,CAAM,GAAG;AAAA,MACrD,SAAS,KAAK,aAAa;AAAA,MAC3B,OAAO,KAAK;AAAA,IAAA,CACb;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASI,uBAAuBC,GAAwB;AACpD,WAAO,KAAK,YAAY,EAAE,MAAM,uBAAuB,CAACA,CAAU,GAAG;AAAA,MACnE,SAAS,KAAK,aAAa;AAAA,MAC3B,OAAO,KAAK;AAAA,IAAA,CACb;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWH,MAAa,aAAaD,GAAgBE,GAAwB;AAChE,QAAIA;AACK,aAAA,KAAK,wBAAwBF,CAAM;AAGtC,UAAAG,IAAU,KAAK,aAAa,SAC5BF,IAAa,MAAM,KAAK,mBAC3B,UAAUG,EAAM,MAAM,EACtB,cAAcD,EAAQ,SAAS,KAAK,YAAY,EAAE,SAASH,CAAM;AAE7D,WAAA,KAAK,uBAAuBC,CAAU;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQxC,uBAAuB;AAC5B,WAAO,KAAK,cAAc,KAAK,qBAAqB;AAAA,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQ/C,WAAW;AAChB,WAAO,KAAK,cAAc,KAAK,SAAS;AAAA,EAAA;AAE5C;"}

package/dist/utils/version.cjs

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e="1.26.2",o=e;exports.version=o;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e="1.27.1",o=e;exports.version=o;
 //# sourceMappingURL=version.cjs.map

package/dist/utils/version.js

@@ -1,4 +1,4 @@
-const o = "1.26.2", n = o;
+const o = "1.27.1", n = o;
 export {
   n as version
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pufferfinance/puffer-sdk",
   "description": "SDK for interacting with the puffer smart contracts",
-  "version": "1.27.0",
+  "version": "1.28.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/PufferFinance/puffer-sdk.git"