@clawnch/clawncher-sdk 2.0.0

package/dist/reader.d.ts

@@ -0,0 +1,248 @@
+/**
+ * ClawnchReader - Read on-chain token data from Clawncher contracts
+ *
+ * This class provides read-only access to token deployment info, vault allocations,
+ * vested dev buy allocations, fee configurations, and reward info.
+ *
+ * Used by frontends to display token detail pages and admin functionality.
+ */
+import { type PublicClient, type Address, type Chain } from 'viem';
+import { type NetworkName } from './addresses.js';
+/**
+ * Vault allocation info
+ */
+export interface VaultAllocation {
+    token: Address;
+    amountTotal: bigint;
+    amountClaimed: bigint;
+    lockupEndTime: bigint;
+    vestingEndTime: bigint;
+    admin: Address;
+    /** Amount currently available to claim */
+    amountAvailable: bigint;
+    /** Whether lockup has ended */
+    isUnlocked: boolean;
+    /** Whether fully vested */
+    isFullyVested: boolean;
+    /** Percentage vested (0-100) */
+    percentVested: number;
+}
+/**
+ * Vested dev buy allocation info
+ */
+export interface VestedDevBuyAllocation {
+    token: Address;
+    amountTotal: bigint;
+    amountClaimed: bigint;
+    lockupEndTime: bigint;
+    vestingEndTime: bigint;
+    admin: Address;
+    /** Amount currently available to claim */
+    amountAvailable: bigint;
+    /** Whether lockup has ended */
+    isUnlocked: boolean;
+    /** Whether fully vested */
+    isFullyVested: boolean;
+    /** Percentage vested (0-100) */
+    percentVested: number;
+}
+/**
+ * Reward recipient info from LP locker (read result)
+ */
+export interface RewardRecipientInfo {
+    recipient: Address;
+    admin: Address;
+    bps: number;
+}
+/**
+ * Token deployment info
+ */
+export interface TokenDeploymentInfo {
+    token: Address;
+    hook: Address;
+    locker: Address;
+    extensions: Address[];
+}
+/**
+ * Token reward info from LP locker
+ */
+export interface TokenRewardInfo {
+    token: Address;
+    poolKey: {
+        currency0: Address;
+        currency1: Address;
+        fee: number;
+        tickSpacing: number;
+        hooks: Address;
+    };
+    positionId: bigint;
+    numPositions: bigint;
+    rewardBps: number[];
+    rewardAdmins: Address[];
+    rewardRecipients: Address[];
+}
+/**
+ * MEV protection config (read result)
+ */
+export interface MevConfigInfo {
+    startingFee: number;
+    endingFee: number;
+    secondsToDecay: bigint;
+    poolStartTime: bigint;
+    /** Computed: poolStartTime + secondsToDecay */
+    decayEndTime: bigint;
+    currentFee: number;
+    isDecayComplete: boolean;
+}
+/**
+ * Full token details for UI
+ */
+export interface TokenDetails {
+    address: Address;
+    name: string;
+    symbol: string;
+    decimals: number;
+    totalSupply: bigint;
+    tokenAdmin: Address;
+    originalAdmin: Address;
+    image: string;
+    metadata: string;
+    context: string;
+    deployment: TokenDeploymentInfo;
+    rewards: TokenRewardInfo | null;
+    vault: VaultAllocation | null;
+    vestedDevBuy: VestedDevBuyAllocation | null;
+    mev: MevConfigInfo | null;
+}
+/**
+ * Fee info for a wallet across tokens
+ */
+export interface WalletFeeInfo {
+    wallet: Address;
+    tokens: Array<{
+        token: Address;
+        symbol: string;
+        availableFees: bigint;
+        formattedFees: string;
+    }>;
+    totalWeth: bigint;
+    formattedTotalWeth: string;
+}
+/**
+ * Reader configuration
+ */
+export interface ReaderConfig {
+    /** Public client for reading chain data */
+    publicClient: PublicClient;
+    /** Network to read from */
+    network: NetworkName;
+}
+/**
+ * ClawnchReader - Read on-chain token data
+ *
+ * @example
+ * ```typescript
+ * import { ClawnchReader } from '@clawnch/clawncher-sdk';
+ * import { createPublicClient, http } from 'viem';
+ * import { baseSepolia } from 'viem/chains';
+ *
+ * const publicClient = createPublicClient({
+ *   chain: baseSepolia,
+ *   transport: http(),
+ * });
+ *
+ * const reader = new ClawnchReader({
+ *   publicClient,
+ *   network: 'sepolia',
+ * });
+ *
+ * // Get full token details
+ * const details = await reader.getTokenDetails('0x...');
+ *
+ * // Get vault allocation
+ * const vault = await reader.getVaultAllocation('0x...');
+ *
+ * // Get vested dev buy allocation
+ * const vested = await reader.getVestedDevBuyAllocation('0x...');
+ * ```
+ */
+export declare class ClawnchReader {
+    readonly publicClient: PublicClient;
+    readonly network: NetworkName;
+    constructor(config: ReaderConfig);
+    /**
+     * Get contract addresses for configured network
+     */
+    getAddresses(): import("./addresses.js").NetworkAddresses;
+    /**
+     * Get the chain for the configured network
+     */
+    getChain(): Chain;
+    /**
+     * Get basic ERC20 token info
+     */
+    getTokenInfo(token: Address): Promise<{
+        name: string;
+        symbol: string;
+        decimals: number;
+        totalSupply: bigint;
+    }>;
+    /**
+     * Get Clawncher token metadata using allData() single call
+     *
+     * Returns originalAdmin, admin, imageUrl, metadata, context in one RPC call.
+     */
+    getTokenMetadata(token: Address): Promise<{
+        tokenAdmin: Address;
+        originalAdmin: Address;
+        image: string;
+        metadata: string;
+        context: string;
+    }>;
+    /**
+     * Get token deployment info from factory
+     */
+    getDeploymentInfo(token: Address): Promise<TokenDeploymentInfo | null>;
+    /**
+     * Get vault allocation for a token
+     */
+    getVaultAllocation(token: Address): Promise<VaultAllocation | null>;
+    /**
+     * Get vested dev buy allocation for a token
+     */
+    getVestedDevBuyAllocation(token: Address): Promise<VestedDevBuyAllocation | null>;
+    /**
+     * Get token reward info (recipients, positions) from LP locker
+     */
+    getTokenRewards(token: Address): Promise<TokenRewardInfo | null>;
+    /**
+     * Get available fees for a wallet on a specific token
+     */
+    getAvailableFees(wallet: Address, token: Address): Promise<bigint>;
+    /**
+     * Get all available fees for a wallet across multiple tokens
+     */
+    getWalletFees(wallet: Address, tokens: Address[]): Promise<WalletFeeInfo>;
+    /**
+     * Get MEV protection config for a pool by its poolId (bytes32)
+     *
+     * Use `getMevConfigForToken()` if you have a token address instead of poolId.
+     */
+    getMevConfig(poolId: `0x${string}`): Promise<MevConfigInfo | null>;
+    /**
+     * Get MEV protection config for a token (resolves poolId via LP locker first)
+     */
+    getMevConfigForToken(token: Address): Promise<MevConfigInfo | null>;
+    /**
+     * Get complete token details for UI display
+     *
+     * Combines basic token info, deployment info, vault, vested dev buy,
+     * reward recipients, and MEV config into a single response.
+     */
+    getTokenDetails(token: Address): Promise<TokenDetails | null>;
+    /**
+     * Check if a token was deployed via Clawncher
+     */
+    isClawnchToken(token: Address): Promise<boolean>;
+}
+//# sourceMappingURL=reader.d.ts.map

