levr-sdk 0.3.1 → 0.5.0-alpha.10

package/dist/esm/packages/clanker-sdk/src/utils/merkleTree.js

@@ -0,0 +1,37 @@
+import { StandardMerkleTree } from '@openzeppelin/merkle-tree';
+import { encodeAbiParameters } from 'viem';
+const TOKEN_DECIMALS = 18n;
+/**
+ * Converts a human-readable amount to token decimals (e.g., 1 -> 1e18)
+ * @param amount The human-readable amount
+ * @returns The amount in token decimals as a bigint
+ */
+export function toTokenDecimals(amount) {
+    return BigInt(amount) * 10n ** TOKEN_DECIMALS;
+}
+export function createMerkleTree(entries) {
+    // Convert entries to the format expected by OpenZeppelin's MerkleTree
+    const values = entries.map((entry) => [
+        entry.account.toLowerCase(),
+        toTokenDecimals(entry.amount).toString(),
+    ]);
+    // Create the Merkle tree
+    const tree = StandardMerkleTree.of(values, ['address', 'uint256']);
+    // Get the root and ensure it's a proper bytes32 value
+    const root = tree.root;
+    return { tree, root, entries: values };
+}
+export function getMerkleProof(tree, entries, account, amount) {
+    const amountInDecimals = toTokenDecimals(amount);
+    const leaf = [account.toLowerCase(), amountInDecimals.toString()];
+    const index = entries.findIndex(([addr, amt]) => addr === leaf[0] && amt === leaf[1]);
+    if (index === -1) {
+        throw new Error('Entry not found in Merkle tree');
+    }
+    const proof = tree.getProof(index);
+    return proof.map((p) => p);
+}
+export function encodeAirdropData(merkleRoot, lockupDuration, vestingDuration) {
+    return encodeAbiParameters([{ type: 'bytes32' }, { type: 'uint256' }, { type: 'uint256' }], [merkleRoot, BigInt(lockupDuration), BigInt(vestingDuration)]);
+}
+//# sourceMappingURL=merkleTree.js.map

package/dist/esm/packages/clanker-sdk/src/utils/merkleTree.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"merkleTree.js","sourceRoot":"","sources":["../../../../../../packages/clanker-sdk/src/utils/merkleTree.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,mBAAmB,EAAE,MAAM,MAAM,CAAC;AAO3C,MAAM,cAAc,GAAG,GAAG,CAAC;AAE3B;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,MAAc;IAC5C,OAAO,MAAM,CAAC,MAAM,CAAC,GAAG,GAAG,IAAI,cAAc,CAAC;AAChD,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,OAAuB;IAKtD,sEAAsE;IACtE,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC;QACpC,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE;QAC3B,eAAe,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE;KACzC,CAAuB,CAAC;IAEzB,yBAAyB;IACzB,MAAM,IAAI,GAAG,kBAAkB,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;IAEnE,sDAAsD;IACtD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAqB,CAAC;IAExC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;AACzC,CAAC;AAED,MAAM,UAAU,cAAc,CAC5B,IAA0C,EAC1C,OAA2B,EAC3B,OAAsB,EACtB,MAAc;IAEd,MAAM,gBAAgB,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;IACjD,MAAM,IAAI,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,gBAAgB,CAAC,QAAQ,EAAE,CAAqB,CAAC;IACtF,MAAM,KAAK,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAEtF,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;QACjB,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACpD,CAAC;IAED,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACnC,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAkB,CAAC,CAAC;AAC9C,CAAC;AAED,MAAM,UAAU,iBAAiB,CAC/B,UAAyB,EACzB,cAAsB,EACtB,eAAuB;IAEvB,OAAO,mBAAmB,CACxB,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,EAC/D,CAAC,UAAU,EAAE,MAAM,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC,eAAe,CAAC,CAAC,CAC9D,CAAC;AACJ,CAAC"}

package/dist/esm/packages/clanker-sdk/src/utils/meta.js

