Core Utilities

type Chain = Clankers[keyof Clankers]["chainId"];

type ClankerDeployment<T> = {
  abi: Abi;
  address: `0x${string}`;
  chainId: number;
  related: T;
  token: {
     abi: Abi;
     bytecode: Hex;
  };
  type: string;
};

type Clankers = typeof CLANKERS;

type ClankerTokenV3 = z.input<typeof clankerTokenV3>;

type ClankerTokenV4 = z.input<typeof clankerTokenV4>;

type DeployTokenOptions = {
  dataSuffix?: `0x${string}`;
};

type RelatedV3_1 = {
  locker: `0x${string}`;
  vault: `0x${string}`;
};

type RelatedV4 = {
  airdrop: `0x${string}`;
  devbuy: `0x${string}`;
  feeDynamicHook: `0x${string}`;
  feeDynamicHookV2?: `0x${string}`;
  feeLocker: `0x${string}`;
  feeStaticHook: `0x${string}`;
  feeStaticHookV2?: `0x${string}`;
  locker: `0x${string}`;
  mevDescendingFees?: boolean;
  mevModule: `0x${string}`;
  mevModuleV2?: `0x${string}`;
  presale?: `0x${string}`;
  presaleAllowlist?: `0x${string}`;
  vault: `0x${string}`;
};

type Type = Clankers[keyof Clankers]["type"];

const A0X_ADDRESS: `0x${string}` = '0x820C5F0fB255a1D18fd0eBB0F1CCefbC4D546dA7';

const ANON_ADDRESS: `0x${string}` = '0x0Db510e79909666d6dEc7f5e49370838c16D950f';

const BSC_USDT_ADDRESS: `0x${string}` = '0x55d398326f99059fF775485246999027B3197955';

const CB_BTC_ADDRESS: `0x${string}` = '0xcbB7C0000aB88B473b1f5aFd9ef808440eed33Bf';

const Chains: (1 | 56 | 130 | 143 | 2741 | 4663 | 8453 | 10143 | 42161 | 84532)[];

const CLANKER_ADDRESS: `0x${string}` = '0x1bc0c42215582d5A085795f4baDbaC3ff36d1Bcb';

const ClankerDeployments: Record<1 | 56 | 130 | 143 | 2741 | 4663 | 8453 | 10143 | 42161 | 84532, Partial<Record<
  | "clanker"
  | "proxy"
  | "clanker_v2"
  | "clanker_v3"
  | "clanker_v3_1"
| "clanker_v4", ClankerDeployment<RelatedAddresses>>>>;

const DEFAULT_SUPPLY: 100000000000000000000000000000n = 100_000_000_000_000_000_000_000_000_000n;

const DEGEN_ADDRESS: `0x${string}` = '0x4ed4E862860beD51a9570b96d89aF5E1B0Efefed';

const FEE_CONFIGS: Record<FeeConfigs, Required<ClankerTokenV4["fees"]>>;

const HIGHER_ADDRESS: `0x${string}` = '0x0578d8A44db98B23BF096A382e016e29a5Ce0ffe';

const NATIVE_ADDRESS: `0x${string}` = '0x20DD04c17AFD5c9a8b3f2cdacaa8Ee7907385BEF';

const POOL_POSITIONS: Record<PoolPositions, PoolPosition[]>;

const robinhood: {
  blockExplorers: {
     default: {
        name: "Robinhood Chain Blockscout Explorer";
        url: "https://robinhoodchain.blockscout.com";
     };
  };
  blockTime: 100;
  contracts: {
  };
  id: 4663;
  name: "Robinhood Chain";
  nativeCurrency: {
     decimals: 18;
     name: "Ether";
     symbol: "ETH";
  };
  rpcUrls: {
     default: {
        http: readonly ["https://rpc.mainnet.chain.robinhood.com"];
     };
  };
  testnet: false;
};

const ROBINHOOD_BLOCK_GAS_LIMIT: 1125899906842624n = 1_125_899_906_842_624n;

