pepay-streams-sdk 0.1.0

package/dist/automation/index.mjs

@@ -0,0 +1,326 @@
+import { DIAMOND_ABI } from '@pepay-streams/abi/diamond';
+
+// src/automation/index.ts
+var AutomationModule = class {
+  constructor(publicClient, walletClient, diamondAddress) {
+    this.publicClient = publicClient;
+    this.walletClient = walletClient;
+    this.diamondAddress = diamondAddress;
+  }
+  // ============================================================================
+  // Auto-Withdraw (for Vesting campaigns)
+  // ============================================================================
+  /**
+   * Enable auto-withdraw for a vesting campaign
+   *
+   * Keepers will automatically claim vested tokens on behalf of recipients.
+   *
+   * @example
+   * ```typescript
+   * const result = await sdk.automation.enableAutoWithdraw({
+   *   campaignId: 1n,
+   *   frequency: 7 * 24 * 60 * 60, // Weekly
+   *   tipAmount: parseEther('0.1'), // 0.1 ETH for keeper
+   * });
+   * ```
+   */
+  async enableAutoWithdraw(params) {
+    const wallet = this.requireWallet();
+    const hash = await wallet.writeContract({
+      chain: wallet.chain,
+      account: wallet.account,
+      address: this.diamondAddress,
+      abi: DIAMOND_ABI,
+      functionName: "enableAutoWithdraw",
+      args: [params.campaignId, BigInt(params.frequency)],
+      value: params.tipAmount ?? 0n
+    });
+    return this.createTransactionResult(hash);
+  }
+  /**
+   * Disable auto-withdraw for a campaign
+   *
+   * Returns remaining tip balance to caller.
+   */
+  async disableAutoWithdraw(campaignId) {
+    const wallet = this.requireWallet();
+    const hash = await wallet.writeContract({
+      chain: wallet.chain,
+      account: wallet.account,
+      address: this.diamondAddress,
+      abi: DIAMOND_ABI,
+      functionName: "disableAutoWithdraw",
+      args: [campaignId]
+    });
+    return this.createTransactionResult(hash);
+  }
+  // ============================================================================
+  // Auto-Release (for Lock campaigns)
+  // ============================================================================
+  /**
+   * Enable auto-release for a lock campaign
+   *
+   * Keepers will automatically release tokens when unlock time passes.
+   *
+   * @example
+   * ```typescript
+   * const result = await sdk.automation.enableAutoRelease({
+   *   campaignId: 5n,
+   *   frequency: 3600, // Check every hour
+   *   tipAmount: parseEther('0.05'), // 0.05 ETH for keeper
+   * });
+   * ```
+   */
+  async enableAutoRelease(params) {
+    const wallet = this.requireWallet();
+    const frequency = params.frequency ?? 3600;
+    const hash = await wallet.writeContract({
+      chain: wallet.chain,
+      account: wallet.account,
+      address: this.diamondAddress,
+      abi: DIAMOND_ABI,
+      functionName: "enableAutoReleaseLock",
+      args: [params.campaignId, BigInt(frequency)],
+      value: params.tipAmount ?? 0n
+    });
+    return this.createTransactionResult(hash);
+  }
+  /**
+   * Disable auto-release for a lock campaign
+   */
+  async disableAutoRelease(campaignId) {
+    const wallet = this.requireWallet();
+    const hash = await wallet.writeContract({
+      chain: wallet.chain,
+      account: wallet.account,
+      address: this.diamondAddress,
+      abi: DIAMOND_ABI,
+      functionName: "disableAutoReleaseLock",
+      args: [campaignId]
+    });
+    return this.createTransactionResult(hash);
+  }
+  // ============================================================================
+  // Automation Status Queries
+  // ============================================================================
+  /**
+   * Get auto-withdraw status for a campaign
+   *
+   * @example
+   * ```typescript
+   * const status = await sdk.automation.getAutoWithdrawStatus(campaignId);
+   * console.log('Enabled:', status.enabled);
+   * console.log('Next run:', new Date(status.nextRun * 1000));
+   * console.log('Tip balance:', formatEther(status.tipBalance));
+   * ```
+   */
+  async getAutoWithdrawStatus(campaignId) {
+    const [config, pendingCount, cursor] = await Promise.all([
+      this.publicClient.readContract({
+        address: this.diamondAddress,
+        abi: DIAMOND_ABI,
+        functionName: "automationConfig",
+        args: [campaignId]
+      }),
+      this.publicClient.readContract({
+        address: this.diamondAddress,
+        abi: DIAMOND_ABI,
+        functionName: "recipientsPending",
+        args: [campaignId]
+      }),
+      this.publicClient.readContract({
+        address: this.diamondAddress,
+        abi: DIAMOND_ABI,
+        functionName: "regCursor",
+        args: [campaignId]
+      })
+    ]);
+    const [enabled, frequency, lastRun] = config;
+    const nextRun = Number(lastRun) + Number(frequency);
+    return {
+      enabled,
+      lastRun: Number(lastRun),
+      nextRun,
+      frequency: Number(frequency),
+      tipBalance: 0n,
+      // Tip balance is managed internally
+      recipientsProcessed: Number(cursor),
+      totalRecipients: Number(pendingCount) + Number(cursor)
+    };
+  }
+  /**
+   * Get auto-release status for a lock campaign
+   */
+  async getAutoReleaseStatus(campaignId) {
+    const config = await this.publicClient.readContract({
+      address: this.diamondAddress,
+      abi: DIAMOND_ABI,
+      functionName: "automationLockConfig",
+      args: [campaignId]
+    });
+    const [enabled, frequency, lastRun] = config;
+    const nextRun = Number(lastRun) + Number(frequency);
+    return {
+      enabled,
+      frequency: Number(frequency),
+      lastRun: Number(lastRun),
+      nextRun
+    };
+  }
+  /**
+   * Preview automation for specific recipients
+   */
+  async previewAutomation(campaignId, recipients) {
+    const result = await this.publicClient.readContract({
+      address: this.diamondAddress,
+      abi: DIAMOND_ABI,
+      functionName: "automationPreviewFor",
+      args: [campaignId, recipients]
+    });
+    return {
+      pendingCount: result[0],
+      nextFeeWei: result[1],
+      escrowWei: result[2]
+    };
+  }
+  /**
+   * Get automation run statistics
+   */
+  async getAutomationStats(campaignId, lockMode = false) {
+    const result = await this.publicClient.readContract({
+      address: this.diamondAddress,
+      abi: DIAMOND_ABI,
+      functionName: "automationRunStats",
+      args: [campaignId, lockMode]
+    });
+    return {
+      runsObserved: Number(result.runsObserved),
+      avgRecipientsPerRun: Number(result.avgRecipientsPerRun),
+      lastRecipientsProcessed: Number(result.lastRecipientsProcessed),
+      maxRecipientsPerRun: Number(result.maxRecipientsPerRun)
+    };
+  }
+  /**
+   * Check if auto-withdraw is currently runnable
+   *
+   * Returns true if cooldown has passed and there are pending recipients.
+   */
+  async isAutoWithdrawRunnable(campaignId) {
+    const status = await this.getAutoWithdrawStatus(campaignId);
+    const now = Math.floor(Date.now() / 1e3);
+    return status.enabled && now >= status.nextRun && status.recipientsProcessed < status.totalRecipients;
+  }
+  /**
+   * Check if auto-release is currently runnable
+   */
+  async isAutoReleaseRunnable(campaignId) {
+    const status = await this.getAutoReleaseStatus(campaignId);
+    const now = Math.floor(Date.now() / 1e3);
+    return status.enabled && now >= status.nextRun;
+  }
+  // ============================================================================
+  // Keeper Functions (for automation operators)
+  // ============================================================================
+  /**
+   * Execute auto-withdraw for specific recipients (keeper only)
+   *
+   * @example
+   * ```typescript
+   * // Get recipients from registry or external source
+   * const recipients = ['0x...', '0x...', '0x...'];
+   * await sdk.automation.executeAutoWithdraw(campaignId, recipients);
+   * ```
+   */
+  async executeAutoWithdraw(campaignId, recipients) {
+    const wallet = this.requireWallet();
+    const hash = await wallet.writeContract({
+      chain: wallet.chain,
+      account: wallet.account,
+      address: this.diamondAddress,
+      abi: DIAMOND_ABI,
+      functionName: "autoWithdraw",
+      args: [campaignId, recipients]
+    });
+    return this.createTransactionResult(hash);
+  }
+  /**
+   * Execute auto-withdraw using registry cursor (keeper only)
+   *
+   * Processes up to batchSize recipients from the registry.
+   */
+  async executeAutoWithdrawNext(campaignId, batchSize = 50) {
+    const wallet = this.requireWallet();
+    const hash = await wallet.writeContract({
+      chain: wallet.chain,
+      account: wallet.account,
+      address: this.diamondAddress,
+      abi: DIAMOND_ABI,
+      functionName: "autoWithdrawNext",
+      args: [campaignId, BigInt(batchSize)]
+    });
+    return this.createTransactionResult(hash);
+  }
+  /**
+   * Execute auto-release for specific recipients (keeper only)
+   */
+  async executeAutoRelease(campaignId, recipients) {
+    const wallet = this.requireWallet();
+    const hash = await wallet.writeContract({
+      chain: wallet.chain,
+      account: wallet.account,
+      address: this.diamondAddress,
+      abi: DIAMOND_ABI,
+      functionName: "autoReleaseLock",
+      args: [campaignId, recipients]
+    });
+    return this.createTransactionResult(hash);
+  }
+  /**
+   * Execute auto-release using registry cursor (keeper only)
+   */
+  async executeAutoReleaseNext(campaignId, batchSize = 50) {
+    const wallet = this.requireWallet();
+    const hash = await wallet.writeContract({
+      chain: wallet.chain,
+      account: wallet.account,
+      address: this.diamondAddress,
+      abi: DIAMOND_ABI,
+      functionName: "autoReleaseLockNext",
+      args: [campaignId, BigInt(batchSize)]
+    });
+    return this.createTransactionResult(hash);
+  }
+  // ============================================================================
+  // Helpers
+  // ============================================================================
+  requireWallet() {
+    if (!this.walletClient) {
+      throw new Error(
+        "Wallet client required for write operations. Initialize SDK with a signer."
+      );
+    }
+    return this.walletClient;
+  }
+  createTransactionResult(hash) {
+    return {
+      hash,
+      wait: async () => {
+        const receipt = await this.publicClient.waitForTransactionReceipt({
+          hash
+        });
+        return {
+          blockNumber: receipt.blockNumber,
+          transactionHash: receipt.transactionHash,
+          gasUsed: receipt.gasUsed,
+          status: receipt.status,
+          logs: receipt.logs
+        };
+      }
+    };
+  }
+};
+var automation_default = AutomationModule;
+
+export { AutomationModule, automation_default as default };
+//# sourceMappingURL=index.mjs.map
+//# sourceMappingURL=index.mjs.map