@@ -0,0 +1,9 @@
+/**
+ * Use in switch statements or other scenarios to add type-safety to the overall pattern. This can be used
+ * to ensure that every possibility is enumerated in the switch statement and cause the code to refuse
+ * compilation unless all possibilities are covered.
+ */
+export function exhaustiveGuard(_value) {
+    throw new Error(`ERROR! Reached forbidden guard function with unexpected value: ${_value}`);
+}
+//# sourceMappingURL=meta.js.map

package/dist/esm/packages/clanker-sdk/src/utils/meta.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"meta.js","sourceRoot":"","sources":["../../../../../../packages/clanker-sdk/src/utils/meta.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,MAAa;IAC3C,MAAM,IAAI,KAAK,CAAC,kEAAkE,MAAM,EAAE,CAAC,CAAC;AAC9F,CAAC"}

package/dist/esm/packages/clanker-sdk/src/utils/write-clanker-contracts.js

@@ -0,0 +1,70 @@
+import { estimateContractGas, simulateContract, writeContract } from "viem/actions";
+import { understandError } from "./errors.js";
+/**
+ * Estimate gas for a clanker contract call and attempt to parse any errors
+ *
+ * @param client Public client to run the simulation via
+ * @param account Account (caller) to run the simulation from
+ * @param tx Transaction to run
+ * @returns Gas amount or errors from the estimation
+ */
+export const estimateGasClankerContract = async (client, account, tx) => {
+    try {
+        const gas = await estimateContractGas(client, {
+            ...tx,
+            account,
+            // biome-ignore lint: It's difficult to type tx correctly
+        });
+        return { gas };
+    }
+    catch (e) {
+        return { error: understandError(e) };
+    }
+};
+/**
+ * Simulate a clanker contract and attempt to parse any errors.
+ *
+ * @param client Public client to run the simulation via
+ * @param account Account (caller) to run the simulation from
+ * @param tx Transaction to run
+ * @returns Result or errors from the simulation
+ */
+export const simulateClankerContract = async (client, account, tx) => {
+    try {
+        const result = await simulateContract(client, {
+            ...tx,
+            account,
+            // biome-ignore lint: It's difficult to type tx correctly
+        });
+        return result;
+    }
+    catch (e) {
+        return { error: understandError(e) };
+    }
+};
+/**
+ * Execute a clanker contract and attempt to parse any errors.
+ *
+ * @param client Public client to run the simulation via
+ * @param wallet Wallet to execute the call from
+ * @param tx Transaction to submit
+ * @param options
+ * @returns Transaction hash or any errors
+ */
+export const writeClankerContract = async (client, wallet, tx, options) => {
+    if (options?.simulate) {
+        const { error } = await simulateClankerContract(client, wallet.account, tx);
+        if (error) {
+            return { error };
+        }
+    }
+    try {
+        // biome-ignore lint: It's difficult to type tx correctly
+        const txHash = await writeContract(wallet, tx);
+        return { txHash };
+    }
+    catch (e) {
+        return { error: understandError(e) };
+    }
+};
+//# sourceMappingURL=write-clanker-contracts.js.map

package/dist/esm/packages/clanker-sdk/src/utils/write-clanker-contracts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"write-clanker-contracts.js","sourceRoot":"","sources":["../../../../../../packages/clanker-sdk/src/utils/write-clanker-contracts.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAEnF,OAAO,EAAqB,eAAe,EAAE,MAAM,UAAU,CAAA;AAgC7D;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,KAAK,EAM7C,MAAoB,EACpB,OAAgB,EAChB,EAAiC,EACD,EAAE;IAClC,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,mBAAmB,CAAC,MAAM,EAAE;YAC5C,GAAG,EAAE;YACL,OAAO;YACP,yDAAyD;SACnD,CAAC,CAAA;QACT,OAAO,EAAE,GAAG,EAAE,CAAA;IAChB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,EAAE,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,CAAA;IACtC,CAAC;AACH,CAAC,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,KAAK,EAM1C,MAAoB,EACpB,OAAgB,EAChB,EAAiC,EAC6B,EAAE;IAChE,IAAI,CAAC;QACH,MAAM,MAAM,GAAkD,MAAM,gBAAgB,CAAC,MAAM,EAAE;YAC3F,GAAG,EAAE;YACL,OAAO;YACP,yDAAyD;SACnD,CAAC,CAAA;QACT,OAAO,MAAM,CAAA;IACf,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,EAAE,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,CAAA;IACtC,CAAC;AACH,CAAC,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK,EAKvC,MAAoB,EACpB,MAAiD,EACjD,EAAiC,EACjC,OAEC,EACyC,EAAE;IAC5C,IAAI,OAAO,EAAE,QAAQ,EAAE,CAAC;QACtB,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,uBAAuB,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;QAC3E,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,EAAE,KAAK,EAAE,CAAA;QAClB,CAAC;IACH,CAAC;IAED,IAAI,CAAC;QACH,yDAAyD;QACzD,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,MAAM,EAAE,EAAS,CAAC,CAAA;QACrD,OAAO,EAAE,MAAM,EAAE,CAAA;IACnB,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,EAAE,KAAK,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,CAAA;IACtC,CAAC;AACH,CAAC,CAAA"}