package/dist/reader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reader.d.ts","sourceRoot":"","sources":["../src/reader.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,OAAO,EACZ,KAAK,KAAK,EAEX,MAAM,MAAM,CAAC;AAYd,OAAO,EAAgB,KAAK,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAEhE;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,OAAO,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,OAAO,CAAC;IACf,0CAA0C;IAC1C,eAAe,EAAE,MAAM,CAAC;IACxB,+BAA+B;IAC/B,UAAU,EAAE,OAAO,CAAC;IACpB,2BAA2B;IAC3B,aAAa,EAAE,OAAO,CAAC;IACvB,gCAAgC;IAChC,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,OAAO,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,OAAO,CAAC;IACf,0CAA0C;IAC1C,eAAe,EAAE,MAAM,CAAC;IACxB,+BAA+B;IAC/B,UAAU,EAAE,OAAO,CAAC;IACpB,2BAA2B;IAC3B,aAAa,EAAE,OAAO,CAAC;IACvB,gCAAgC;IAChC,aAAa,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,OAAO,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,OAAO,CAAC;IACf,IAAI,EAAE,OAAO,CAAC;IACd,MAAM,EAAE,OAAO,CAAC;IAChB,UAAU,EAAE,OAAO,EAAE,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,EAAE;QACP,SAAS,EAAE,OAAO,CAAC;QACnB,SAAS,EAAE,OAAO,CAAC;QACnB,GAAG,EAAE,MAAM,CAAC;QACZ,WAAW,EAAE,MAAM,CAAC;QACpB,KAAK,EAAE,OAAO,CAAC;KAChB,CAAC;IACF,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,YAAY,EAAE,OAAO,EAAE,CAAC;IACxB,gBAAgB,EAAE,OAAO,EAAE,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,EAAE,MAAM,CAAC;IACtB,+CAA+C;IAC/C,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAE3B,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IAGpB,UAAU,EAAE,OAAO,CAAC;IACpB,aAAa,EAAE,OAAO,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAGhB,UAAU,EAAE,mBAAmB,CAAC;IAGhC,OAAO,EAAE,eAAe,GAAG,IAAI,CAAC;IAGhC,KAAK,EAAE,eAAe,GAAG,IAAI,CAAC;IAC9B,YAAY,EAAE,sBAAsB,GAAG,IAAI,CAAC;IAG5C,GAAG,EAAE,aAAa,GAAG,IAAI,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,KAAK,CAAC;QACZ,KAAK,EAAE,OAAO,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,aAAa,EAAE,MAAM,CAAC;QACtB,aAAa,EAAE,MAAM,CAAC;KACvB,CAAC,CAAC;IACH,SAAS,EAAE,MAAM,CAAC;IAClB,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,2CAA2C;IAC3C,YAAY,EAAE,YAAY,CAAC;IAC3B,2BAA2B;IAC3B,OAAO,EAAE,WAAW,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,qBAAa,aAAa;IACxB,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IACpC,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC;gBAElB,MAAM,EAAE,YAAY;IAKhC;;OAEG;IACH,YAAY;IAIZ;;OAEG;IACH,QAAQ,IAAI,KAAK;IAQjB;;OAEG;IACG,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC;QAC1C,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;IA2BF;;;;OAIG;IACG,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC;QAC9C,UAAU,EAAE,OAAO,CAAC;QACpB,aAAa,EAAE,OAAO,CAAC;QACvB,KAAK,EAAE,MAAM,CAAC;QACd,QAAQ,EAAE,MAAM,CAAC;QACjB,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IAqDF;;OAEG;IACG,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC;IAiC5E;;OAEG;IACG,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IA6DzE;;OAEG;IACG,yBAAyB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,sBAAsB,GAAG,IAAI,CAAC;IAkEvF;;OAEG;IACG,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC;IAyCtE;;OAEG;IACG,gBAAgB,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC;IAiBxE;;OAEG;IACG,aAAa,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,aAAa,CAAC;IAsC/E;;;;OAIG;IACG,YAAY,CAAC,MAAM,EAAE,KAAK,MAAM,EAAE,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC;IAkDxE;;OAEG;IACG,oBAAoB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC;IA2BzE;;;;;OAKG;IACG,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;IAqCnE;;OAEG;IACG,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;CAIvD"}