package/dist/automation/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/automation/index.ts"],"names":[],"mappings":";;;AAyBO,IAAM,mBAAN,MAAuB;AAAA,EAC5B,WAAA,CACmB,YAAA,EACA,YAAA,EACA,cAAA,EACjB;AAHiB,IAAA,IAAA,CAAA,YAAA,GAAA,YAAA;AACA,IAAA,IAAA,CAAA,YAAA,GAAA,YAAA;AACA,IAAA,IAAA,CAAA,cAAA,GAAA,cAAA;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAoBH,MAAM,mBACJ,MAAA,EAC4B;AAC5B,IAAA,MAAM,MAAA,GAAS,KAAK,aAAA,EAAc;AAElC,IAAA,MAAM,IAAA,GAAO,MAAM,MAAA,CAAO,aAAA,CAAc;AAAA,MACtC,OAAO,MAAA,CAAO,KAAA;AAAA,MACd,SAAS,MAAA,CAAO,OAAA;AAAA,MAChB,SAAS,IAAA,CAAK,cAAA;AAAA,MACd,GAAA,EAAK,WAAA;AAAA,MACL,YAAA,EAAc,oBAAA;AAAA,MACd,MAAM,CAAC,MAAA,CAAO,YAAY,MAAA,CAAO,MAAA,CAAO,SAAS,CAAC,CAAA;AAAA,MAClD,KAAA,EAAO,OAAO,SAAA,IAAa;AAAA,KAC5B,CAAA;AAED,IAAA,OAAO,IAAA,CAAK,wBAAwB,IAAI,CAAA;AAAA,EAC1C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,oBAAoB,UAAA,EAAgD;AACxE,IAAA,MAAM,MAAA,GAAS,KAAK,aAAA,EAAc;AAElC,IAAA,MAAM,IAAA,GAAO,MAAM,MAAA,CAAO,aAAA,CAAc;AAAA,MACtC,OAAO,MAAA,CAAO,KAAA;AAAA,MACd,SAAS,MAAA,CAAO,OAAA;AAAA,MAChB,SAAS,IAAA,CAAK,cAAA;AAAA,MACd,GAAA,EAAK,WAAA;AAAA,MACL,YAAA,EAAc,qBAAA;AAAA,MACd,IAAA,EAAM,CAAC,UAAU;AAAA,KAClB,CAAA;AAED,IAAA,OAAO,IAAA,CAAK,wBAAwB,IAAI,CAAA;AAAA,EAC1C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAoBA,MAAM,kBACJ,MAAA,EAC4B;AAC5B,IAAA,MAAM,MAAA,GAAS,KAAK,aAAA,EAAc;AAGlC,IAAA,MAAM,SAAA,GAAY,OAAO,SAAA,IAAa,IAAA;AAEtC,IAAA,MAAM,IAAA,GAAO,MAAM,MAAA,CAAO,aAAA,CAAc;AAAA,MACtC,OAAO,MAAA,CAAO,KAAA;AAAA,MACd,SAAS,MAAA,CAAO,OAAA;AAAA,MAChB,SAAS,IAAA,CAAK,cAAA;AAAA,MACd,GAAA,EAAK,WAAA;AAAA,MACL,YAAA,EAAc,uBAAA;AAAA,MACd,MAAM,CAAC,MAAA,CAAO,UAAA,EAAY,MAAA,CAAO,SAAS,CAAC,CAAA;AAAA,MAC3C,KAAA,EAAO,OAAO,SAAA,IAAa;AAAA,KAC5B,CAAA;AAED,IAAA,OAAO,IAAA,CAAK,wBAAwB,IAAI,CAAA;AAAA,EAC1C;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,mBAAmB,UAAA,EAAgD;AACvE,IAAA,MAAM,MAAA,GAAS,KAAK,aAAA,EAAc;AAElC,IAAA,MAAM,IAAA,GAAO,MAAM,MAAA,CAAO,aAAA,CAAc;AAAA,MACtC,OAAO,MAAA,CAAO,KAAA;AAAA,MACd,SAAS,MAAA,CAAO,OAAA;AAAA,MAChB,SAAS,IAAA,CAAK,cAAA;AAAA,MACd,GAAA,EAAK,WAAA;AAAA,MACL,YAAA,EAAc,wBAAA;AAAA,MACd,IAAA,EAAM,CAAC,UAAU;AAAA,KAClB,CAAA;AAED,IAAA,OAAO,IAAA,CAAK,wBAAwB,IAAI,CAAA;AAAA,EAC1C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAiBA,MAAM,sBAAsB,UAAA,EAA+C;AACzE,IAAA,MAAM,CAAC,MAAA,EAAQ,YAAA,EAAc,MAAM,CAAA,GAAI,MAAM,QAAQ,GAAA,CAAI;AAAA,MACvD,IAAA,CAAK,aAAa,YAAA,CAAa;AAAA,QAC7B,SAAS,IAAA,CAAK,cAAA;AAAA,QACd,GAAA,EAAK,WAAA;AAAA,QACL,YAAA,EAAc,kBAAA;AAAA,QACd,IAAA,EAAM,CAAC,UAAU;AAAA,OAClB,CAAA;AAAA,MACD,IAAA,CAAK,aAAa,YAAA,CAAa;AAAA,QAC7B,SAAS,IAAA,CAAK,cAAA;AAAA,QACd,GAAA,EAAK,WAAA;AAAA,QACL,YAAA,EAAc,mBAAA;AAAA,QACd,IAAA,EAAM,CAAC,UAAU;AAAA,OAClB,CAAA;AAAA,MACD,IAAA,CAAK,aAAa,YAAA,CAAa;AAAA,QAC7B,SAAS,IAAA,CAAK,cAAA;AAAA,QACd,GAAA,EAAK,WAAA;AAAA,QACL,YAAA,EAAc,WAAA;AAAA,QACd,IAAA,EAAM,CAAC,UAAU;AAAA,OAClB;AAAA,KACF,CAAA;AAED,IAAA,MAAM,CAAC,OAAA,EAAS,SAAA,EAAW,OAAO,CAAA,GAAI,MAAA;AACtC,IAAA,MAAM,OAAA,GAAU,MAAA,CAAO,OAAO,CAAA,GAAI,OAAO,SAAS,CAAA;AAElD,IAAA,OAAO;AAAA,MACL,OAAA;AAAA,MACA,OAAA,EAAS,OAAO,OAAO,CAAA;AAAA,MACvB,OAAA;AAAA,MACA,SAAA,EAAW,OAAO,SAAS,CAAA;AAAA,MAC3B,UAAA,EAAY,EAAA;AAAA;AAAA,MACZ,mBAAA,EAAqB,OAAO,MAAM,CAAA;AAAA,MAClC,eAAA,EAAiB,MAAA,CAAO,YAAY,CAAA,GAAI,OAAO,MAAM;AAAA,KACvD;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,qBAAqB,UAAA,EAKxB;AACD,IAAA,MAAM,MAAA,GAAS,MAAM,IAAA,CAAK,YAAA,CAAa,YAAA,CAAa;AAAA,MAClD,SAAS,IAAA,CAAK,cAAA;AAAA,MACd,GAAA,EAAK,WAAA;AAAA,MACL,YAAA,EAAc,sBAAA;AAAA,MACd,IAAA,EAAM,CAAC,UAAU;AAAA,KAClB,CAAA;AAED,IAAA,MAAM,CAAC,OAAA,EAAS,SAAA,EAAW,OAAO,CAAA,GAAI,MAAA;AACtC,IAAA,MAAM,OAAA,GAAU,MAAA,CAAO,OAAO,CAAA,GAAI,OAAO,SAAS,CAAA;AAElD,IAAA,OAAO;AAAA,MACL,OAAA;AAAA,MACA,SAAA,EAAW,OAAO,SAAS,CAAA;AAAA,MAC3B,OAAA,EAAS,OAAO,OAAO,CAAA;AAAA,MACvB;AAAA,KACF;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,iBAAA,CACJ,UAAA,EACA,UAAA,EAKC;AACD,IAAA,MAAM,MAAA,GAAS,MAAM,IAAA,CAAK,YAAA,CAAa,YAAA,CAAa;AAAA,MAClD,SAAS,IAAA,CAAK,cAAA;AAAA,MACd,GAAA,EAAK,WAAA;AAAA,MACL,YAAA,EAAc,sBAAA;AAAA,MACd,IAAA,EAAM,CAAC,UAAA,EAAY,UAAU;AAAA,KAC9B,CAAA;AAED,IAAA,OAAO;AAAA,MACL,YAAA,EAAc,OAAO,CAAC,CAAA;AAAA,MACtB,UAAA,EAAY,OAAO,CAAC,CAAA;AAAA,MACpB,SAAA,EAAW,OAAO,CAAC;AAAA,KACrB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,kBAAA,CACJ,UAAA,EACA,QAAA,GAAW,KAAA,EAMV;AACD,IAAA,MAAM,MAAA,GAAS,MAAM,IAAA,CAAK,YAAA,CAAa,YAAA,CAAa;AAAA,MAClD,SAAS,IAAA,CAAK,cAAA;AAAA,MACd,GAAA,EAAK,WAAA;AAAA,MACL,YAAA,EAAc,oBAAA;AAAA,MACd,IAAA,EAAM,CAAC,UAAA,EAAY,QAAQ;AAAA,KAC5B,CAAA;AAOD,IAAA,OAAO;AAAA,MACL,YAAA,EAAc,MAAA,CAAO,MAAA,CAAO,YAAY,CAAA;AAAA,MACxC,mBAAA,EAAqB,MAAA,CAAO,MAAA,CAAO,mBAAmB,CAAA;AAAA,MACtD,uBAAA,EAAyB,MAAA,CAAO,MAAA,CAAO,uBAAuB,CAAA;AAAA,MAC9D,mBAAA,EAAqB,MAAA,CAAO,MAAA,CAAO,mBAAmB;AAAA,KACxD;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,uBAAuB,UAAA,EAAsC;AACjE,IAAA,MAAM,MAAA,GAAS,MAAM,IAAA,CAAK,qBAAA,CAAsB,UAAU,CAAA;AAC1D,IAAA,MAAM,MAAM,IAAA,CAAK,KAAA,CAAM,IAAA,CAAK,GAAA,KAAQ,GAAI,CAAA;AAExC,IAAA,OACE,OAAO,OAAA,IACP,GAAA,IAAO,OAAO,OAAA,IACd,MAAA,CAAO,sBAAsB,MAAA,CAAO,eAAA;AAAA,EAExC;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,sBAAsB,UAAA,EAAsC;AAChE,IAAA,MAAM,MAAA,GAAS,MAAM,IAAA,CAAK,oBAAA,CAAqB,UAAU,CAAA;AACzD,IAAA,MAAM,MAAM,IAAA,CAAK,KAAA,CAAM,IAAA,CAAK,GAAA,KAAQ,GAAI,CAAA;AAExC,IAAA,OAAO,MAAA,CAAO,OAAA,IAAW,GAAA,IAAO,MAAA,CAAO,OAAA;AAAA,EACzC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAgBA,MAAM,mBAAA,CACJ,UAAA,EACA,UAAA,EAC4B;AAC5B,IAAA,MAAM,MAAA,GAAS,KAAK,aAAA,EAAc;AAElC,IAAA,MAAM,IAAA,GAAO,MAAM,MAAA,CAAO,aAAA,CAAc;AAAA,MACtC,OAAO,MAAA,CAAO,KAAA;AAAA,MACd,SAAS,MAAA,CAAO,OAAA;AAAA,MAChB,SAAS,IAAA,CAAK,cAAA;AAAA,MACd,GAAA,EAAK,WAAA;AAAA,MACL,YAAA,EAAc,cAAA;AAAA,MACd,IAAA,EAAM,CAAC,UAAA,EAAY,UAAU;AAAA,KAC9B,CAAA;AAED,IAAA,OAAO,IAAA,CAAK,wBAAwB,IAAI,CAAA;AAAA,EAC1C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,uBAAA,CACJ,UAAA,EACA,SAAA,GAAY,EAAA,EACgB;AAC5B,IAAA,MAAM,MAAA,GAAS,KAAK,aAAA,EAAc;AAElC,IAAA,MAAM,IAAA,GAAO,MAAM,MAAA,CAAO,aAAA,CAAc;AAAA,MACtC,OAAO,MAAA,CAAO,KAAA;AAAA,MACd,SAAS,MAAA,CAAO,OAAA;AAAA,MAChB,SAAS,IAAA,CAAK,cAAA;AAAA,MACd,GAAA,EAAK,WAAA;AAAA,MACL,YAAA,EAAc,kBAAA;AAAA,MACd,IAAA,EAAM,CAAC,UAAA,EAAY,MAAA,CAAO,SAAS,CAAC;AAAA,KACrC,CAAA;AAED,IAAA,OAAO,IAAA,CAAK,wBAAwB,IAAI,CAAA;AAAA,EAC1C;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,kBAAA,CACJ,UAAA,EACA,UAAA,EAC4B;AAC5B,IAAA,MAAM,MAAA,GAAS,KAAK,aAAA,EAAc;AAElC,IAAA,MAAM,IAAA,GAAO,MAAM,MAAA,CAAO,aAAA,CAAc;AAAA,MACtC,OAAO,MAAA,CAAO,KAAA;AAAA,MACd,SAAS,MAAA,CAAO,OAAA;AAAA,MAChB,SAAS,IAAA,CAAK,cAAA;AAAA,MACd,GAAA,EAAK,WAAA;AAAA,MACL,YAAA,EAAc,iBAAA;AAAA,MACd,IAAA,EAAM,CAAC,UAAA,EAAY,UAAU;AAAA,KAC9B,CAAA;AAED,IAAA,OAAO,IAAA,CAAK,wBAAwB,IAAI,CAAA;AAAA,EAC1C;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,sBAAA,CACJ,UAAA,EACA,SAAA,GAAY,EAAA,EACgB;AAC5B,IAAA,MAAM,MAAA,GAAS,KAAK,aAAA,EAAc;AAElC,IAAA,MAAM,IAAA,GAAO,MAAM,MAAA,CAAO,aAAA,CAAc;AAAA,MACtC,OAAO,MAAA,CAAO,KAAA;AAAA,MACd,SAAS,MAAA,CAAO,OAAA;AAAA,MAChB,SAAS,IAAA,CAAK,cAAA;AAAA,MACd,GAAA,EAAK,WAAA;AAAA,MACL,YAAA,EAAc,qBAAA;AAAA,MACd,IAAA,EAAM,CAAC,UAAA,EAAY,MAAA,CAAO,SAAS,CAAC;AAAA,KACrC,CAAA;AAED,IAAA,OAAO,IAAA,CAAK,wBAAwB,IAAI,CAAA;AAAA,EAC1C;AAAA;AAAA;AAAA;AAAA,EAMQ,aAAA,GAA8B;AACpC,IAAA,IAAI,CAAC,KAAK,YAAA,EAAc;AACtB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR;AAAA,OACF;AAAA,IACF;AACA,IAAA,OAAO,IAAA,CAAK,YAAA;AAAA,EACd;AAAA,EAEQ,wBAAwB,IAAA,EAA+B;AAC7D,IAAA,OAAO;AAAA,MACL,IAAA;AAAA,MACA,MAAM,YAAY;AAChB,QAAA,MAAM,OAAA,GAAU,MAAM,IAAA,CAAK,YAAA,CAAa,yBAAA,CAA0B;AAAA,UAChE;AAAA,SACD,CAAA;AACD,QAAA,OAAO;AAAA,UACL,aAAa,OAAA,CAAQ,WAAA;AAAA,UACrB,iBAAiB,OAAA,CAAQ,eAAA;AAAA,UACzB,SAAS,OAAA,CAAQ,OAAA;AAAA,UACjB,QAAQ,OAAA,CAAQ,MAAA;AAAA,UAChB,MAAM,OAAA,CAAQ;AAAA,SAChB;AAAA,MACF;AAAA,KACF;AAAA,EACF;AACF;AAEA,IAAO,kBAAA,GAAQ","file":"index.mjs","sourcesContent":["/**\r\n * Automation Module\r\n *\r\n * Provides methods for keeper automation:\r\n * - Enable/disable auto-withdraw for vesting campaigns\r\n * - Enable/disable auto-release for locks\r\n * - Query automation status\r\n */\r\nimport {\r\n  type PublicClient,\r\n  type WalletClient,\r\n  type Address,\r\n  type Hash,\r\n} from 'viem';\r\nimport { DIAMOND_ABI } from '@pepay-streams/abi/diamond';\r\nimport type {\r\n  EnableAutoWithdrawParams,\r\n  EnableAutoReleaseParams,\r\n  AutomationStatus,\r\n  TransactionResult,\r\n} from '../types';\r\n\r\n/**\r\n * Automation module for keeper-powered operations\r\n */\r\nexport class AutomationModule {\r\n  constructor(\r\n    private readonly publicClient: PublicClient,\r\n    private readonly walletClient: WalletClient | undefined,\r\n    private readonly diamondAddress: Address\r\n  ) {}\r\n\r\n  // ============================================================================\r\n  // Auto-Withdraw (for Vesting campaigns)\r\n  // ============================================================================\r\n\r\n  /**\r\n   * Enable auto-withdraw for a vesting campaign\r\n   *\r\n   * Keepers will automatically claim vested tokens on behalf of recipients.\r\n   *\r\n   * @example\r\n   * ```typescript\r\n   * const result = await sdk.automation.enableAutoWithdraw({\r\n   *   campaignId: 1n,\r\n   *   frequency: 7 * 24 * 60 * 60, // Weekly\r\n   *   tipAmount: parseEther('0.1'), // 0.1 ETH for keeper\r\n   * });\r\n   * ```\r\n   */\r\n  async enableAutoWithdraw(\r\n    params: EnableAutoWithdrawParams\r\n  ): Promise<TransactionResult> {\r\n    const wallet = this.requireWallet();\r\n\r\n    const hash = await wallet.writeContract({\r\n      chain: wallet.chain,\r\n      account: wallet.account!,\r\n      address: this.diamondAddress,\r\n      abi: DIAMOND_ABI,\r\n      functionName: 'enableAutoWithdraw',\r\n      args: [params.campaignId, BigInt(params.frequency)],\r\n      value: params.tipAmount ?? 0n,\r\n    });\r\n\r\n    return this.createTransactionResult(hash);\r\n  }\r\n\r\n  /**\r\n   * Disable auto-withdraw for a campaign\r\n   *\r\n   * Returns remaining tip balance to caller.\r\n   */\r\n  async disableAutoWithdraw(campaignId: bigint): Promise<TransactionResult> {\r\n    const wallet = this.requireWallet();\r\n\r\n    const hash = await wallet.writeContract({\r\n      chain: wallet.chain,\r\n      account: wallet.account!,\r\n      address: this.diamondAddress,\r\n      abi: DIAMOND_ABI,\r\n      functionName: 'disableAutoWithdraw',\r\n      args: [campaignId],\r\n    });\r\n\r\n    return this.createTransactionResult(hash);\r\n  }\r\n\r\n  // ============================================================================\r\n  // Auto-Release (for Lock campaigns)\r\n  // ============================================================================\r\n\r\n  /**\r\n   * Enable auto-release for a lock campaign\r\n   *\r\n   * Keepers will automatically release tokens when unlock time passes.\r\n   *\r\n   * @example\r\n   * ```typescript\r\n   * const result = await sdk.automation.enableAutoRelease({\r\n   *   campaignId: 5n,\r\n   *   frequency: 3600, // Check every hour\r\n   *   tipAmount: parseEther('0.05'), // 0.05 ETH for keeper\r\n   * });\r\n   * ```\r\n   */\r\n  async enableAutoRelease(\r\n    params: EnableAutoReleaseParams & { frequency?: number }\r\n  ): Promise<TransactionResult> {\r\n    const wallet = this.requireWallet();\r\n\r\n    // Default frequency of 1 hour if not specified\r\n    const frequency = params.frequency ?? 3600;\r\n\r\n    const hash = await wallet.writeContract({\r\n      chain: wallet.chain,\r\n      account: wallet.account!,\r\n      address: this.diamondAddress,\r\n      abi: DIAMOND_ABI,\r\n      functionName: 'enableAutoReleaseLock',\r\n      args: [params.campaignId, BigInt(frequency)],\r\n      value: params.tipAmount ?? 0n,\r\n    });\r\n\r\n    return this.createTransactionResult(hash);\r\n  }\r\n\r\n  /**\r\n   * Disable auto-release for a lock campaign\r\n   */\r\n  async disableAutoRelease(campaignId: bigint): Promise<TransactionResult> {\r\n    const wallet = this.requireWallet();\r\n\r\n    const hash = await wallet.writeContract({\r\n      chain: wallet.chain,\r\n      account: wallet.account!,\r\n      address: this.diamondAddress,\r\n      abi: DIAMOND_ABI,\r\n      functionName: 'disableAutoReleaseLock',\r\n      args: [campaignId],\r\n    });\r\n\r\n    return this.createTransactionResult(hash);\r\n  }\r\n\r\n  // ============================================================================\r\n  // Automation Status Queries\r\n  // ============================================================================\r\n\r\n  /**\r\n   * Get auto-withdraw status for a campaign\r\n   *\r\n   * @example\r\n   * ```typescript\r\n   * const status = await sdk.automation.getAutoWithdrawStatus(campaignId);\r\n   * console.log('Enabled:', status.enabled);\r\n   * console.log('Next run:', new Date(status.nextRun * 1000));\r\n   * console.log('Tip balance:', formatEther(status.tipBalance));\r\n   * ```\r\n   */\r\n  async getAutoWithdrawStatus(campaignId: bigint): Promise<AutomationStatus> {\r\n    const [config, pendingCount, cursor] = await Promise.all([\r\n      this.publicClient.readContract({\r\n        address: this.diamondAddress,\r\n        abi: DIAMOND_ABI,\r\n        functionName: 'automationConfig',\r\n        args: [campaignId],\r\n      }) as Promise<[boolean, bigint, bigint]>,\r\n      this.publicClient.readContract({\r\n        address: this.diamondAddress,\r\n        abi: DIAMOND_ABI,\r\n        functionName: 'recipientsPending',\r\n        args: [campaignId],\r\n      }) as Promise<bigint>,\r\n      this.publicClient.readContract({\r\n        address: this.diamondAddress,\r\n        abi: DIAMOND_ABI,\r\n        functionName: 'regCursor',\r\n        args: [campaignId],\r\n      }) as Promise<bigint>,\r\n    ]);\r\n\r\n    const [enabled, frequency, lastRun] = config;\r\n    const nextRun = Number(lastRun) + Number(frequency);\r\n\r\n    return {\r\n      enabled,\r\n      lastRun: Number(lastRun),\r\n      nextRun,\r\n      frequency: Number(frequency),\r\n      tipBalance: 0n, // Tip balance is managed internally\r\n      recipientsProcessed: Number(cursor),\r\n      totalRecipients: Number(pendingCount) + Number(cursor),\r\n    };\r\n  }\r\n\r\n  /**\r\n   * Get auto-release status for a lock campaign\r\n   */\r\n  async getAutoReleaseStatus(campaignId: bigint): Promise<{\r\n    enabled: boolean;\r\n    frequency: number;\r\n    lastRun: number;\r\n    nextRun: number;\r\n  }> {\r\n    const config = await this.publicClient.readContract({\r\n      address: this.diamondAddress,\r\n      abi: DIAMOND_ABI,\r\n      functionName: 'automationLockConfig',\r\n      args: [campaignId],\r\n    }) as [boolean, bigint, bigint];\r\n\r\n    const [enabled, frequency, lastRun] = config;\r\n    const nextRun = Number(lastRun) + Number(frequency);\r\n\r\n    return {\r\n      enabled,\r\n      frequency: Number(frequency),\r\n      lastRun: Number(lastRun),\r\n      nextRun,\r\n    };\r\n  }\r\n\r\n  /**\r\n   * Preview automation for specific recipients\r\n   */\r\n  async previewAutomation(\r\n    campaignId: bigint,\r\n    recipients: Address[]\r\n  ): Promise<{\r\n    pendingCount: bigint;\r\n    nextFeeWei: bigint;\r\n    escrowWei: bigint;\r\n  }> {\r\n    const result = await this.publicClient.readContract({\r\n      address: this.diamondAddress,\r\n      abi: DIAMOND_ABI,\r\n      functionName: 'automationPreviewFor',\r\n      args: [campaignId, recipients],\r\n    }) as [bigint, bigint, bigint];\r\n\r\n    return {\r\n      pendingCount: result[0],\r\n      nextFeeWei: result[1],\r\n      escrowWei: result[2],\r\n    };\r\n  }\r\n\r\n  /**\r\n   * Get automation run statistics\r\n   */\r\n  async getAutomationStats(\r\n    campaignId: bigint,\r\n    lockMode = false\r\n  ): Promise<{\r\n    runsObserved: number;\r\n    avgRecipientsPerRun: number;\r\n    lastRecipientsProcessed: number;\r\n    maxRecipientsPerRun: number;\r\n  }> {\r\n    const result = await this.publicClient.readContract({\r\n      address: this.diamondAddress,\r\n      abi: DIAMOND_ABI,\r\n      functionName: 'automationRunStats',\r\n      args: [campaignId, lockMode],\r\n    }) as {\r\n      runsObserved: bigint;\r\n      avgRecipientsPerRun: bigint;\r\n      lastRecipientsProcessed: bigint;\r\n      maxRecipientsPerRun: bigint;\r\n    };\r\n\r\n    return {\r\n      runsObserved: Number(result.runsObserved),\r\n      avgRecipientsPerRun: Number(result.avgRecipientsPerRun),\r\n      lastRecipientsProcessed: Number(result.lastRecipientsProcessed),\r\n      maxRecipientsPerRun: Number(result.maxRecipientsPerRun),\r\n    };\r\n  }\r\n\r\n  /**\r\n   * Check if auto-withdraw is currently runnable\r\n   *\r\n   * Returns true if cooldown has passed and there are pending recipients.\r\n   */\r\n  async isAutoWithdrawRunnable(campaignId: bigint): Promise<boolean> {\r\n    const status = await this.getAutoWithdrawStatus(campaignId);\r\n    const now = Math.floor(Date.now() / 1000);\r\n\r\n    return (\r\n      status.enabled &&\r\n      now >= status.nextRun &&\r\n      status.recipientsProcessed < status.totalRecipients\r\n    );\r\n  }\r\n\r\n  /**\r\n   * Check if auto-release is currently runnable\r\n   */\r\n  async isAutoReleaseRunnable(campaignId: bigint): Promise<boolean> {\r\n    const status = await this.getAutoReleaseStatus(campaignId);\r\n    const now = Math.floor(Date.now() / 1000);\r\n\r\n    return status.enabled && now >= status.nextRun;\r\n  }\r\n\r\n  // ============================================================================\r\n  // Keeper Functions (for automation operators)\r\n  // ============================================================================\r\n\r\n  /**\r\n   * Execute auto-withdraw for specific recipients (keeper only)\r\n   *\r\n   * @example\r\n   * ```typescript\r\n   * // Get recipients from registry or external source\r\n   * const recipients = ['0x...', '0x...', '0x...'];\r\n   * await sdk.automation.executeAutoWithdraw(campaignId, recipients);\r\n   * ```\r\n   */\r\n  async executeAutoWithdraw(\r\n    campaignId: bigint,\r\n    recipients: Address[]\r\n  ): Promise<TransactionResult> {\r\n    const wallet = this.requireWallet();\r\n\r\n    const hash = await wallet.writeContract({\r\n      chain: wallet.chain,\r\n      account: wallet.account!,\r\n      address: this.diamondAddress,\r\n      abi: DIAMOND_ABI,\r\n      functionName: 'autoWithdraw',\r\n      args: [campaignId, recipients],\r\n    });\r\n\r\n    return this.createTransactionResult(hash);\r\n  }\r\n\r\n  /**\r\n   * Execute auto-withdraw using registry cursor (keeper only)\r\n   *\r\n   * Processes up to batchSize recipients from the registry.\r\n   */\r\n  async executeAutoWithdrawNext(\r\n    campaignId: bigint,\r\n    batchSize = 50\r\n  ): Promise<TransactionResult> {\r\n    const wallet = this.requireWallet();\r\n\r\n    const hash = await wallet.writeContract({\r\n      chain: wallet.chain,\r\n      account: wallet.account!,\r\n      address: this.diamondAddress,\r\n      abi: DIAMOND_ABI,\r\n      functionName: 'autoWithdrawNext',\r\n      args: [campaignId, BigInt(batchSize)],\r\n    });\r\n\r\n    return this.createTransactionResult(hash);\r\n  }\r\n\r\n  /**\r\n   * Execute auto-release for specific recipients (keeper only)\r\n   */\r\n  async executeAutoRelease(\r\n    campaignId: bigint,\r\n    recipients: Address[]\r\n  ): Promise<TransactionResult> {\r\n    const wallet = this.requireWallet();\r\n\r\n    const hash = await wallet.writeContract({\r\n      chain: wallet.chain,\r\n      account: wallet.account!,\r\n      address: this.diamondAddress,\r\n      abi: DIAMOND_ABI,\r\n      functionName: 'autoReleaseLock',\r\n      args: [campaignId, recipients],\r\n    });\r\n\r\n    return this.createTransactionResult(hash);\r\n  }\r\n\r\n  /**\r\n   * Execute auto-release using registry cursor (keeper only)\r\n   */\r\n  async executeAutoReleaseNext(\r\n    campaignId: bigint,\r\n    batchSize = 50\r\n  ): Promise<TransactionResult> {\r\n    const wallet = this.requireWallet();\r\n\r\n    const hash = await wallet.writeContract({\r\n      chain: wallet.chain,\r\n      account: wallet.account!,\r\n      address: this.diamondAddress,\r\n      abi: DIAMOND_ABI,\r\n      functionName: 'autoReleaseLockNext',\r\n      args: [campaignId, BigInt(batchSize)],\r\n    });\r\n\r\n    return this.createTransactionResult(hash);\r\n  }\r\n\r\n  // ============================================================================\r\n  // Helpers\r\n  // ============================================================================\r\n\r\n  private requireWallet(): WalletClient {\r\n    if (!this.walletClient) {\r\n      throw new Error(\r\n        'Wallet client required for write operations. Initialize SDK with a signer.'\r\n      );\r\n    }\r\n    return this.walletClient;\r\n  }\r\n\r\n  private createTransactionResult(hash: Hash): TransactionResult {\r\n    return {\r\n      hash,\r\n      wait: async () => {\r\n        const receipt = await this.publicClient.waitForTransactionReceipt({\r\n          hash,\r\n        });\r\n        return {\r\n          blockNumber: receipt.blockNumber,\r\n          transactionHash: receipt.transactionHash,\r\n          gasUsed: receipt.gasUsed,\r\n          status: receipt.status,\r\n          logs: receipt.logs,\r\n        };\r\n      },\r\n    };\r\n  }\r\n}\r\n\r\nexport default AutomationModule;\r\n"]}

package/dist/campaigns/index.d.mts

@@ -0,0 +1,286 @@
+import { PublicClient, WalletClient, Address, Hex } from 'viem';
+import { I as InstantAirdropParams, T as TransactionResult, V as VestedAirdropParams, L as LockParams, a as VestingParams, C as CampaignInfo } from '../index-BTG0TRJt.mjs';
+
+/**
+ * Campaign Creation Module
+ *
+ * Provides methods for creating all campaign types:
+ * - Instant Airdrops (Kind.INSTANT = 0)
+ * - Vested Airdrops (Kind.VESTED = 1)
+ * - Token Locks (Kind.LOCK = 2)
+ * - Vesting Streams (Kind.VESTING = 3)
+ */
+
+/**
+ * Campaign Kind enum matching the contract
+ */
+declare enum CampaignKind {
+    INSTANT = 0,
+    VESTED = 1,
+    LOCK = 2,
+    VESTING = 3
+}
+/**
+ * Change policy enum matching the contract
+ */
+declare enum ChangePolicy {
+    ONLY_RECIPIENT = 0,
+    ONLY_CREATOR = 1,
+    BOTH = 2,
+    NO_ONE = 3
+}
+/**
+ * CreateArgs struct matching the contract
+ */
+interface CreateArgs {
+    kind: number;
+    token: Address;
+    start: bigint;
+    end: bigint;
+    step: bigint;
+    cliffReleaseTime: bigint;
+    cliffBps: number;
+    autoClaimIncentiveBps: number;
+    cancelable: boolean;
+    claimOnce: boolean;
+    changePolicy: number;
+    claimGrace: bigint;
+    recipients: Address[];
+    amounts: bigint[];
+    feeBuffer: bigint;
+    attachDefaultRegistry: boolean;
+    unwrapWETH: boolean;
+    weth: Address;
+}
+/**
+ * Campaigns module for creating and managing token distribution campaigns
+ */
+declare class CampaignsModule {
+    private readonly publicClient;
+    private readonly walletClient;
+    private readonly diamondAddress;
+    constructor(publicClient: PublicClient, walletClient: WalletClient | undefined, diamondAddress: Address);
+    /**
+     * Create an Instant Airdrop campaign
+     *
+     * Tokens are immediately claimable by recipients after funding.
+     *
+     * @example
+     * ```typescript
+     * const result = await sdk.campaigns.createInstantAirdrop({
+     *   token: '0x...',
+     *   recipients: [
+     *     { address: '0x...', amount: parseEther('100') },
+     *     { address: '0x...', amount: parseEther('50') },
+     *   ],
+     * });
+     * console.log('Campaign created, tx:', result.hash);
+     * ```
+     */
+    createInstantAirdrop(params: InstantAirdropParams): Promise<TransactionResult>;
+    /**
+     * Create a Vested Airdrop campaign
+     *
+     * Tokens vest linearly over time with optional cliff period.
+     *
+     * @example
+     * ```typescript
+     * const result = await sdk.campaigns.createVestedAirdrop({
+     *   token: '0x...',
+     *   recipients: [
+     *     { address: '0x...', amount: parseEther('1000') },
+     *   ],
+     *   startTime: Math.floor(Date.now() / 1000), // Start now
+     *   duration: 365 * 24 * 60 * 60, // 1 year
+     *   cliffDuration: 90 * 24 * 60 * 60, // 3 month cliff
+     *   steps: 12, // Monthly releases
+     * });
+     * ```
+     */
+    createVestedAirdrop(params: VestedAirdropParams): Promise<TransactionResult>;
+    /**
+     * Create a Token Lock
+     *
+     * Tokens are locked until a specific unlock time, then fully releasable.
+     *
+     * @example
+     * ```typescript
+     * const result = await sdk.campaigns.createLock({
+     *   token: '0x...',
+     *   recipient: '0x...',
+     *   amount: parseEther('1000000'),
+     *   unlockTime: Math.floor(Date.now() / 1000) + 180 * 24 * 60 * 60, // 6 months
+     * });
+     * ```
+     */
+    createLock(params: LockParams): Promise<TransactionResult>;
+    /**
+     * Create a Vesting Stream (Payment)
+     *
+     * Single-recipient vesting with optional automation.
+     *
+     * @example
+     * ```typescript
+     * const result = await sdk.campaigns.createVesting({
+     *   token: '0x...',
+     *   recipient: '0x...',
+     *   amount: parseEther('120000'), // 120k tokens
+     *   startTime: Math.floor(Date.now() / 1000),
+     *   duration: 365 * 24 * 60 * 60, // 1 year
+     *   cliffDuration: 0, // No cliff
+     *   steps: 12, // Monthly
+     * });
+     * ```
+     */
+    createVesting(params: VestingParams): Promise<TransactionResult>;
+    /**
+     * Create a campaign with raw CreateArgs
+     *
+     * Low-level function for full control over campaign parameters.
+     */
+    createCampaign(args: CreateArgs): Promise<TransactionResult>;
+    /**
+     * Fund a campaign using EIP-2612 Permit (gasless approval)
+     *
+     * @example
+     * ```typescript
+     * const result = await sdk.campaigns.fundWithPermit({
+     *   campaignId,
+     *   amount: parseEther('1000'),
+     *   deadline: Math.floor(Date.now() / 1000) + 3600,
+     *   v: 28,
+     *   r: '0x...',
+     *   s: '0x...',
+     * });
+     * ```
+     */
+    fundWithPermit(params: {
+        campaignId: bigint;
+        amount: bigint;
+        deadline: bigint;
+        v: number;
+        r: Hex;
+        s: Hex;
+    }): Promise<TransactionResult>;
+    /**
+     * Fund a campaign using Permit2 (gasless approval)
+     *
+     * @example
+     * ```typescript
+     * const result = await sdk.campaigns.fundWithPermit2({
+     *   campaignId,
+     *   from: userAddress,
+     *   amount: parseEther('1000'),
+     *   permit2Data: encodedPermit2Data,
+     * });
+     * ```
+     */
+    fundWithPermit2(params: {
+        campaignId: bigint;
+        from: Address;
+        amount: bigint;
+        permit2Data: Hex;
+    }): Promise<TransactionResult>;
+    /**
+     * Return leftover tokens to creator
+     *
+     * @example
+     * ```typescript
+     * const result = await sdk.campaigns.returnLeftover(campaignId, parseEther('100'));
+     * ```
+     */
+    returnLeftover(campaignId: bigint, amountToReturn: bigint): Promise<TransactionResult>;
+    /**
+     * Add native tips to a campaign for automation
+     */
+    addNativeTips(campaignId: bigint, tipAmount: bigint): Promise<TransactionResult>;
+    /**
+     * Get campaign summary by ID
+     *
+     * Returns full campaign configuration and state.
+     *
+     * @example
+     * ```typescript
+     * const campaign = await sdk.campaigns.getCampaign(1n);
+     * console.log('Campaign token:', campaign.token);
+     * console.log('Total claimed:', campaign.totalClaimed);
+     * ```
+     */
+    getCampaign(campaignId: bigint): Promise<CampaignInfo>;
+    /**
+     * Get campaign configuration only
+     */
+    getCampaignConfig(campaignId: bigint): Promise<{
+        kind: number;
+        cancelable: boolean;
+        claimOnce: boolean;
+        canceled: boolean;
+        changePolicy: number;
+        token: Address;
+        creator: Address;
+        cliffBps: number;
+        autoClaimIncentiveBps: number;
+        start: number;
+        end: number;
+        step: number;
+        canceledAt: number;
+        cliffReleaseTime: number;
+        claimGrace: number;
+        unwrapWETH: boolean;
+        weth: Address;
+    }>;
+    /**
+     * Get campaign state (totals and accounting)
+     */
+    getCampaignState(campaignId: bigint): Promise<{
+        totalAllocated: bigint;
+        totalClaimed: bigint;
+        nativeTips: bigint;
+        returned: bigint;
+        feeBuffer: bigint;
+        feeLoss: bigint;
+        totalFunded: bigint;
+        statusBits: number;
+        uniqueRecipients: bigint;
+    }>;
+    /**
+     * Get campaign status bits
+     */
+    getCampaignStatus(campaignId: bigint): Promise<number>;
+    /**
+     * Pause a campaign (creator or admin only)
+     *
+     * @param campaignId - Campaign ID
+     * @param reason - Pause reason as status bits (e.g., 1 for creator pause)
+     */
+    pause(campaignId: bigint, reason?: number): Promise<TransactionResult>;
+    /**
+     * Resume a paused campaign
+     *
+     * @param campaignId - Campaign ID
+     * @param clearBits - Status bits to clear (e.g., 1 for creator pause)
+     */
+    resume(campaignId: bigint, clearBits?: number): Promise<TransactionResult>;
+    /**
+     * Finalize a campaign (no more claims possible)
+     */
+    finalize(campaignId: bigint): Promise<TransactionResult>;
+    /**
+     * Cancel a campaign and return funds to creator
+     */
+    cancel(campaignId: bigint): Promise<TransactionResult>;
+    /**
+     * Change a recipient address (for blocked recipients)
+     */
+    changeRecipient(campaignId: bigint, fromAddress: Address, toAddress: Address): Promise<TransactionResult>;
+    /**
+     * Add recipients to an existing campaign
+     */
+    addRecipients(campaignId: bigint, recipients: Address[], amounts: bigint[], additionalBuffer?: bigint): Promise<TransactionResult>;
+    private requireWallet;
+    private changePolicyToEnum;
+    private parseCampaignSummary;
+    private createTransactionResult;
+}
+
+export { CampaignKind, CampaignsModule, ChangePolicy, CampaignsModule as default };