pepay-streams-sdk 0.1.0

package/dist/campaigns/index.js

@@ -0,0 +1,652 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var viem = require('viem');
+var diamond = require('@pepay-streams/abi/diamond');
+
+// src/campaigns/index.ts
+var CampaignKind = /* @__PURE__ */ ((CampaignKind2) => {
+  CampaignKind2[CampaignKind2["INSTANT"] = 0] = "INSTANT";
+  CampaignKind2[CampaignKind2["VESTED"] = 1] = "VESTED";
+  CampaignKind2[CampaignKind2["LOCK"] = 2] = "LOCK";
+  CampaignKind2[CampaignKind2["VESTING"] = 3] = "VESTING";
+  return CampaignKind2;
+})(CampaignKind || {});
+var ChangePolicy = /* @__PURE__ */ ((ChangePolicy2) => {
+  ChangePolicy2[ChangePolicy2["ONLY_RECIPIENT"] = 0] = "ONLY_RECIPIENT";
+  ChangePolicy2[ChangePolicy2["ONLY_CREATOR"] = 1] = "ONLY_CREATOR";
+  ChangePolicy2[ChangePolicy2["BOTH"] = 2] = "BOTH";
+  ChangePolicy2[ChangePolicy2["NO_ONE"] = 3] = "NO_ONE";
+  return ChangePolicy2;
+})(ChangePolicy || {});
+var CampaignsModule = class {
+  constructor(publicClient, walletClient, diamondAddress) {
+    this.publicClient = publicClient;
+    this.walletClient = walletClient;
+    this.diamondAddress = diamondAddress;
+  }
+  // ============================================================================
+  // Campaign Creation
+  // ============================================================================
+  /**
+   * 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);
+   * ```
+   */
+  async createInstantAirdrop(params) {
+    const wallet = this.requireWallet();
+    const recipients = params.recipients.map((r) => r.address);
+    const amounts = params.recipients.map((r) => r.amount);
+    const now = BigInt(Math.floor(Date.now() / 1e3));
+    const args = {
+      kind: 0 /* INSTANT */,
+      token: params.token,
+      start: now,
+      end: now,
+      // Instant airdrop - same start/end
+      step: 0n,
+      cliffReleaseTime: 0n,
+      cliffBps: 0,
+      autoClaimIncentiveBps: params.autoClaimIncentiveBps ?? 0,
+      cancelable: params.cancelable ?? true,
+      claimOnce: params.claimOnce ?? true,
+      changePolicy: this.changePolicyToEnum(params.changePolicy),
+      claimGrace: BigInt(params.claimGrace ?? 0),
+      recipients,
+      amounts,
+      feeBuffer: params.feeBuffer ?? 0n,
+      attachDefaultRegistry: params.attachDefaultRegistry ?? false,
+      unwrapWETH: params.unwrapWETH ?? false,
+      weth: params.weth ?? viem.zeroAddress
+    };
+    const hash = await wallet.writeContract({
+      chain: wallet.chain,
+      account: wallet.account,
+      address: this.diamondAddress,
+      abi: diamond.DIAMOND_ABI,
+      functionName: "createCampaign",
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      args: [args]
+    });
+    return this.createTransactionResult(hash);
+  }
+  /**
+   * 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
+   * });
+   * ```
+   */
+  async createVestedAirdrop(params) {
+    const wallet = this.requireWallet();
+    const recipients = params.recipients.map((r) => r.address);
+    const amounts = params.recipients.map((r) => r.amount);
+    const startTime = BigInt(params.startTime);
+    const endTime = startTime + BigInt(params.duration);
+    const steps = params.steps ?? 1;
+    const step = steps > 1 ? BigInt(params.duration) / BigInt(steps) : 0n;
+    const cliffReleaseTime = params.cliffDuration ? startTime + BigInt(params.cliffDuration) : 0n;
+    const args = {
+      kind: 1 /* VESTED */,
+      token: params.token,
+      start: startTime,
+      end: endTime,
+      step,
+      cliffReleaseTime,
+      cliffBps: params.cliffBps ?? 0,
+      autoClaimIncentiveBps: params.autoClaimIncentiveBps ?? 0,
+      cancelable: params.cancelable ?? true,
+      claimOnce: false,
+      // Vested can claim multiple times
+      changePolicy: this.changePolicyToEnum(params.changePolicy),
+      claimGrace: BigInt(params.claimGrace ?? 0),
+      recipients,
+      amounts,
+      feeBuffer: params.feeBuffer ?? 0n,
+      attachDefaultRegistry: params.attachDefaultRegistry ?? false,
+      unwrapWETH: params.unwrapWETH ?? false,
+      weth: params.weth ?? viem.zeroAddress
+    };
+    const hash = await wallet.writeContract({
+      chain: wallet.chain,
+      account: wallet.account,
+      address: this.diamondAddress,
+      abi: diamond.DIAMOND_ABI,
+      functionName: "createCampaign",
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      args: [args]
+    });
+    return this.createTransactionResult(hash);
+  }
+  /**
+   * 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
+   * });
+   * ```
+   */
+  async createLock(params) {
+    const wallet = this.requireWallet();
+    const now = BigInt(Math.floor(Date.now() / 1e3));
+    const unlockTime = BigInt(params.unlockTime);
+    const args = {
+      kind: 2 /* LOCK */,
+      token: params.token,
+      start: now,
+      end: unlockTime,
+      step: 0n,
+      cliffReleaseTime: unlockTime,
+      // Lock releases at this time
+      cliffBps: 1e4,
+      // 100% released at cliff
+      autoClaimIncentiveBps: 0,
+      cancelable: params.cancelable ?? false,
+      claimOnce: true,
+      changePolicy: this.changePolicyToEnum(params.changePolicy),
+      claimGrace: 0n,
+      recipients: [params.recipient],
+      amounts: [params.amount],
+      feeBuffer: params.feeBuffer ?? 0n,
+      attachDefaultRegistry: false,
+      unwrapWETH: params.unwrapWETH ?? false,
+      weth: params.weth ?? viem.zeroAddress
+    };
+    const hash = await wallet.writeContract({
+      chain: wallet.chain,
+      account: wallet.account,
+      address: this.diamondAddress,
+      abi: diamond.DIAMOND_ABI,
+      functionName: "createCampaign",
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      args: [args]
+    });
+    return this.createTransactionResult(hash);
+  }
+  /**
+   * 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
+   * });
+   * ```
+   */
+  async createVesting(params) {
+    const wallet = this.requireWallet();
+    const startTime = BigInt(params.startTime);
+    const endTime = startTime + BigInt(params.duration);
+    const steps = params.steps ?? 1;
+    const step = steps > 1 ? BigInt(params.duration) / BigInt(steps) : 0n;
+    const cliffReleaseTime = params.cliffDuration ? startTime + BigInt(params.cliffDuration) : 0n;
+    const args = {
+      kind: 3 /* VESTING */,
+      token: params.token,
+      start: startTime,
+      end: endTime,
+      step,
+      cliffReleaseTime,
+      cliffBps: params.cliffBps ?? 0,
+      autoClaimIncentiveBps: params.autoClaimIncentiveBps ?? 0,
+      cancelable: params.cancelable ?? true,
+      claimOnce: false,
+      changePolicy: this.changePolicyToEnum(params.changePolicy),
+      claimGrace: BigInt(params.claimGrace ?? 0),
+      recipients: [params.recipient],
+      amounts: [params.amount],
+      feeBuffer: params.feeBuffer ?? 0n,
+      attachDefaultRegistry: false,
+      unwrapWETH: params.unwrapWETH ?? false,
+      weth: params.weth ?? viem.zeroAddress
+    };
+    const hash = await wallet.writeContract({
+      chain: wallet.chain,
+      account: wallet.account,
+      address: this.diamondAddress,
+      abi: diamond.DIAMOND_ABI,
+      functionName: "createCampaign",
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      args: [args]
+    });
+    return this.createTransactionResult(hash);
+  }
+  /**
+   * Create a campaign with raw CreateArgs
+   *
+   * Low-level function for full control over campaign parameters.
+   */
+  async createCampaign(args) {
+    const wallet = this.requireWallet();
+    const hash = await wallet.writeContract({
+      chain: wallet.chain,
+      account: wallet.account,
+      address: this.diamondAddress,
+      abi: diamond.DIAMOND_ABI,
+      functionName: "createCampaign",
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      args: [args]
+    });
+    return this.createTransactionResult(hash);
+  }
+  // ============================================================================
+  // Campaign Funding
+  // ============================================================================
+  /**
+   * 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...',
+   * });
+   * ```
+   */
+  async fundWithPermit(params) {
+    const wallet = this.requireWallet();
+    const hash = await wallet.writeContract({
+      chain: wallet.chain,
+      account: wallet.account,
+      address: this.diamondAddress,
+      abi: diamond.DIAMOND_ABI,
+      functionName: "fundWithPermit",
+      args: [
+        params.campaignId,
+        params.amount,
+        params.deadline,
+        params.v,
+        params.r,
+        params.s
+      ]
+    });
+    return this.createTransactionResult(hash);
+  }
+  /**
+   * Fund a campaign using Permit2 (gasless approval)
+   *
+   * @example
+   * ```typescript
+   * const result = await sdk.campaigns.fundWithPermit2({
+   *   campaignId,
+   *   from: userAddress,
+   *   amount: parseEther('1000'),
+   *   permit2Data: encodedPermit2Data,
+   * });
+   * ```
+   */
+  async fundWithPermit2(params) {
+    const wallet = this.requireWallet();
+    const hash = await wallet.writeContract({
+      chain: wallet.chain,
+      account: wallet.account,
+      address: this.diamondAddress,
+      abi: diamond.DIAMOND_ABI,
+      functionName: "fundWithPermit2",
+      args: [
+        params.campaignId,
+        params.from,
+        params.amount,
+        params.permit2Data
+      ]
+    });
+    return this.createTransactionResult(hash);
+  }
+  /**
+   * Return leftover tokens to creator
+   *
+   * @example
+   * ```typescript
+   * const result = await sdk.campaigns.returnLeftover(campaignId, parseEther('100'));
+   * ```
+   */
+  async returnLeftover(campaignId, amountToReturn) {
+    const wallet = this.requireWallet();
+    const hash = await wallet.writeContract({
+      chain: wallet.chain,
+      account: wallet.account,
+      address: this.diamondAddress,
+      abi: diamond.DIAMOND_ABI,
+      functionName: "returnLeftover",
+      args: [campaignId, amountToReturn]
+    });
+    return this.createTransactionResult(hash);
+  }
+  /**
+   * Add native tips to a campaign for automation
+   */
+  async addNativeTips(campaignId, tipAmount) {
+    const wallet = this.requireWallet();
+    const hash = await wallet.writeContract({
+      chain: wallet.chain,
+      account: wallet.account,
+      address: this.diamondAddress,
+      abi: diamond.DIAMOND_ABI,
+      functionName: "addNativeTips",
+      args: [campaignId, tipAmount],
+      value: tipAmount
+    });
+    return this.createTransactionResult(hash);
+  }
+  // ============================================================================
+  // Campaign Queries
+  // ============================================================================
+  /**
+   * 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);
+   * ```
+   */
+  async getCampaign(campaignId) {
+    const result = await this.publicClient.readContract({
+      address: this.diamondAddress,
+      abi: diamond.DIAMOND_ABI,
+      functionName: "campaignSummary",
+      args: [campaignId]
+    });
+    return this.parseCampaignSummary(campaignId, result);
+  }
+  /**
+   * Get campaign configuration only
+   */
+  async getCampaignConfig(campaignId) {
+    const result = await this.publicClient.readContract({
+      address: this.diamondAddress,
+      abi: diamond.DIAMOND_ABI,
+      functionName: "campaignConfig",
+      args: [campaignId]
+    });
+    return {
+      kind: Number(result.kind),
+      cancelable: Boolean(result.cancelable),
+      claimOnce: Boolean(result.claimOnce),
+      canceled: Boolean(result.canceled),
+      changePolicy: Number(result.changePolicy),
+      token: result.token,
+      creator: result.creator,
+      cliffBps: Number(result.cliffBps),
+      autoClaimIncentiveBps: Number(result.autoClaimIncentiveBps),
+      start: Number(result.start),
+      end: Number(result.end),
+      step: Number(result.step),
+      canceledAt: Number(result.canceledAt),
+      cliffReleaseTime: Number(result.cliffReleaseTime),
+      claimGrace: Number(result.claimGrace),
+      unwrapWETH: Boolean(result.unwrapWETH),
+      weth: result.weth
+    };
+  }
+  /**
+   * Get campaign state (totals and accounting)
+   */
+  async getCampaignState(campaignId) {
+    const result = await this.publicClient.readContract({
+      address: this.diamondAddress,
+      abi: diamond.DIAMOND_ABI,
+      functionName: "campaignState",
+      args: [campaignId]
+    });
+    return {
+      totalAllocated: result.totalAllocated,
+      totalClaimed: result.totalClaimed,
+      nativeTips: result.nativeTips,
+      returned: result.returned,
+      feeBuffer: result.feeBuffer,
+      feeLoss: result.feeLoss,
+      totalFunded: result.totalFunded,
+      statusBits: Number(result.statusBits),
+      uniqueRecipients: result.uniqueRecipients
+    };
+  }
+  /**
+   * Get campaign status bits
+   */
+  async getCampaignStatus(campaignId) {
+    const result = await this.publicClient.readContract({
+      address: this.diamondAddress,
+      abi: diamond.DIAMOND_ABI,
+      functionName: "campaignStatus",
+      args: [campaignId]
+    });
+    return Number(result);
+  }
+  // ============================================================================
+  // Campaign Administration
+  // ============================================================================
+  /**
+   * Pause a campaign (creator or admin only)
+   *
+   * @param campaignId - Campaign ID
+   * @param reason - Pause reason as status bits (e.g., 1 for creator pause)
+   */
+  async pause(campaignId, reason = 1) {
+    const wallet = this.requireWallet();
+    const hash = await wallet.writeContract({
+      chain: wallet.chain,
+      account: wallet.account,
+      address: this.diamondAddress,
+      abi: diamond.DIAMOND_ABI,
+      functionName: "pauseCampaign",
+      args: [campaignId, reason]
+    });
+    return this.createTransactionResult(hash);
+  }
+  /**
+   * Resume a paused campaign
+   *
+   * @param campaignId - Campaign ID
+   * @param clearBits - Status bits to clear (e.g., 1 for creator pause)
+   */
+  async resume(campaignId, clearBits = 1) {
+    const wallet = this.requireWallet();
+    const hash = await wallet.writeContract({
+      chain: wallet.chain,
+      account: wallet.account,
+      address: this.diamondAddress,
+      abi: diamond.DIAMOND_ABI,
+      functionName: "resumeCampaign",
+      args: [campaignId, clearBits]
+    });
+    return this.createTransactionResult(hash);
+  }
+  /**
+   * Finalize a campaign (no more claims possible)
+   */
+  async finalize(campaignId) {
+    const wallet = this.requireWallet();
+    const hash = await wallet.writeContract({
+      chain: wallet.chain,
+      account: wallet.account,
+      address: this.diamondAddress,
+      abi: diamond.DIAMOND_ABI,
+      functionName: "finalizeCampaign",
+      args: [campaignId]
+    });
+    return this.createTransactionResult(hash);
+  }
+  /**
+   * Cancel a campaign and return funds to creator
+   */
+  async cancel(campaignId) {
+    const wallet = this.requireWallet();
+    const hash = await wallet.writeContract({
+      chain: wallet.chain,
+      account: wallet.account,
+      address: this.diamondAddress,
+      abi: diamond.DIAMOND_ABI,
+      functionName: "cancel",
+      args: [campaignId]
+    });
+    return this.createTransactionResult(hash);
+  }
+  /**
+   * Change a recipient address (for blocked recipients)
+   */
+  async changeRecipient(campaignId, fromAddress, toAddress) {
+    const wallet = this.requireWallet();
+    const hash = await wallet.writeContract({
+      chain: wallet.chain,
+      account: wallet.account,
+      address: this.diamondAddress,
+      abi: diamond.DIAMOND_ABI,
+      functionName: "changeRecipient",
+      args: [campaignId, fromAddress, toAddress]
+    });
+    return this.createTransactionResult(hash);
+  }
+  /**
+   * Add recipients to an existing campaign
+   */
+  async addRecipients(campaignId, recipients, amounts, additionalBuffer = 0n) {
+    const wallet = this.requireWallet();
+    const hash = await wallet.writeContract({
+      chain: wallet.chain,
+      account: wallet.account,
+      address: this.diamondAddress,
+      abi: diamond.DIAMOND_ABI,
+      functionName: "addRecipients",
+      args: [campaignId, recipients, amounts, additionalBuffer]
+    });
+    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;
+  }
+  changePolicyToEnum(policy) {
+    switch (policy) {
+      case "only_recipient":
+        return 0 /* ONLY_RECIPIENT */;
+      case "only_creator":
+        return 1 /* ONLY_CREATOR */;
+      case "both":
+        return 2 /* BOTH */;
+      case "no_one":
+        return 3 /* NO_ONE */;
+      default:
+        return 0 /* ONLY_RECIPIENT */;
+    }
+  }
+  parseCampaignSummary(id, data) {
+    const cfg = data.cfg;
+    const state = data.state;
+    const kindMap = {
+      0: "instant_airdrop",
+      1: "vested_airdrop",
+      2: "lock",
+      3: "vesting"
+    };
+    const kind = Number(cfg.kind);
+    const result = {
+      id,
+      kind: kindMap[kind] ?? "instant_airdrop",
+      token: cfg.token,
+      creator: cfg.creator,
+      name: "",
+      // Not stored on-chain
+      totalAllocated: state.totalAllocated,
+      totalFunded: state.totalFunded,
+      totalClaimed: state.totalClaimed,
+      totalReturned: state.returned,
+      feeLoss: state.feeLoss,
+      feeBuffer: state.feeBuffer,
+      startTime: Number(cfg.start),
+      endTime: Number(cfg.end),
+      cliffTime: Number(cfg.cliffReleaseTime),
+      steps: Number(cfg.step) > 0 ? Math.ceil((Number(cfg.end) - Number(cfg.start)) / Number(cfg.step)) : 1,
+      recipientCount: Number(state.uniqueRecipients),
+      statusBits: Number(state.statusBits),
+      changePolicy: Number(cfg.changePolicy),
+      hasAutomation: (Number(state.statusBits) & 1 << 5) !== 0
+    };
+    if (data.hasRegistry) {
+      result.hasRegistry = true;
+    }
+    if (data.merkleRoot) {
+      result.merkleRoot = data.merkleRoot;
+    }
+    return result;
+  }
+  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 campaigns_default = CampaignsModule;
+
+exports.CampaignKind = CampaignKind;
+exports.CampaignsModule = CampaignsModule;
+exports.ChangePolicy = ChangePolicy;
+exports.default = campaigns_default;
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map