pepay-streams-sdk 0.1.0

package/dist/campaigns/index.d.ts

@@ -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.js';
+
+/**
+ * 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 };