package/dist/esm/packages/clanker-sdk/src/utils/zod-onchain.js

@@ -0,0 +1,39 @@
+import { getAddress, isAddress, isHex } from 'viem';
+import * as z from 'zod/v4';
+/** Metadata for a Clanker. */
+export const ClankerMetadataSchema = z.strictObject({
+    /** Description of the token or token project. */
+    description: z.string().optional(),
+    /** Socials for the token. These may be displayed on aggregators. */
+    socialMediaUrls: z.array(z.object({ platform: z.string(), url: z.string() })).optional(),
+    /** Audits for other contracts or services offered by the project. */
+    auditUrls: z.array(z.url()).optional(),
+});
+/** Social provenance for a Clanker. Used for provenance and will be verified by aggregators. */
+export const ClankerContextSchema = z.strictObject({
+    /** System the token was deployed via. Defaults to "SDK". */
+    interface: z.string().default('SDK'),
+    /** Social platform the token was deployed from. Used for provenance and will be verified by aggregators. */
+    platform: z.string().optional(),
+    /** Id of the message on the social platform the token was deployed from. Used for provenance and will be verified by aggregators. */
+    messageId: z.string().optional(),
+    /** User id of the poster on the social platform the token was deployed from. Used for provenance and will be verified by aggregators. */
+    id: z.string().optional(),
+});
+/** Validate a hex string */
+export const hexSchema = z.custom((val) => {
+    if (!(typeof val === 'string'))
+        return false;
+    if (!isHex(val))
+        return false;
+    return val;
+}, 'String must be valid hex.');
+/** Validate an EVM address */
+export const addressSchema = z.custom((val) => {
+    if (!(typeof val === 'string'))
+        return false;
+    if (!isAddress(val))
+        return false;
+    return getAddress(val);
+}, 'String must be a valid address.');
+//# sourceMappingURL=zod-onchain.js.map

package/dist/esm/packages/clanker-sdk/src/utils/zod-onchain.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"zod-onchain.js","sourceRoot":"","sources":["../../../../../../packages/clanker-sdk/src/utils/zod-onchain.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AACpD,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAE5B,8BAA8B;AAC9B,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,YAAY,CAAC;IAClD,iDAAiD;IACjD,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,oEAAoE;IACpE,eAAe,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;IACxF,qEAAqE;IACrE,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE;CACvC,CAAC,CAAC;AAEH,gGAAgG;AAChG,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,YAAY,CAAC;IACjD,4DAA4D;IAC5D,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;IACpC,4GAA4G;IAC5G,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,qIAAqI;IACrI,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAChC,yIAAyI;IACzI,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC1B,CAAC,CAAC;AAEH,4BAA4B;AAC5B,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,CAAgB,CAAC,GAAG,EAAE,EAAE;IACvD,IAAI,CAAC,CAAC,OAAO,GAAG,KAAK,QAAQ,CAAC;QAAE,OAAO,KAAK,CAAC;IAC7C,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC;IAC9B,OAAO,GAAG,CAAC;AACb,CAAC,EAAE,2BAA2B,CAAC,CAAC;AAEhC,8BAA8B;AAC9B,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAgB,CAAC,GAAG,EAAE,EAAE;IAC3D,IAAI,CAAC,CAAC,OAAO,GAAG,KAAK,QAAQ,CAAC;QAAE,OAAO,KAAK,CAAC;IAC7C,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC;IAClC,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC,EAAE,iCAAiC,CAAC,CAAC"}

