pepay-streams-sdk 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,170 @@
+import { Address, PublicClient, WalletClient } from 'viem';
+export { Address, Hash, Hex } from 'viem';
+import { P as PepayStreamsConfig, T as TransactionResult } from './index-BTG0TRJt.mjs';
+export { j as ApiCampaign, k as ApiOrder, l as ApiStakingPool, A as AutomationStatus, p as BaseCampaignParams, B as BatchClaimParams, C as CampaignInfo, b as ClaimParams, t as ClaimResult, d as CreateInstantOrderParams, q as CreatePoolParams, f as CreateTradableOrderParams, e as CreateVestedOrderParams, h as EnableAutoReleaseParams, E as EnableAutoWithdrawParams, I as InstantAirdropParams, L as LockParams, s as MerkleClaimParams, M as MetaClaimParams, O as OrderInfo, g as OrderQuote, r as OrderType, i as PaginatedResponse, c as PoolInfo, n as Recipient, R as RecipientStatus, o as RecipientWithCliff, m as TransactionReceipt, U as UserStake, V as VestedAirdropParams, a as VestingParams } from './index-BTG0TRJt.mjs';
+import CampaignsModule from './campaigns/index.mjs';
+import ClaimsModule from './claims/index.mjs';
+import StakingModule from './staking/index.mjs';
+import MarketplaceModule from './marketplace/index.mjs';
+import AutomationModule from './automation/index.mjs';
+import ApiClient from './api/index.mjs';
+export { ApiError } from './api/index.mjs';
+export { CampaignKind, ChangePolicy, DeliveryKind, OrderStatus, StartMode, StatusBits, Visibility } from '@pepay-streams/shared';
+
+/**
+ * Main Pepay Streams SDK Client
+ *
+ * Unified interface for all Pepay Streams operations:
+ * - Campaign creation and management
+ * - Token claiming
+ * - Staking pools
+ * - P2P marketplace
+ * - Automation
+ * - API queries
+ */
+
+declare global {
+    interface Window {
+        ethereum?: {
+            request: (args: {
+                method: string;
+            }) => Promise<Address[]>;
+        };
+    }
+}
+
+/**
+ * Pepay Streams SDK Client
+ *
+ * The main entry point for interacting with Pepay Streams protocol.
+ *
+ * @example
+ * ```typescript
+ * import { PepayStreamsClient } from '@pepay-streams/sdk';
+ *
+ * // Read-only client
+ * const client = new PepayStreamsClient({
+ *   rpcUrl: 'https://eth.llamarpc.com',
+ *   diamondAddress: '0x...',
+ *   chainId: 1,
+ * });
+ *
+ * // Client with signer (for transactions)
+ * const clientWithSigner = new PepayStreamsClient({
+ *   rpcUrl: 'https://eth.llamarpc.com',
+ *   diamondAddress: '0x...',
+ *   chainId: 1,
+ * }).withSigner(walletClient);
+ *
+ * // Or use browser wallet
+ * const browserClient = PepayStreamsClient.fromBrowserWallet({
+ *   diamondAddress: '0x...',
+ *   chainId: 1,
+ * });
+ * ```
+ */
+declare class PepayStreamsClient {
+    readonly publicClient: PublicClient;
+    readonly walletClient: WalletClient | undefined;
+    readonly diamondAddress: Address;
+    readonly chainId: number;
+    readonly wethAddress: Address;
+    readonly permit2Address: Address;
+    readonly campaigns: CampaignsModule;
+    readonly claims: ClaimsModule;
+    readonly staking: StakingModule;
+    readonly marketplace: MarketplaceModule;
+    readonly automation: AutomationModule;
+    readonly api: ApiClient | undefined;
+    constructor(config: PepayStreamsConfig);
+    /**
+     * Create a client with a wallet for signing transactions
+     */
+    withSigner(walletClient: WalletClient): PepayStreamsClientWithSigner;
+    /**
+     * Create a client from browser wallet (window.ethereum)
+     */
+    static fromBrowserWallet(config: {
+        diamondAddress: Address;
+        chainId: number;
+        apiBaseUrl?: string;
+    }): Promise<PepayStreamsClientWithSigner>;
+    /**
+     * Create a client with private key (for Node.js/scripts)
+     */
+    static fromPrivateKey(config: PepayStreamsConfig & {
+        privateKey: `0x${string}`;
+    }): PepayStreamsClientWithSigner;
+    /**
+     * Get token balance
+     */
+    getTokenBalance(token: Address, account: Address): Promise<bigint>;
+    /**
+     * Get token allowance for Diamond contract
+     */
+    getTokenAllowance(token: Address, owner: Address): Promise<bigint>;
+    /**
+     * Get token info (symbol, decimals, name)
+     */
+    getTokenInfo(token: Address): Promise<{
+        symbol: string;
+        decimals: number;
+        name: string;
+    }>;
+    /**
+     * Get version of a specific facet
+     *
+     * @param facetAddress - The address of the facet to query
+     */
+    getFacetVersion(facetAddress: Address): Promise<string>;
+    /**
+     * Get all facet versions
+     */
+    getAllVersions(): Promise<{
+        facets: Address[];
+        versions: string[];
+    }>;
+    /**
+     * Check if Diamond contract is in emergency pause
+     */
+    isEmergencyPaused(): Promise<boolean>;
+}
+/**
+ * Client with signer for write operations
+ */
+declare class PepayStreamsClientWithSigner extends PepayStreamsClient {
+    readonly walletClient: WalletClient;
+    readonly campaigns: CampaignsModule;
+    readonly claims: ClaimsModule;
+    readonly staking: StakingModule;
+    readonly marketplace: MarketplaceModule;
+    readonly automation: AutomationModule;
+    constructor(publicClient: PublicClient, walletClient: WalletClient, diamondAddress: Address, chainId: number, wethAddress: Address, permit2Address: Address, apiClient?: ApiClient);
+    /**
+     * Get the connected wallet address
+     */
+    get address(): Address;
+    /**
+     * Approve tokens for the Diamond contract
+     *
+     * @example
+     * ```typescript
+     * await client.approve(tokenAddress, parseEther('1000'));
+     * ```
+     */
+    approve(token: Address, amount: bigint): Promise<TransactionResult>;
+    /**
+     * Approve max tokens (type(uint256).max)
+     */
+    approveMax(token: Address): Promise<TransactionResult>;
+    /**
+     * Check and approve if needed
+     */
+    ensureAllowance(token: Address, requiredAmount: bigint): Promise<TransactionResult | null>;
+    /**
+     * Get native balance (ETH/BNB)
+     */
+    getNativeBalance(): Promise<bigint>;
+}
+
+export { ApiClient, AutomationModule, CampaignsModule, ClaimsModule, MarketplaceModule, PepayStreamsClient, PepayStreamsClientWithSigner, PepayStreamsConfig, StakingModule, TransactionResult };

