clanker-sdk 4.2.3 → 4.2.5-canary.0

package/dist/v4/extensions/index.d.ts

@@ -1,7 +1,7 @@
-import { C as ClankerTransactionConfig, f as ClankerAirdrop_v4_abi, c as ClankerResult, g as Clanker_PresaleEthToCreator_v4_1_abi } from '../../write-clanker-contracts-B4LSHPv2.js';
+import { C as ClankerTransactionConfig, f as ClankerAirdrop_v4_abi, c as ClankerResult, g as Clanker_PresaleEthToCreator_v4_1_abi, h as Clanker_PresaleAllowlist_v4_1_abi } from '../../write-clanker-contracts-CQTURFDk.js';
 import { MerkleTree } from '@openzeppelin/merkle-tree/dist/merkletree.js';
 import * as z from 'zod/v4';
-import { a as Chain, C as ClankerTokenV4 } from '../../clankerTokenV4-Btn0ZN4v.js';
+import { a as Chain, C as ClankerTokenV4 } from '../../clankerTokenV4-xiAq6G4R.js';
 import { Clanker } from '../index.js';
 import { C as ClankerError } from '../../errors-5Gv28Tkr.js';
 import 'viem';
@@ -490,5 +490,195 @@ declare function withdrawFromPresale(data: {
  * @returns The allowlist contract address, or undefined if not available
  */
 declare function getAllowlistAddress(chainId: Chain): `0x${string}` | undefined;
+/**
+ * Get a transaction to buy into a presale with allowlist proof
+ *
+ * Use this when buying into a presale that has an allowlist enabled.
+ * The proof must contain your allowlist proof data (merkle proof + allowed amount).
+ *
+ * @param presaleId The ID of the presale
+ * @param chainId The chain ID
+ * @param value The ETH amount to send (in wei)
+ * @param proof The encoded proof data from encodeAllowlistProofData
+ * @returns Transaction configuration for buying into a presale with proof
+ */
+declare function getBuyIntoPresaleWithProofTransaction({ presaleId, chainId, value, proof, }: {
+    presaleId: bigint;
+    chainId: Chain;
+    value: bigint;
+    proof: `0x${string}`;
+}): ClankerTransactionConfig<typeof Clanker_PresaleEthToCreator_v4_1_abi, 'buyIntoPresaleWithProof'>;
+/**
+ * Buy into a presale with allowlist proof
+ *
+ * Use this when buying into a presale that has an allowlist enabled.
+ * You must provide proof that your address is on the allowlist.
+ *
+ * @param clanker Clanker object used for buying into presale
+ * @param presaleId The ID of the presale
+ * @param ethAmount The ETH amount to send (in ETH, will be converted to wei)
+ * @param proof The encoded proof data from encodeAllowlistProofData
+ * @returns Outcome of the transaction
+ *
+ * @example
+ * ```typescript
+ * import { createAllowlistMerkleTree, getAllowlistMerkleProof, encodeAllowlistProofData } from '../utils/presale-allowlist';
+ *
+ * // Get your proof from the allowlist
+ * const { tree, entries } = createAllowlistMerkleTree(allowlistEntries);
+ * const proof = getAllowlistMerkleProof(tree, entries, buyerAddress, 1.0);
+ * const proofData = encodeAllowlistProofData(1.0, proof);
+ *
+ * // Buy with proof
+ * await buyIntoPresaleWithProof({ clanker, presaleId: 1n, ethAmount: 0.5, proof: proofData });
+ * ```
+ */
+declare function buyIntoPresaleWithProof(data: {
+    clanker: Clanker;
+    presaleId: bigint;
+    ethAmount: number;
+    proof: `0x${string}`;
+}): ClankerResult<{
+    txHash: `0x${string}`;
+}>;
+
+/**
+ * Get a transaction to set the merkle root for a presale allowlist
+ *
+ * Only callable by the presale owner. This allows updating the allowlist
+ * after the presale has been created.
+ *
+ * @param presaleId The presale ID
+ * @param merkleRoot The new merkle root
+ * @param chainId The chain ID
+ * @returns Transaction configuration
+ */
+declare function getSetMerkleRootTransaction({ presaleId, merkleRoot, chainId, }: {
+    presaleId: bigint;
+    merkleRoot: `0x${string}`;
+    chainId: Chain;
+}): ClankerTransactionConfig<typeof Clanker_PresaleAllowlist_v4_1_abi, 'setMerkleRoot'>;
+/**
+ * Set the merkle root for a presale allowlist
+ *
+ * Only callable by the presale owner. This allows updating the allowlist
+ * after the presale has been created.
+ *
+ * @param clanker Clanker object
+ * @param presaleId The presale ID
+ * @param merkleRoot The new merkle root
+ * @returns Outcome of the transaction
+ */
+declare function setMerkleRoot(data: {
+    clanker: Clanker;
+    presaleId: bigint;
+    merkleRoot: `0x${string}`;
+}): ClankerResult<{
+    txHash: `0x${string}`;
+}>;
+/**
+ * Get a transaction to set an address override for a presale allowlist
+ *
+ * Only callable by the presale owner. Address overrides take precedence
+ * over the merkle tree allowlist. Setting allowedAmount to 0 effectively
+ * removes the override.
+ *
+ * @param presaleId The presale ID
+ * @param buyer The buyer's address to override
+ * @param allowedAmount The allowed amount in wei (0 to remove override)
+ * @param chainId The chain ID
+ * @returns Transaction configuration
+ */
+declare function getSetAddressOverrideTransaction({ presaleId, buyer, allowedAmount, chainId, }: {
+    presaleId: bigint;
+    buyer: `0x${string}`;
+    allowedAmount: bigint;
+    chainId: Chain;
+}): ClankerTransactionConfig<typeof Clanker_PresaleAllowlist_v4_1_abi, 'setAddressOverride'>;
+/**
+ * Set an address override for a presale allowlist
+ *
+ * Only callable by the presale owner. Address overrides take precedence
+ * over the merkle tree allowlist. This is useful for manually adding
+ * addresses without regenerating the entire merkle tree.
+ *
+ * @param clanker Clanker object
+ * @param presaleId The presale ID
+ * @param buyer The buyer's address to override
+ * @param allowedAmountEth The allowed amount in ETH (0 to remove override)
+ * @returns Outcome of the transaction
+ *
+ * @example
+ * ```typescript
+ * // Allow a specific address to buy up to 2 ETH
+ * await setAddressOverride({
+ *   clanker,
+ *   presaleId: 1n,
+ *   buyer: '0x123...',
+ *   allowedAmountEth: 2.0
+ * });
+ *
+ * // Remove the override (set to 0)
+ * await setAddressOverride({
+ *   clanker,
+ *   presaleId: 1n,
+ *   buyer: '0x123...',
+ *   allowedAmountEth: 0
+ * });
+ * ```
+ */
+declare function setAddressOverride(data: {
+    clanker: Clanker;
+    presaleId: bigint;
+    buyer: `0x${string}`;
+    allowedAmountEth: number;
+}): ClankerResult<{
+    txHash: `0x${string}`;
+}>;
+/**
+ * Get a transaction to enable or disable the allowlist for a presale
+ *
+ * Only callable by the presale owner. When disabled, anyone can buy
+ * into the presale without restrictions. When enabled, buyers must
+ * provide proof or have an address override.
+ *
+ * @param presaleId The presale ID
+ * @param enabled Whether to enable or disable the allowlist
+ * @param chainId The chain ID
+ * @returns Transaction configuration
+ */
+declare function getSetAllowlistEnabledTransaction({ presaleId, enabled, chainId, }: {
+    presaleId: bigint;
+    enabled: boolean;
+    chainId: Chain;
+}): ClankerTransactionConfig<typeof Clanker_PresaleAllowlist_v4_1_abi, 'setAllowlistEnabled'>;
+/**
+ * Enable or disable the allowlist for a presale
+ *
+ * Only callable by the presale owner. When disabled, anyone can buy
+ * into the presale without restrictions. When enabled, buyers must
+ * provide proof or have an address override.
+ *
+ * @param clanker Clanker object
+ * @param presaleId The presale ID
+ * @param enabled Whether to enable or disable the allowlist
+ * @returns Outcome of the transaction
+ *
+ * @example
+ * ```typescript
+ * // Disable the allowlist to let anyone participate
+ * await setAllowlistEnabled({ clanker, presaleId: 1n, enabled: false });
+ *
+ * // Re-enable the allowlist
+ * await setAllowlistEnabled({ clanker, presaleId: 1n, enabled: true });
+ * ```
+ */
+declare function setAllowlistEnabled(data: {
+    clanker: Clanker;
+    presaleId: bigint;
+    enabled: boolean;
+}): ClankerResult<{
+    txHash: `0x${string}`;
+}>;
 
-export { type AirdropRecipient, type PresaleConfig, PresaleStatus, buyIntoPresale, claimAirdrop, claimEth, claimTokens, createAirdrop, endPresale, fetchAirdropProofs, getAirdropProofs, getAllowlistAddress, getAmountAvailableToClaim, getBuyIntoPresaleTransaction, getClaimAirdropTransaction, getClaimEthTransaction, getClaimTokensTransaction, getEndPresaleTransaction, getPresale, getPresaleBuys, getPresaleClaimed, getPresaleState, getStartPresaleTransaction, getWithdrawFromPresaleTransaction, registerAirdrop, startPresale, withdrawFromPresale };
+export { type AirdropRecipient, type PresaleConfig, PresaleStatus, buyIntoPresale, buyIntoPresaleWithProof, claimAirdrop, claimEth, claimTokens, createAirdrop, endPresale, fetchAirdropProofs, getAirdropProofs, getAllowlistAddress, getAmountAvailableToClaim, getBuyIntoPresaleTransaction, getBuyIntoPresaleWithProofTransaction, getClaimAirdropTransaction, getClaimEthTransaction, getClaimTokensTransaction, getEndPresaleTransaction, getPresale, getPresaleBuys, getPresaleClaimed, getPresaleState, getSetAddressOverrideTransaction, getSetAllowlistEnabledTransaction, getSetMerkleRootTransaction, getStartPresaleTransaction, getWithdrawFromPresaleTransaction, registerAirdrop, setAddressOverride, setAllowlistEnabled, setMerkleRoot, startPresale, withdrawFromPresale };