clanker-sdk 4.2.0 → 4.2.2

package/dist/v4/extensions/index.d.ts

@@ -108,9 +108,12 @@ declare function claimAirdrop(data: {
 }>;
 
 declare enum PresaleStatus {
-    Active = 0,
-    Successful = 1,
-    Failed = 2
+    NotCreated = 0,
+    Active = 1,
+    SuccessfulMinimumHit = 2,
+    SuccessfulMaximumHit = 3,
+    Failed = 4,
+    Claimable = 5
 }
 declare const PresaleConfigSchema: z.ZodObject<{
     minEthGoal: z.ZodNumber;
@@ -188,6 +191,11 @@ declare function buyIntoPresale(data: {
 /**
  * Get a transaction to end a presale
  *
+ * A presale can be ended in three scenarios:
+ * 1. Maximum ETH goal is reached (anyone can call)
+ * 2. Minimum ETH goal is reached AND duration has expired (anyone can call)
+ * 3. Minimum ETH goal is reached AND presale owner wants to end early (only presale owner can call)
+ *
  * @param presaleId The ID of the presale
  * @param salt The salt for token deployment
  * @param chainId The chain ID
@@ -201,6 +209,16 @@ declare function getEndPresaleTransaction({ presaleId, salt, chainId, }: {
 /**
  * End a presale and deploy the token
  *
+ * A presale can be ended in three scenarios:
+ * 1. Maximum ETH goal is reached (anyone can call)
+ * 2. Minimum ETH goal is reached AND duration has expired (anyone can call)
+ * 3. Minimum ETH goal is reached AND presale owner wants to end early (only presale owner can call)
+ *
+ * If the presale is successful (minimum goal reached), this will:
+ * - Deploy the token
+ * - Send raised ETH to the recipient (minus Clanker fee)
+ * - Allow users to claim tokens after lockup period
+ *
  * @param clanker Clanker object used for ending presale
  * @param presaleId The ID of the presale
  * @param salt The salt for token deployment
@@ -238,10 +256,15 @@ declare function claimTokens(data: {
     txHash: `0x${string}`;
 }>;
 /**
- * Get a transaction to claim ETH from a presale (for failed presales)
+ * Get a transaction to claim ETH from a successful presale (for presale owners)
+ *
+ * This function allows the presale owner to claim the raised ETH after the presale
+ * has been completed and the token has been deployed. Only callable by the presale
+ * owner or contract owner. A Clanker fee is deducted and the remaining ETH is sent
+ * to the recipient.
  *
  * @param presaleId The ID of the presale
- * @param recipient The recipient address for the ETH
+ * @param recipient The recipient address for the ETH (must be presale owner if called by contract owner)
  * @param chainId The chain ID
  * @returns Transaction configuration for claiming ETH
  */
@@ -251,11 +274,18 @@ declare function getClaimEthTransaction({ presaleId, recipient, chainId, }: {
     chainId: Chain;
 }): ClankerTransactionConfig<typeof Clanker_PresaleEthToCreator_v4_1_abi, 'claimEth'>;
 /**
- * Claim ETH from a failed presale
+ * Claim ETH from a successful presale
+ *
+ * This function allows the presale owner to claim the raised ETH after the presale
+ * has been completed and the token has been deployed. Only callable by the presale
+ * owner or contract owner. A Clanker fee is deducted and the remaining ETH is sent
+ * to the recipient. Can only be called once per presale.
+ *
+ * Note: For withdrawing from failed or active presales, use `withdrawFromPresale` instead.
  *
  * @param clanker Clanker object used for claiming ETH
  * @param presaleId The ID of the presale
- * @param recipient The recipient address for the ETH
+ * @param recipient The recipient address for the ETH (must be presale owner if called by contract owner)
  * @returns Outcome of the transaction
  */
 declare function claimEth(data: {

package/dist/v4/extensions/index.js

@@ -7469,9 +7469,12 @@ function encodeFeeConfig(tokenConfig, clankerConfig) {
 
 // src/v4/extensions/presale.ts
 var PresaleStatus = /* @__PURE__ */ ((PresaleStatus2) => {
-  PresaleStatus2[PresaleStatus2["Active"] = 0] = "Active";
-  PresaleStatus2[PresaleStatus2["Successful"] = 1] = "Successful";
-  PresaleStatus2[PresaleStatus2["Failed"] = 2] = "Failed";
+  PresaleStatus2[PresaleStatus2["NotCreated"] = 0] = "NotCreated";
+  PresaleStatus2[PresaleStatus2["Active"] = 1] = "Active";
+  PresaleStatus2[PresaleStatus2["SuccessfulMinimumHit"] = 2] = "SuccessfulMinimumHit";
+  PresaleStatus2[PresaleStatus2["SuccessfulMaximumHit"] = 3] = "SuccessfulMaximumHit";
+  PresaleStatus2[PresaleStatus2["Failed"] = 4] = "Failed";
+  PresaleStatus2[PresaleStatus2["Claimable"] = 5] = "Claimable";
   return PresaleStatus2;
 })(PresaleStatus || {});
 var PresaleConfigSchema = z4.object({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clanker-sdk",
-  "version": "4.2.0",
+  "version": "4.2.2",
   "description": "SDK for deploying tokens using Clanker",
   "type": "module",
   "main": "./dist/index.js",