package/dist/esm/packages/clanker-sdk/src/v3/index.js

@@ -0,0 +1,151 @@
+import { Clanker_v3_1_abi } from "../abi/v3.1/Clanker.js";
+import { LpLockerv2_abi } from "../abi/v3.1/LpLockerv2.js";
+import { clankerTokenV3Converter } from "../config/clankerTokenV3.js";
+import { deployToken, simulateDeployToken } from "../deployment/deploy.js";
+import { CLANKERS } from "../utils/clankers.js";
+import { simulateClankerContract, writeClankerContract, } from "../utils/write-clanker-contracts.js";
+/**
+ * Clanker v3
+ */
+export class Clanker {
+    wallet;
+    publicClient;
+    constructor(config) {
+        this.wallet = config?.wallet;
+        this.publicClient = config?.publicClient;
+    }
+    /**
+     * Get an abi-typed transaction for claiming rewards on a token.
+     *
+     * @param token The token to claim for
+     * @returns Abi transaction
+     */
+    async getClaimRewardsTransaction(token) {
+        return {
+            address: CLANKERS.clanker_v3_1.address,
+            abi: Clanker_v3_1_abi,
+            functionName: "claimRewards",
+            args: [token],
+        };
+    }
+    /**
+     * Simulate claiming rewards. Will use the wallet account on the Clanker class or
+     * the passed-in account.
+     *
+     * @param token The token to simulate reward claiming for
+     * @param account Optional account to simulate calling claiming for
+     * @returns The simulated output
+     */
+    async claimRewardsSimulate(token, account) {
+        const acc = account || this.wallet?.account;
+        if (!acc)
+            throw new Error("Account or wallet client required for simulation");
+        if (!this.publicClient)
+            throw new Error("Public client required");
+        const input = await this.getClaimRewardsTransaction(token);
+        return simulateClankerContract(this.publicClient, acc, input);
+    }
+    /**
+     * Claim rewards for a clanker token.
+     *
+     * @param token Token to claim rewards for
+     * @returns Transaction hash of the claim or error
+     */
+    async claimRewards(token) {
+        if (!this.wallet)
+            throw new Error("Wallet client required");
+        if (!this.publicClient)
+            throw new Error("Public client required");
+        const input = await this.getClaimRewardsTransaction(token);
+        return writeClankerContract(this.publicClient, this.wallet, input);
+    }
+    /**
+     * Get an abi-typed transaction for updating the creator reward recipient.
+     *
+     * @param tokenId The token ID to update the creator reward recipient for
+     * @param newRecipient The new recipient address
+     * @returns Abi transaction
+     */
+    async getUpdateCreatorRewardRecipientTransaction(tokenId, newRecipient) {
+        return {
+            address: CLANKERS.clanker_v3_1.related.locker,
+            abi: LpLockerv2_abi,
+            functionName: "updateCreatorRewardRecipient",
+            args: [tokenId, newRecipient],
+        };
+    }
+    /**
+     * Simulate updating the creator reward recipient. Will use the wallet account on the Clanker class or
+     * the passed-in account.
+     *
+     * @param tokenId The token ID to update the creator reward recipient for
+     * @param newRecipient The new recipient address
+     * @param account Optional account to simulate calling for
+     * @returns The simulated output
+     */
+    async updateCreatorRewardRecipientSimulate(tokenId, newRecipient, account) {
+        const acc = account || this.wallet?.account;
+        if (!acc)
+            throw new Error("Account or wallet client required for simulation");
+        if (!this.publicClient)
+            throw new Error("Public client required");
+        const input = await this.getUpdateCreatorRewardRecipientTransaction(tokenId, newRecipient);
+        return simulateClankerContract(this.publicClient, acc, input);
+    }
+    /**
+     * Update the creator reward recipient for a token.
+     *
+     * @param tokenId The token ID to update the creator reward recipient for
+     * @param newRecipient The new recipient address
+     * @returns Transaction hash of the update or error
+     */
+    async updateCreatorRewardRecipient(tokenId, newRecipient) {
+        if (!this.wallet)
+            throw new Error("Wallet client required");
+        if (!this.publicClient)
+            throw new Error("Public client required");
+        const input = await this.getUpdateCreatorRewardRecipientTransaction(tokenId, newRecipient);
+        return writeClankerContract(this.publicClient, this.wallet, input);
+    }
+    /**
+     * Get an abi-typed transaction for deploying a clanker.
+     *
+     * @param token The token to deploy
+     * @param requestorAddress Requestor for the deployment. Various admins will fall back to this.
+     * @returns Abi transaction
+     */
+    async getDeployTransaction(token, requestorAddress) {
+        return clankerTokenV3Converter(token, { requestorAddress });
+    }
+    /**
+     * Simulate a token deployment
+     *
+     * @param token The token to deploy
+     * @param requestorAddress Requestor for the deployment. Various admins will fall back to this.
+     * @returns Abi transaction
+     */
+    async deploySimulate(token, account) {
+        const acc = account || this.wallet?.account;
+        if (!acc)
+            throw new Error("Account or wallet client required for simulation");
+        if (!this.publicClient)
+            throw new Error("Public client required for deployment");
+        const input = await this.getDeployTransaction(token, acc.address);
+        return simulateDeployToken(input, acc, this.publicClient);
+    }
+    /**
+     * Deploy a token
+     *
+     * @param token The token to deploy
+     * @returns Transaction hash and awaitable function for full deployment
+     */
+    async deploy(token) {
+        if (!this.wallet)
+            throw new Error("Wallet client required for deployment");
+        if (!this.publicClient)
+            throw new Error("Public client required for deployment");
+        const input = await this.getDeployTransaction(token, this.wallet.account.address);
+        return deployToken(input, this.wallet, this.publicClient);
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/esm/packages/clanker-sdk/src/v3/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/clanker-sdk/src/v3/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAA;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AACvD,OAAO,EAAuB,uBAAuB,EAAE,MAAM,0BAA0B,CAAA;AACvF,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAA;AACvE,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAE5C,OAAO,EAEL,uBAAuB,EACvB,oBAAoB,GACrB,MAAM,kCAAkC,CAAA;AAOzC;;GAEG;AACH,MAAM,OAAO,OAAO;IACD,MAAM,CAA0C;IAChD,YAAY,CAAe;IAE5C,YAAY,MAAsB;QAChC,IAAI,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,CAAA;QAC5B,IAAI,CAAC,YAAY,GAAG,MAAM,EAAE,YAAY,CAAA;IAC1C,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,0BAA0B,CAAC,KAAoB;QACnD,OAAO;YACL,OAAO,EAAE,QAAQ,CAAC,YAAY,CAAC,OAAO;YACtC,GAAG,EAAE,gBAAgB;YACrB,YAAY,EAAE,cAAc;YAC5B,IAAI,EAAE,CAAC,KAAK,CAAC;SACd,CAAA;IACH,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,oBAAoB,CAAC,KAAoB,EAAE,OAAiB;QAChE,MAAM,GAAG,GAAG,OAAO,IAAI,IAAI,CAAC,MAAM,EAAE,OAAO,CAAA;QAC3C,IAAI,CAAC,GAAG;YAAE,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAA;QAC7E,IAAI,CAAC,IAAI,CAAC,YAAY;YAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAA;QAEjE,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAA;QAE1D,OAAO,uBAAuB,CAAC,IAAI,CAAC,YAAY,EAAE,GAAG,EAAE,KAAK,CAAC,CAAA;IAC/D,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY,CAChB,KAAoB;QAEpB,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAA;QAC3D,IAAI,CAAC,IAAI,CAAC,YAAY;YAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAA;QAEjE,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAA;QAE1D,OAAO,oBAAoB,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;IACpE,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,0CAA0C,CAAC,OAAe,EAAE,YAA2B;QAC3F,OAAO;YACL,OAAO,EAAE,QAAQ,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM;YAC7C,GAAG,EAAE,cAAc;YACnB,YAAY,EAAE,8BAAuC;YACrD,IAAI,EAAE,CAAC,OAAO,EAAE,YAAY,CAAU;SACvC,CAAA;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,oCAAoC,CAAC,OAAe,EAAE,YAA2B,EAAE,OAAiB;QACxG,MAAM,GAAG,GAAG,OAAO,IAAI,IAAI,CAAC,MAAM,EAAE,OAAO,CAAA;QAC3C,IAAI,CAAC,GAAG;YAAE,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAA;QAC7E,IAAI,CAAC,IAAI,CAAC,YAAY;YAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAA;QAEjE,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,0CAA0C,CAAC,OAAO,EAAE,YAAY,CAAC,CAAA;QAE1F,OAAO,uBAAuB,CAAC,IAAI,CAAC,YAAY,EAAE,GAAG,EAAE,KAAK,CAAC,CAAA;IAC/D,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,4BAA4B,CAChC,OAAe,EACf,YAA2B;QAE3B,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAA;QAC3D,IAAI,CAAC,IAAI,CAAC,YAAY;YAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAA;QAEjE,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,0CAA0C,CAAC,OAAO,EAAE,YAAY,CAAC,CAAA;QAE1F,OAAO,oBAAoB,CAAC,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;IACpE,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,oBAAoB,CAAC,KAAqB,EAAE,gBAA+B;QAC/E,OAAO,uBAAuB,CAAC,KAAK,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAA;IAC7D,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,cAAc,CAAC,KAAqB,EAAE,OAAiB;QAC3D,MAAM,GAAG,GAAG,OAAO,IAAI,IAAI,CAAC,MAAM,EAAE,OAAO,CAAA;QAC3C,IAAI,CAAC,GAAG;YAAE,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAA;QAC7E,IAAI,CAAC,IAAI,CAAC,YAAY;YAAE,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;QAEhF,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;QAEjE,OAAO,mBAAmB,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,YAAY,CAAC,CAAA;IAC3D,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CAAC,KAAqB;QAChC,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;QAC1E,IAAI,CAAC,IAAI,CAAC,YAAY;YAAE,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;QAEhF,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QAEjF,OAAO,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,CAAA;IAC3D,CAAC;CACF"}

package/dist/esm/packages/clanker-sdk/src/v4/extensions/airdrop.js

@@ -0,0 +1,144 @@
+import { StandardMerkleTree } from "@openzeppelin/merkle-tree";
+import { isAddressEqual, stringify } from "viem";
+import * as z from "zod/v4";
+import { ClankerAirdrop_v4_abi } from "../../abi/v4/ClankerAirdrop.js";
+import { clankerConfigFor, } from "../../utils/clankers.js";
+import { writeClankerContract } from "../../utils/write-clanker-contracts.js";
+import { addressSchema } from "../../utils/zod-onchain.js";
+const AirdropEntrySchema = z.array(z.object({
+    account: addressSchema,
+    amount: z.number(),
+}));
+/**
+ * Create an airdrop for the recipients.
+ *
+ * @param recipients Recipients recieving airdrop.
+ * @param options.tokenDecimals Custom token decimals.
+ * @returns Tree to save offline and Airdrop data for the smart contract.
+ */
+export function createAirdrop(recipients, options = { tokenDecimals: 18n }) {
+    const parsedEntries = AirdropEntrySchema.parse(recipients);
+    const values = parsedEntries.map(({ account, amount }) => [
+        account,
+        (BigInt(amount) * 10n ** options.tokenDecimals).toString(),
+    ]);
+    const amount = parsedEntries.reduce((agg, { amount }) => amount + agg, 0);
+    const tree = StandardMerkleTree.of(values, ["address", "uint256"]);
+    tree.validate();
+    return {
+        tree,
+        airdrop: {
+            merkleRoot: tree.root,
+            amount,
+        },
+    };
+}
+/**
+ * Register an airdrop merkle tree with the Clanker service.
+ *
+ * @dev Requires that the associated token is already deployed and indexed. The token
+ * must also have the merkle root associated with it.
+ *
+ * @param token The token associated with the tree.
+ * @param tree The tree to register.
+ * @returns Success.
+ */
+export async function registerAirdrop(token, tree) {
+    const { success } = await fetch("https://www.clanker.world/api/airdrops", {
+        method: "POST",
+        body: stringify({
+            tokenAddress: token,
+            merkleRoot: tree.root,
+            tree: tree.dump(),
+        }),
+    }).then((r) => r.json());
+    return success;
+}
+/**
+ * Get all proofs for an account given a merkle tree.
+ *
+ * @param tree The tree to check.
+ * @param account The account to check for.
+ * @returns All proofs and their associated entries for claiming.
+ */
+export function getAirdropProofs(tree, account) {
+    const indices = [];
+    for (const [i, entry] of tree.entries()) {
+        if (!isAddressEqual(entry[0], account))
+            continue;
+        indices.push({ i: i, entry });
+    }
+    if (indices.length === 0)
+        return { proofs: [] };
+    return {
+        proofs: indices.map(({ i, entry }) => ({
+            proof: tree.getProof(i),
+            entry: {
+                account: entry[0],
+                amount: BigInt(entry[1]),
+            },
+        })),
+    };
+}
+/**
+ * Get all proofs for an account given a token that has a merkle tree associated with it. The token and tree must have been registered with the Clanker service.
+ *
+ * @param token The token with the airdrop.
+ * @param account The account to check for.
+ * @returns All proofs and their associated entries for claiming.
+ */
+export async function fetchAirdropProofs(token, account) {
+    const { proofs } = await fetch(`https://www.clanker.world/api/airdrops/claim?tokenAddress=${token}&claimerAddress=${account}`).then((r) => r.json());
+    return {
+        proofs: proofs.map(({ proof, entry: { account, amount } }) => ({
+            proof,
+            entry: {
+                account,
+                amount: BigInt(amount),
+            },
+        })),
+    };
+}
+/**
+ * Create a transaction to claim a specific airdrop for.
+ *
+ * @param token The token that did the airdrop
+ * @param recipient The address recieving the airdrop
+ * @param amount The amount registered in the airdrop. Note, this must be the exact registered amount.
+ * @param proof Merkle proof for the address and amount (see `getProofs`)
+ * @returns Arguments that can be used with a viem transaction.
+ */
+export function getClaimAirdropTransaction({ token, recipient, amount, proof, chainId, }) {
+    const config = clankerConfigFor(chainId, "clanker_v4");
+    if (!config)
+        throw new Error(`Clanker is not ready on ${chainId}`);
+    return {
+        chainId,
+        address: config.related.airdrop,
+        abi: ClankerAirdrop_v4_abi,
+        functionName: "claim",
+        args: [token, recipient, amount, proof],
+    };
+}
+/**
+ * Claim an airdrop
+ *
+ * @param clanker Clanker object used for claiming
+ * @param token The token that did the airdrop
+ * @param recipient The address recieving the airdrop
+ * @param amount The amount registered in the airdrop. Note, this must be the exact registered amount.
+ * @param proof Merkle proof for the address and amount (see `getProofs`)
+ * @returns Outcome of the transaction
+ */
+export function claimAirdrop(data) {
+    if (!data.clanker.publicClient)
+        throw new Error("Public client required on clanker");
+    if (!data.clanker.wallet)
+        throw new Error("Wallet client required on clanker");
+    const tx = getClaimAirdropTransaction({
+        chainId: data.clanker.wallet.chain.id,
+        ...data,
+    });
+    return writeClankerContract(data.clanker.publicClient, data.clanker.wallet, tx);
+}
+//# sourceMappingURL=airdrop.js.map

package/dist/esm/packages/clanker-sdk/src/v4/extensions/airdrop.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"airdrop.js","sourceRoot":"","sources":["../../../../../../../packages/clanker-sdk/src/v4/extensions/airdrop.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAA;AAE9D,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,MAAM,CAAA;AAChD,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAA;AAC3B,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAA;AACnE,OAAO,EAGL,gBAAgB,GAEjB,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EAAiC,oBAAoB,EAAE,MAAM,qCAAqC,CAAA;AACzG,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AAGvD,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAChC,CAAC,CAAC,MAAM,CAAC;IACP,OAAO,EAAE,aAAa;IACtB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;CACnB,CAAC,CACH,CAAA;AAKD;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAC3B,UAA8B,EAC9B,UAAqC,EAAE,aAAa,EAAE,GAAG,EAAE;IAE3D,MAAM,aAAa,GAAG,kBAAkB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;IAE1D,MAAM,MAAM,GAAkB,aAAa,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;QACvE,OAAO;QACP,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,GAAG,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC,QAAQ,EAAE;KAC3D,CAAC,CAAA;IAEF,MAAM,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC,CAAC,CAAA;IAEzE,MAAM,IAAI,GAAG,kBAAkB,CAAC,EAAE,CAAc,MAAM,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAA;IAE/E,IAAI,CAAC,QAAQ,EAAE,CAAA;IAEf,OAAO;QACL,IAAI;QACJ,OAAO,EAAE;YACP,UAAU,EAAE,IAAI,CAAC,IAAqB;YACtC,MAAM;SACP;KACF,CAAA;AACH,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,KAAoB,EAAE,IAA6B;IACvF,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,KAAK,CAAC,wCAAwC,EAAE;QACxE,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,SAAS,CAAC;YACd,YAAY,EAAE,KAAK;YACnB,UAAU,EAAE,IAAI,CAAC,IAAI;YACrB,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE;SAClB,CAAC;KACH,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAmC,CAAC,CAAA;IAEzD,OAAO,OAAO,CAAA;AAChB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAC9B,IAA6B,EAC7B,OAAsB;IAEtB,MAAM,OAAO,GAAG,EAAE,CAAA;IAClB,KAAK,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;QACxC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC;YAAE,SAAQ;QAEhD,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,CAAA;IAC/B,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,CAAA;IAE/C,OAAO;QACL,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;YACrC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAoB;YAC1C,KAAK,EAAE;gBACL,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;gBACjB,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;aACzB;SACF,CAAC,CAAC;KACJ,CAAA;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,KAAoB,EACpB,OAAsB;IAItB,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,KAAK,CAC5B,6DAA6D,KAAK,mBAAmB,OAAO,EAAE,CAC/F,CAAC,IAAI,CACJ,CAAC,CAAC,EAAE,EAAE,CACJ,CAAC,CAAC,IAAI,EAEJ,CACL,CAAA;IAED,OAAO;QACL,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;YAC7D,KAAK;YACL,KAAK,EAAE;gBACL,OAAO;gBACP,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;aACvB;SACF,CAAC,CAAC;KACJ,CAAA;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,0BAA0B,CAAC,EACzC,KAAK,EACL,SAAS,EACT,MAAM,EACN,KAAK,EACL,OAAO,GAOR;IACC,MAAM,MAAM,GAAG,gBAAgB,CAA+B,OAAO,EAAE,YAAY,CAAC,CAAA;IACpF,IAAI,CAAC,MAAM;QAAE,MAAM,IAAI,KAAK,CAAC,2BAA2B,OAAO,EAAE,CAAC,CAAA;IAElE,OAAO;QACL,OAAO;QACP,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,OAAO;QAC/B,GAAG,EAAE,qBAAqB;QAC1B,YAAY,EAAE,OAAO;QACrB,IAAI,EAAE,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,CAAC;KACxC,CAAA;AACH,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,YAAY,CAAC,IAM5B;IACC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY;QAAE,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAA;IACpF,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM;QAAE,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAA;IAC9E,MAAM,EAAE,GAAG,0BAA0B,CAAC;QACpC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,EAAkB;QACrD,GAAG,IAAI;KACR,CAAC,CAAA;IAEF,OAAO,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;AACjF,CAAC"}

package/dist/esm/packages/clanker-sdk/src/v4/extensions/index.js

@@ -0,0 +1,2 @@
+export * from "./airdrop.js";
+//# sourceMappingURL=index.js.map

package/dist/esm/packages/clanker-sdk/src/v4/extensions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../packages/clanker-sdk/src/v4/extensions/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA"}