package/dist/index.d.ts

@@ -0,0 +1,170 @@
+import { Address, PublicClient, WalletClient } from 'viem';
+export { Address, Hash, Hex } from 'viem';
+import { P as PepayStreamsConfig, T as TransactionResult } from './index-BTG0TRJt.js';
+export { j as ApiCampaign, k as ApiOrder, l as ApiStakingPool, A as AutomationStatus, p as BaseCampaignParams, B as BatchClaimParams, C as CampaignInfo, b as ClaimParams, t as ClaimResult, d as CreateInstantOrderParams, q as CreatePoolParams, f as CreateTradableOrderParams, e as CreateVestedOrderParams, h as EnableAutoReleaseParams, E as EnableAutoWithdrawParams, I as InstantAirdropParams, L as LockParams, s as MerkleClaimParams, M as MetaClaimParams, O as OrderInfo, g as OrderQuote, r as OrderType, i as PaginatedResponse, c as PoolInfo, n as Recipient, R as RecipientStatus, o as RecipientWithCliff, m as TransactionReceipt, U as UserStake, V as VestedAirdropParams, a as VestingParams } from './index-BTG0TRJt.js';
+import CampaignsModule from './campaigns/index.js';
+import ClaimsModule from './claims/index.js';
+import StakingModule from './staking/index.js';
+import MarketplaceModule from './marketplace/index.js';
+import AutomationModule from './automation/index.js';
+import ApiClient from './api/index.js';
+export { ApiError } from './api/index.js';
+export { CampaignKind, ChangePolicy, DeliveryKind, OrderStatus, StartMode, StatusBits, Visibility } from '@pepay-streams/shared';
+
+/**
+ * Main Pepay Streams SDK Client
+ *
+ * Unified interface for all Pepay Streams operations:
+ * - Campaign creation and management
+ * - Token claiming
+ * - Staking pools
+ * - P2P marketplace
+ * - Automation
+ * - API queries
+ */
+
+declare global {
+    interface Window {
+        ethereum?: {
+            request: (args: {
+                method: string;
+            }) => Promise<Address[]>;
+        };
+    }
+}
+
+/**
+ * Pepay Streams SDK Client
+ *
+ * The main entry point for interacting with Pepay Streams protocol.
+ *
+ * @example
+ * ```typescript
+ * import { PepayStreamsClient } from '@pepay-streams/sdk';
+ *
+ * // Read-only client
+ * const client = new PepayStreamsClient({
+ *   rpcUrl: 'https://eth.llamarpc.com',
+ *   diamondAddress: '0x...',
+ *   chainId: 1,
+ * });
+ *
+ * // Client with signer (for transactions)
+ * const clientWithSigner = new PepayStreamsClient({
+ *   rpcUrl: 'https://eth.llamarpc.com',
+ *   diamondAddress: '0x...',
+ *   chainId: 1,
+ * }).withSigner(walletClient);
+ *
+ * // Or use browser wallet
+ * const browserClient = PepayStreamsClient.fromBrowserWallet({
+ *   diamondAddress: '0x...',
+ *   chainId: 1,
+ * });
+ * ```
+ */
+declare class PepayStreamsClient {
+    readonly publicClient: PublicClient;
+    readonly walletClient: WalletClient | undefined;
+    readonly diamondAddress: Address;
+    readonly chainId: number;
+    readonly wethAddress: Address;
+    readonly permit2Address: Address;
+    readonly campaigns: CampaignsModule;
+    readonly claims: ClaimsModule;
+    readonly staking: StakingModule;
+    readonly marketplace: MarketplaceModule;
+    readonly automation: AutomationModule;
+    readonly api: ApiClient | undefined;
+    constructor(config: PepayStreamsConfig);
+    /**
+     * Create a client with a wallet for signing transactions
+     */
+    withSigner(walletClient: WalletClient): PepayStreamsClientWithSigner;
+    /**
+     * Create a client from browser wallet (window.ethereum)
+     */
+    static fromBrowserWallet(config: {
+        diamondAddress: Address;
+        chainId: number;
+        apiBaseUrl?: string;
+    }): Promise<PepayStreamsClientWithSigner>;
+    /**
+     * Create a client with private key (for Node.js/scripts)
+     */
+    static fromPrivateKey(config: PepayStreamsConfig & {
+        privateKey: `0x${string}`;
+    }): PepayStreamsClientWithSigner;
+    /**
+     * Get token balance
+     */
+    getTokenBalance(token: Address, account: Address): Promise<bigint>;
+    /**
+     * Get token allowance for Diamond contract
+     */
+    getTokenAllowance(token: Address, owner: Address): Promise<bigint>;
+    /**
+     * Get token info (symbol, decimals, name)
+     */
+    getTokenInfo(token: Address): Promise<{
+        symbol: string;
+        decimals: number;
+        name: string;
+    }>;
+    /**
+     * Get version of a specific facet
+     *
+     * @param facetAddress - The address of the facet to query
+     */
+    getFacetVersion(facetAddress: Address): Promise<string>;
+    /**
+     * Get all facet versions
+     */
+    getAllVersions(): Promise<{
+        facets: Address[];
+        versions: string[];
+    }>;
+    /**
+     * Check if Diamond contract is in emergency pause
+     */
+    isEmergencyPaused(): Promise<boolean>;
+}
+/**
+ * Client with signer for write operations
+ */
+declare class PepayStreamsClientWithSigner extends PepayStreamsClient {
+    readonly walletClient: WalletClient;
+    readonly campaigns: CampaignsModule;
+    readonly claims: ClaimsModule;
+    readonly staking: StakingModule;
+    readonly marketplace: MarketplaceModule;
+    readonly automation: AutomationModule;
+    constructor(publicClient: PublicClient, walletClient: WalletClient, diamondAddress: Address, chainId: number, wethAddress: Address, permit2Address: Address, apiClient?: ApiClient);
+    /**
+     * Get the connected wallet address
+     */
+    get address(): Address;
+    /**
+     * Approve tokens for the Diamond contract
+     *
+     * @example
+     * ```typescript
+     * await client.approve(tokenAddress, parseEther('1000'));
+     * ```
+     */
+    approve(token: Address, amount: bigint): Promise<TransactionResult>;
+    /**
+     * Approve max tokens (type(uint256).max)
+     */
+    approveMax(token: Address): Promise<TransactionResult>;
+    /**
+     * Check and approve if needed
+     */
+    ensureAllowance(token: Address, requiredAmount: bigint): Promise<TransactionResult | null>;
+    /**
+     * Get native balance (ETH/BNB)
+     */
+    getNativeBalance(): Promise<bigint>;
+}
+
+export { ApiClient, AutomationModule, CampaignsModule, ClaimsModule, MarketplaceModule, PepayStreamsClient, PepayStreamsClientWithSigner, PepayStreamsConfig, StakingModule, TransactionResult };