const ROBINHOOD_WETH_ADDRESS: `0x${string}` = '0x0Bd7D308f8E1639FAb988df18A8011f41EAcAD73';

const WBNB_ADDRESS: `0x${string}` = '0xbb4CdB9CBd36B01bD1cBaEBF2De08d9173bc095c';

const WETH_ADDRESSES: Record<Chain, `0x${string}`>;

function clankerConfigFor<T>(chainId, type): T | undefined;

function createAllowlistMerkleTree(entries): {
  entries: [string, string][];
  root: `0x${string}`;
  tree: StandardMerkleTree<[string, string]>;
};

{
  entries: [string, string][];
  root: `0x${string}`;
  tree: StandardMerkleTree<[string, string]>;
}

const entries = [
  { address: '0x123...', allowedAmount: 1.0 }, // 1 ETH max
  { address: '0x456...', allowedAmount: 0.5 }, // 0.5 ETH max
];
const { root, tree } = createAllowlistMerkleTree(entries);

function createMerkleTree(entries): {
  entries: [string, string][];
  root: `0x${string}`;
  tree: StandardMerkleTree<[string, string]>;
};

{
  entries: [string, string][];
  root: `0x${string}`;
  tree: StandardMerkleTree<[string, string]>;
}

function encodeAirdropData(
   merkleRoot, 
   lockupDuration, 
   vestingDuration): `0x${string}`;

function encodeAllowlistInitializationData(merkleRoot): `0x${string}`;

const { root } = createAllowlistMerkleTree(entries);
const initData = encodeAllowlistInitializationData(root);
// Use initData in presaleConfig.allowlistInitializationData

function encodeAllowlistProofData(allowedAmount, proof): `0x${string}`;

const proof = getAllowlistMerkleProof(tree, entries, buyerAddress, 1.0);
const proofData = encodeAllowlistProofData(1.0, proof);
// Use proofData when calling buyIntoPresaleWithProof

function findVanityAddress(
   args, 
   admin, 
   suffix?, 
   options?): Promise<{
  salt: `0x${string}`;
  token: `0x${string}`;
}>;

function findVanityAddressV4(
   args, 
   admin, 
   suffix?, 
   config): Promise<{
  salt: `0x${string}`;
  token: `0x${string}`;
}>;

function getAllowedAmountForBuyer(
   publicClient, 
   presaleId, 
   buyer, 
   proof, 
chainId): Promise<bigint>;

function getAllowlistAddress(chainId): `0x${string}` | undefined;

function getAllowlistInfo(
   publicClient, 
   presaleId, 
   chainId): Promise<{
  enabled: boolean;
  merkleRoot: `0x${string}`;
  presaleOwner: `0x${string}`;
}>;

function getAllowlistMerkleProof(
   tree, 
   entries, 
   address, 
   allowedAmount): `0x${string}`[];

const { tree, entries } = createAllowlistMerkleTree(allowlistEntries);
const proof = getAllowlistMerkleProof(tree, entries, '0x123...', 1.0);

function getMerkleProof(
   tree, 
   entries, 
   account, 
   amount): `0x${string}`[];

function getTickFromMarketCap(marketCap): {
  pairedToken: "WETH";
  tickIfToken0IsClanker: number;
  tickSpacing: number;
};

{
  pairedToken: "WETH";
  tickIfToken0IsClanker: number;
  tickSpacing: number;
}

function getTickFromMarketCapStable(
   marketCap, 
   stableDecimals, 
   tickSpacing?): number;

function getTickFromMarketCapUSDC(marketCapUSDC, tickSpacing?): number;

function predictTokenAddressV4(
   args, 
   config, 
   salt, 
   tokenAdmin): `0x${string}`;

function verifyBuyerAllowance(
   publicClient, 
   presaleId, 
   buyer, 
   desiredAmount, 
   proof, 
   chainId): Promise<{
  allowedAmountEth: number;
  allowedAmountWei: bigint;
  isAllowed: boolean;
}>;