For the complete documentation index, see llms.txt. This page is also available as Markdown.

V3 — Clanker Class

clanker-sdk


clanker-sdk / v3

v3

Classes

Clanker

Defined in: src/v3/index.ts:28

Clanker v3

Constructors

Constructor

new Clanker(config?): Clanker;

Defined in: src/v3/index.ts:32

Parameters

Parameter
Type

config?

ClankerConfig

Returns

Clanker

Methods

claimRewards()

Defined in: src/v3/index.ts:98

Claim rewards for a clanker token.

Parameters

Parameter
Type
Description

token

`0x${string}`

Token to claim rewards for

Returns

Promise< | { error: undefined; txHash: `0x${string}`; } | { error: ClankerError; txHash: undefined; }>

Transaction hash of the claim or error

claimRewardsSimulate()

Defined in: src/v3/index.ts:82

Simulate claiming rewards. Will use the wallet account on the Clanker class or the passed-in account.

Parameters

Parameter
Type
Description

token

`0x${string}`

The token to simulate reward claiming for

account?

Account

Optional account to simulate calling claiming for

Returns

Promise< | SimulateContractReturnType<readonly [{ inputs: readonly [{ internalType: "address"; name: "owner_"; type: "address"; }]; stateMutability: "nonpayable"; type: "constructor"; }, { inputs: readonly []; name: "Deprecated"; type: "error"; }, { inputs: readonly []; name: "InvalidCreatorInfo"; type: "error"; }, { inputs: readonly []; name: "InvalidCreatorReward"; type: "error"; }, { inputs: readonly []; name: "InvalidInterfaceInfo"; type: "error"; }, { inputs: readonly []; name: "InvalidTick"; type: "error"; }, { inputs: readonly []; name: "InvalidVaultConfiguration"; type: "error"; }, { inputs: readonly []; name: "NotFound"; type: "error"; }, { inputs: readonly []; name: "OnlyNonOriginatingChains"; type: "error"; }, { inputs: readonly []; name: "OnlyOriginatingChain"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "owner"; type: "address"; }]; name: "OwnableInvalidOwner"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "OwnableUnauthorizedAccount"; type: "error"; }, { inputs: readonly []; name: "ReentrancyGuardReentrantCall"; type: "error"; }, { inputs: readonly []; name: "Unauthorized"; type: "error"; }, { inputs: readonly []; name: "ZeroTeamRewardRecipient"; type: "error"; }, { anonymous: false; inputs: readonly [{ indexed: false; internalType: "address"; name: "oldClankerDeployer"; type: "address"; }, { indexed: false; internalType: "address"; name: "newClankerDeployer"; type: "address"; }]; name: "ClankerDeployerUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: false; internalType: "address"; name: "oldLocker"; type: "address"; }, { indexed: false; internalType: "address"; name: "newLocker"; type: "address"; }]; name: "LiquidityLockerUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "previousOwner"; type: "address"; }, { indexed: true; internalType: "address"; name: "newOwner"; type: "address"; }]; name: "OwnershipTransferred"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: false; internalType: "address"; name: "admin"; type: "address"; }, { indexed: false; internalType: "bool"; name: "isAdmin"; type: "bool"; }]; name: "SetAdmin"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: false; internalType: "bool"; name: "deprecated"; type: "bool"; }]; name: "SetDeprecated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "tokenAddress"; type: "address"; }, { indexed: true; internalType: "address"; name: "creatorAdmin"; type: "address"; }, { indexed: true; internalType: "address"; name: "interfaceAdmin"; type: "address"; }, { indexed: false; internalType: "address"; name: "creatorRewardRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "interfaceRewardRecipient"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "positionId"; type: "uint256"; }, { indexed: false; internalType: "string"; name: "name"; type: "string"; }, { indexed: false; internalType: "string"; name: "symbol"; type: "string"; }, { indexed: false; internalType: "int24"; name: "startingTickIfToken0IsNewToken"; type: "int24"; }, { indexed: false; internalType: "string"; name: "metadata"; type: "string"; }, { indexed: false; internalType: "uint256"; name: "amountTokensBought"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "vaultDuration"; type: "uint256"; }, { indexed: false; internalType: "uint8"; name: "vaultPercentage"; type: "uint8"; }, { indexed: false; internalType: "address"; name: "msgSender"; type: "address"; }]; name: "TokenCreated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: false; internalType: "address"; name: "oldVault"; type: "address"; }, { indexed: false; internalType: "address"; name: "newVault"; type: "address"; }]; name: "VaultUpdated"; type: "event"; }, { inputs: readonly []; name: "MAX_CREATOR_REWARD"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "MAX_TICK"; outputs: readonly [{ internalType: "int24"; name: ""; type: "int24"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "MAX_VAULT_PERCENTAGE"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "POOL_FEE"; outputs: readonly [{ internalType: "uint24"; name: ""; type: "uint24"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "TICK_SPACING"; outputs: readonly [{ internalType: "int24"; name: ""; type: "int24"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "TOKEN_SUPPLY"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; name: "admins"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "token"; type: "address"; }]; name: "claimRewards"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ components: readonly [{ components: readonly [..., ..., ..., ..., ..., ..., ...]; internalType: "struct IClanker.TokenConfig"; name: "tokenConfig"; type: "tuple"; }, { components: readonly [..., ...]; internalType: "struct IClanker.VaultConfig"; name: "vaultConfig"; type: "tuple"; }, { components: readonly [..., ...]; internalType: "struct IClanker.PoolConfig"; name: "poolConfig"; type: "tuple"; }, { components: readonly [..., ...]; internalType: "struct IClanker.InitialBuyConfig"; name: "initialBuyConfig"; type: "tuple"; }, { components: readonly [..., ..., ..., ..., ...]; internalType: "struct IClanker.RewardsConfig"; name: "rewardsConfig"; type: "tuple"; }]; internalType: "struct IClanker.DeploymentConfig"; name: "deploymentConfig"; type: "tuple"; }]; name: "deployToken"; outputs: readonly [{ internalType: "address"; name: "tokenAddress"; type: "address"; }, { internalType: "uint256"; name: "positionId"; type: "uint256"; }]; stateMutability: "payable"; type: "function"; }, { inputs: readonly [{ components: readonly [{ components: readonly [..., ..., ..., ..., ..., ..., ...]; internalType: "struct IClanker.TokenConfig"; name: "tokenConfig"; type: "tuple"; }, { components: readonly [..., ...]; internalType: "struct IClanker.VaultConfig"; name: "vaultConfig"; type: "tuple"; }, { components: readonly [..., ...]; internalType: "struct IClanker.PoolConfig"; name: "poolConfig"; type: "tuple"; }, { components: readonly [..., ...]; internalType: "struct IClanker.InitialBuyConfig"; name: "initialBuyConfig"; type: "tuple"; }, { components: readonly [..., ..., ..., ..., ...]; internalType: "struct IClanker.RewardsConfig"; name: "rewardsConfig"; type: "tuple"; }]; internalType: "struct IClanker.DeploymentConfig"; name: "deploymentConfig"; type: "tuple"; }, { internalType: "address"; name: "teamRewardRecipient"; type: "address"; }]; name: "deployTokenWithCustomTeamRewardRecipient"; outputs: readonly [{ internalType: "address"; name: "tokenAddress"; type: "address"; }, { internalType: "uint256"; name: "positionId"; type: "uint256"; }]; stateMutability: "payable"; type: "function"; }, { inputs: readonly [{ components: readonly [{ internalType: "string"; name: "name"; type: "string"; }, { internalType: "string"; name: "symbol"; type: "string"; }, { internalType: "bytes32"; name: "salt"; type: "bytes32"; }, { internalType: "string"; name: "image"; type: "string"; }, { internalType: "string"; name: "metadata"; type: "string"; }, { internalType: "string"; name: "context"; type: "string"; }, { internalType: "uint256"; name: "originatingChainId"; type: "uint256"; }]; internalType: "struct IClanker.TokenConfig"; name: "tokenConfig"; type: "tuple"; }, { internalType: "address"; name: "tokenAdmin"; type: "address"; }]; name: "deployTokenZeroSupply"; outputs: readonly [{ internalType: "address"; name: "tokenAddress"; type: "address"; }]; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; name: "deploymentInfoForToken"; outputs: readonly [{ internalType: "address"; name: "token"; type: "address"; }, { internalType: "uint256"; name: "positionId"; type: "uint256"; }, { internalType: "address"; name: "locker"; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "deprecated"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "user"; type: "address"; }]; name: "getTokensDeployedByUser"; outputs: readonly [{ components: readonly [{ internalType: "address"; name: "token"; type: "address"; }, { internalType: "uint256"; name: "positionId"; type: "uint256"; }, { internalType: "address"; name: "locker"; type: "address"; }]; internalType: "struct IClanker.DeploymentInfo[]"; name: ""; type: "tuple[]"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "uniswapV3Factory_"; type: "address"; }, { internalType: "address"; name: "positionManager_"; type: "address"; }, { internalType: "address"; name: "swapRouter_"; type: "address"; }, { internalType: "address"; name: "weth_"; type: "address"; }, { internalType: "address"; name: "liquidityLocker_"; type: "address"; }, { internalType: "address"; name: "vault_"; type: "address"; }]; name: "initialize"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "liquidityLocker"; outputs: readonly [{ internalType: "contract ILpLockerv2"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "owner"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "positionManager"; outputs: readonly [{ internalType: "contract INonfungiblePositionManager"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "renounceOwnership"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "admin"; type: "address"; }, { internalType: "bool"; name: "isAdmin"; type: "bool"; }]; name: "setAdmin"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "bool"; name: "deprecated_"; type: "bool"; }]; name: "setDeprecated"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "swapRouter"; outputs: readonly [{ internalType: "contract ISwapRouter"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: ""; type: "address"; }, { internalType: "uint256"; name: ""; type: "uint256"; }]; name: "tokensDeployedByUsers"; outputs: readonly [{ internalType: "address"; name: "token"; type: "address"; }, { internalType: "uint256"; name: "positionId"; type: "uint256"; }, { internalType: "address"; name: "locker"; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "newOwner"; type: "address"; }]; name: "transferOwnership"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "uniswapV3Factory"; outputs: readonly [{ internalType: "contract IUniswapV3Factory"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "newLocker"; type: "address"; }]; name: "updateLiquidityLocker"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "newVault"; type: "address"; }]; name: "updateVault"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "vault"; outputs: readonly [{ internalType: "contract IClankerVault"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "weth"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }], | "deployToken" | "deployTokenZeroSupply" | "initialize" | "renounceOwnership" | "setAdmin" | "setDeprecated" | "transferOwnership" | "updateLiquidityLocker" | "claimRewards" | "deployTokenWithCustomTeamRewardRecipient" | "updateVault"> & { error?: undefined; } | UndefinedValues<SimulateContractReturnType<readonly [{ inputs: readonly [{ internalType: "address"; name: "owner_"; type: "address"; }]; stateMutability: "nonpayable"; type: "constructor"; }, { inputs: readonly []; name: "Deprecated"; type: "error"; }, { inputs: readonly []; name: "InvalidCreatorInfo"; type: "error"; }, { inputs: readonly []; name: "InvalidCreatorReward"; type: "error"; }, { inputs: readonly []; name: "InvalidInterfaceInfo"; type: "error"; }, { inputs: readonly []; name: "InvalidTick"; type: "error"; }, { inputs: readonly []; name: "InvalidVaultConfiguration"; type: "error"; }, { inputs: readonly []; name: "NotFound"; type: "error"; }, { inputs: readonly []; name: "OnlyNonOriginatingChains"; type: "error"; }, { inputs: readonly []; name: "OnlyOriginatingChain"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "owner"; type: "address"; }]; name: "OwnableInvalidOwner"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "OwnableUnauthorizedAccount"; type: "error"; }, { inputs: readonly []; name: "ReentrancyGuardReentrantCall"; type: "error"; }, { inputs: readonly []; name: "Unauthorized"; type: "error"; }, { inputs: readonly []; name: "ZeroTeamRewardRecipient"; type: "error"; }, { anonymous: false; inputs: readonly [{ indexed: false; internalType: "address"; name: "oldClankerDeployer"; type: "address"; }, { indexed: false; internalType: "address"; name: "newClankerDeployer"; type: "address"; }]; name: "ClankerDeployerUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: false; internalType: "address"; name: "oldLocker"; type: "address"; }, { indexed: false; internalType: "address"; name: "newLocker"; type: "address"; }]; name: "LiquidityLockerUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "previousOwner"; type: "address"; }, { indexed: true; internalType: "address"; name: "newOwner"; type: "address"; }]; name: "OwnershipTransferred"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: false; internalType: "address"; name: "admin"; type: "address"; }, { indexed: false; internalType: "bool"; name: "isAdmin"; type: "bool"; }]; name: "SetAdmin"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: false; internalType: "bool"; name: "deprecated"; type: "bool"; }]; name: "SetDeprecated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "tokenAddress"; type: "address"; }, { indexed: true; internalType: "address"; name: "creatorAdmin"; type: "address"; }, { indexed: true; internalType: "address"; name: "interfaceAdmin"; type: "address"; }, { indexed: false; internalType: "address"; name: "creatorRewardRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "interfaceRewardRecipient"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "positionId"; type: "uint256"; }, { indexed: false; internalType: "string"; name: "name"; type: "string"; }, { indexed: false; internalType: "string"; name: "symbol"; type: "string"; }, { indexed: false; internalType: "int24"; name: "startingTickIfToken0IsNewToken"; type: "int24"; }, { indexed: false; internalType: "string"; name: "metadata"; type: "string"; }, { indexed: false; internalType: "uint256"; name: "amountTokensBought"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "vaultDuration"; type: "uint256"; }, { indexed: false; internalType: "uint8"; name: "vaultPercentage"; type: "uint8"; }, { indexed: false; internalType: "address"; name: "msgSender"; type: "address"; }]; name: "TokenCreated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: false; internalType: "address"; name: "oldVault"; type: "address"; }, { indexed: false; internalType: "address"; name: "newVault"; type: "address"; }]; name: "VaultUpdated"; type: "event"; }, { inputs: readonly []; name: "MAX_CREATOR_REWARD"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "MAX_TICK"; outputs: readonly [{ internalType: "int24"; name: ""; type: "int24"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "MAX_VAULT_PERCENTAGE"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "POOL_FEE"; outputs: readonly [{ internalType: "uint24"; name: ""; type: "uint24"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "TICK_SPACING"; outputs: readonly [{ internalType: "int24"; name: ""; type: "int24"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "TOKEN_SUPPLY"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; name: "admins"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "token"; type: "address"; }]; name: "claimRewards"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ components: readonly [{ components: ...; internalType: ...; name: ...; type: ...; }, { components: ...; internalType: ...; name: ...; type: ...; }, { components: ...; internalType: ...; name: ...; type: ...; }, { components: ...; internalType: ...; name: ...; type: ...; }, { components: ...; internalType: ...; name: ...; type: ...; }]; internalType: "struct IClanker.DeploymentConfig"; name: "deploymentConfig"; type: "tuple"; }]; name: "deployToken"; outputs: readonly [{ internalType: "address"; name: "tokenAddress"; type: "address"; }, { internalType: "uint256"; name: "positionId"; type: "uint256"; }]; stateMutability: "payable"; type: "function"; }, { inputs: readonly [{ components: readonly [{ components: ...; internalType: ...; name: ...; type: ...; }, { components: ...; internalType: ...; name: ...; type: ...; }, { components: ...; internalType: ...; name: ...; type: ...; }, { components: ...; internalType: ...; name: ...; type: ...; }, { components: ...; internalType: ...; name: ...; type: ...; }]; internalType: "struct IClanker.DeploymentConfig"; name: "deploymentConfig"; type: "tuple"; }, { internalType: "address"; name: "teamRewardRecipient"; type: "address"; }]; name: "deployTokenWithCustomTeamRewardRecipient"; outputs: readonly [{ internalType: "address"; name: "tokenAddress"; type: "address"; }, { internalType: "uint256"; name: "positionId"; type: "uint256"; }]; stateMutability: "payable"; type: "function"; }, { inputs: readonly [{ components: readonly [{ internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }]; internalType: "struct IClanker.TokenConfig"; name: "tokenConfig"; type: "tuple"; }, { internalType: "address"; name: "tokenAdmin"; type: "address"; }]; name: "deployTokenZeroSupply"; outputs: readonly [{ internalType: "address"; name: "tokenAddress"; type: "address"; }]; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; name: "deploymentInfoForToken"; outputs: readonly [{ internalType: "address"; name: "token"; type: "address"; }, { internalType: "uint256"; name: "positionId"; type: "uint256"; }, { internalType: "address"; name: "locker"; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "deprecated"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "user"; type: "address"; }]; name: "getTokensDeployedByUser"; outputs: readonly [{ components: readonly [{ internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }]; internalType: "struct IClanker.DeploymentInfo[]"; name: ""; type: "tuple[]"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "uniswapV3Factory_"; type: "address"; }, { internalType: "address"; name: "positionManager_"; type: "address"; }, { internalType: "address"; name: "swapRouter_"; type: "address"; }, { internalType: "address"; name: "weth_"; type: "address"; }, { internalType: "address"; name: "liquidityLocker_"; type: "address"; }, { internalType: "address"; name: "vault_"; type: "address"; }]; name: "initialize"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "liquidityLocker"; outputs: readonly [{ internalType: "contract ILpLockerv2"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "owner"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "positionManager"; outputs: readonly [{ internalType: "contract INonfungiblePositionManager"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "renounceOwnership"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "admin"; type: "address"; }, { internalType: "bool"; name: "isAdmin"; type: "bool"; }]; name: "setAdmin"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "bool"; name: "deprecated_"; type: "bool"; }]; name: "setDeprecated"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "swapRouter"; outputs: readonly [{ internalType: "contract ISwapRouter"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: ""; type: "address"; }, { internalType: "uint256"; name: ""; type: "uint256"; }]; name: "tokensDeployedByUsers"; outputs: readonly [{ internalType: "address"; name: "token"; type: "address"; }, { internalType: "uint256"; name: "positionId"; type: "uint256"; }, { internalType: "address"; name: "locker"; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "newOwner"; type: "address"; }]; name: "transferOwnership"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "uniswapV3Factory"; outputs: readonly [{ internalType: "contract IUniswapV3Factory"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "newLocker"; type: "address"; }]; name: "updateLiquidityLocker"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "newVault"; type: "address"; }]; name: "updateVault"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "vault"; outputs: readonly [{ internalType: "contract IClankerVault"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "weth"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }], | "deployToken" | "deployTokenZeroSupply" | "initialize" | "renounceOwnership" | "setAdmin" | "setDeprecated" | "transferOwnership" | "updateLiquidityLocker" | "claimRewards" | "deployTokenWithCustomTeamRewardRecipient" | "updateVault">> & { error: ClankerError; }>

The simulated output

deploy()

Defined in: src/v3/index.ts:267

Deploy a token

Parameters

Parameter
Type
Description

token

{ chainId?: 8453 | 2741; context?: { id?: string; interface?: string; messageId?: string; platform?: string; }; devBuy?: { amountOutMin?: number; ethAmount: number; poolKey?: { currency0: `0x${string}`; currency1: `0x${string}`; fee: number; hooks: `0x${string}`; tickSpacing: number; }; }; image?: string; metadata?: { auditUrls?: string[]; description?: string; socialMediaUrls?: { platform: string; url: string; }[]; }; name: string; pool?: { initialMarketCap?: number; quoteToken: `0x${string}`; }; rewards?: { creatorAdmin?: `0x${string}`; creatorReward?: number; creatorRewardRecipient?: `0x${string}`; interfaceAdmin?: `0x${string}`; interfaceRewardRecipient?: `0x${string}`; }; symbol: string; vault?: { durationInDays: number; percentage: number; }; }

The token to deploy

token.chainId?

8453 | 2741

Id of the chain that the token will be deployed to. Defaults to base (8453).

token.context?

{ id?: string; interface?: string; messageId?: string; platform?: string; }

Social provenance for the token. Interface defaults to "SDK" if not set.

token.context.id?

string

User id of the poster on the social platform the token was deployed from. Used for provenance and will be verified by aggregators.

token.context.interface?

string

System the token was deployed via. Defaults to "SDK".

token.context.messageId?

string

Id of the message on the social platform the token was deployed from. Used for provenance and will be verified by aggregators.

token.context.platform?

string

Social platform the token was deployed from. Used for provenance and will be verified by aggregators.

token.devBuy?

{ amountOutMin?: number; ethAmount: number; poolKey?: { currency0: `0x${string}`; currency1: `0x${string}`; fee: number; hooks: `0x${string}`; tickSpacing: number; }; }

Buy some amount of tokens in the deployment transaction.

token.devBuy.amountOutMin?

number

If the paired token is not ETH, add an amount expected for the ETH -> pair buy.

token.devBuy.ethAmount

number

Value in ETH of the tokens to buy

token.devBuy.poolKey?

{ currency0: `0x${string}`; currency1: `0x${string}`; fee: number; hooks: `0x${string}`; tickSpacing: number; }

If the paired token is not ETH, add a route for the ETH to buy the pair.

token.devBuy.poolKey.currency0

`0x${string}`

-

token.devBuy.poolKey.currency1

`0x${string}`

-

token.devBuy.poolKey.fee

number

-

token.devBuy.poolKey.hooks

`0x${string}`

-

token.devBuy.poolKey.tickSpacing

number

-

token.image?

string

Image for the token. This should be a normal or ipfs url.

token.metadata?

{ auditUrls?: string[]; description?: string; socialMediaUrls?: { platform: string; url: string; }[]; }

Metadata for the token.

token.metadata.auditUrls?

string[]

Audits for other contracts or services offered by the project.

token.metadata.description?

string

Description of the token or token project.

token.metadata.socialMediaUrls?

{ platform: string; url: string; }[]

Socials for the token. These may be displayed on aggregators.

token.name

string

Name of the token. Example: "My Token".

token.pool?

{ initialMarketCap?: number; quoteToken: `0x${string}`; }

Defines the paired token and initial marketcap. Defaults to WETH (on Base) and 10 ETH mc.

token.pool.initialMarketCap?

number

Initial marketcap for the clanker.

token.pool.quoteToken

`0x${string}`

Token to pair the clanker with.

token.rewards?

{ creatorAdmin?: `0x${string}`; creatorReward?: number; creatorRewardRecipient?: `0x${string}`; interfaceAdmin?: `0x${string}`; interfaceRewardRecipient?: `0x${string}`; }

Rewards and admins for the token.

token.rewards.creatorAdmin?

`0x${string}`

-

token.rewards.creatorReward?

number

-

token.rewards.creatorRewardRecipient?

`0x${string}`

-

token.rewards.interfaceAdmin?

`0x${string}`

-

token.rewards.interfaceRewardRecipient?

`0x${string}`

-

token.symbol

string

Symbol for the token. Example: "MTK".

token.vault?

{ durationInDays: number; percentage: number; }

Vault a percent of the tokens for some number of days.

token.vault.durationInDays

number

How many days to vault for.

token.vault.percentage

number

What percentage of the tokens to vault.

Returns

Promise< | { txHash: `0x${string}`; waitForTransaction: () => ClankerResult<{ address: `0x${string}`; }>; } & { error?: undefined; } | UndefinedValues<{ txHash: `0x${string}`; waitForTransaction: () => ClankerResult<{ address: `0x${string}`; }>; }> & { error: ClankerError; }>

Transaction hash and awaitable function for full deployment

deploySimulate()

Defined in: src/v3/index.ts:251

Simulate a token deployment

Parameters

Parameter
Type
Description

token

{ chainId?: 8453 | 2741; context?: { id?: string; interface?: string; messageId?: string; platform?: string; }; devBuy?: { amountOutMin?: number; ethAmount: number; poolKey?: { currency0: `0x${string}`; currency1: `0x${string}`; fee: number; hooks: `0x${string}`; tickSpacing: number; }; }; image?: string; metadata?: { auditUrls?: string[]; description?: string; socialMediaUrls?: { platform: string; url: string; }[]; }; name: string; pool?: { initialMarketCap?: number; quoteToken: `0x${string}`; }; rewards?: { creatorAdmin?: `0x${string}`; creatorReward?: number; creatorRewardRecipient?: `0x${string}`; interfaceAdmin?: `0x${string}`; interfaceRewardRecipient?: `0x${string}`; }; symbol: string; vault?: { durationInDays: number; percentage: number; }; }

The token to deploy

token.chainId?

8453 | 2741

Id of the chain that the token will be deployed to. Defaults to base (8453).

token.context?

{ id?: string; interface?: string; messageId?: string; platform?: string; }

Social provenance for the token. Interface defaults to "SDK" if not set.

token.context.id?

string

User id of the poster on the social platform the token was deployed from. Used for provenance and will be verified by aggregators.

token.context.interface?

string

System the token was deployed via. Defaults to "SDK".

token.context.messageId?

string

Id of the message on the social platform the token was deployed from. Used for provenance and will be verified by aggregators.

token.context.platform?

string

Social platform the token was deployed from. Used for provenance and will be verified by aggregators.

token.devBuy?

{ amountOutMin?: number; ethAmount: number; poolKey?: { currency0: `0x${string}`; currency1: `0x${string}`; fee: number; hooks: `0x${string}`; tickSpacing: number; }; }

Buy some amount of tokens in the deployment transaction.

token.devBuy.amountOutMin?

number

If the paired token is not ETH, add an amount expected for the ETH -> pair buy.

token.devBuy.ethAmount?

number

Value in ETH of the tokens to buy

token.devBuy.poolKey?

{ currency0: `0x${string}`; currency1: `0x${string}`; fee: number; hooks: `0x${string}`; tickSpacing: number; }

If the paired token is not ETH, add a route for the ETH to buy the pair.

token.devBuy.poolKey.currency0?

`0x${string}`

-

token.devBuy.poolKey.currency1?

`0x${string}`

-

token.devBuy.poolKey.fee?

number

-

token.devBuy.poolKey.hooks?

`0x${string}`

-

token.devBuy.poolKey.tickSpacing?

number

-

token.image?

string

Image for the token. This should be a normal or ipfs url.

token.metadata?

{ auditUrls?: string[]; description?: string; socialMediaUrls?: { platform: string; url: string; }[]; }

Metadata for the token.

token.metadata.auditUrls?

string[]

Audits for other contracts or services offered by the project.

token.metadata.description?

string

Description of the token or token project.

token.metadata.socialMediaUrls?

{ platform: string; url: string; }[]

Socials for the token. These may be displayed on aggregators.

token.name?

string

Name of the token. Example: "My Token".

token.pool?

{ initialMarketCap?: number; quoteToken: `0x${string}`; }

Defines the paired token and initial marketcap. Defaults to WETH (on Base) and 10 ETH mc.

token.pool.initialMarketCap?

number

Initial marketcap for the clanker.

token.pool.quoteToken?

`0x${string}`

Token to pair the clanker with.

token.rewards?

{ creatorAdmin?: `0x${string}`; creatorReward?: number; creatorRewardRecipient?: `0x${string}`; interfaceAdmin?: `0x${string}`; interfaceRewardRecipient?: `0x${string}`; }

Rewards and admins for the token.

token.rewards.creatorAdmin?

`0x${string}`

-

token.rewards.creatorReward?

number

-

token.rewards.creatorRewardRecipient?

`0x${string}`

-

token.rewards.interfaceAdmin?

`0x${string}`

-

token.rewards.interfaceRewardRecipient?

`0x${string}`

-

token.symbol?

string

Symbol for the token. Example: "MTK".

token.vault?

{ durationInDays: number; percentage: number; }

Vault a percent of the tokens for some number of days.

token.vault.durationInDays?

number

How many days to vault for.

token.vault.percentage?

number

What percentage of the tokens to vault.

account?

Account

-

Returns

Promise< | SimulateContractReturnType<ClankerFactory, | "claimTeamFees" | "deployToken" | "deployTokenZeroSupply" | "initialize" | "renounceOwnership" | "setAdmin" | "setDeprecated" | "setExtension" | "setHook" | "setLocker" | "setMevModule" | "setTeamFeeRecipient" | "transferOwnership" | "updateLiquidityLocker" | "claimRewards" | "deployTokenWithCustomTeamRewardRecipient" | "updateVault"> & { error?: undefined; } | UndefinedValues<SimulateContractReturnType<ClankerFactory, | "claimTeamFees" | "deployToken" | "deployTokenZeroSupply" | "initialize" | "renounceOwnership" | "setAdmin" | "setDeprecated" | "setExtension" | "setHook" | "setLocker" | "setMevModule" | "setTeamFeeRecipient" | "transferOwnership" | "updateLiquidityLocker" | "claimRewards" | "deployTokenWithCustomTeamRewardRecipient" | "updateVault">> & { error: ClankerError; }>

Abi transaction

getClaimRewardsTransaction()

Defined in: src/v3/index.ts:62

Get an abi-typed transaction for claiming rewards on a token.

Parameters

Parameter
Type
Description

token

`0x${string}`

The token to claim for

Returns

Promise<ClankerTransactionConfig<readonly [{ inputs: readonly [{ internalType: "address"; name: "owner_"; type: "address"; }]; stateMutability: "nonpayable"; type: "constructor"; }, { inputs: readonly []; name: "Deprecated"; type: "error"; }, { inputs: readonly []; name: "InvalidCreatorInfo"; type: "error"; }, { inputs: readonly []; name: "InvalidCreatorReward"; type: "error"; }, { inputs: readonly []; name: "InvalidInterfaceInfo"; type: "error"; }, { inputs: readonly []; name: "InvalidTick"; type: "error"; }, { inputs: readonly []; name: "InvalidVaultConfiguration"; type: "error"; }, { inputs: readonly []; name: "NotFound"; type: "error"; }, { inputs: readonly []; name: "OnlyNonOriginatingChains"; type: "error"; }, { inputs: readonly []; name: "OnlyOriginatingChain"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "owner"; type: "address"; }]; name: "OwnableInvalidOwner"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "OwnableUnauthorizedAccount"; type: "error"; }, { inputs: readonly []; name: "ReentrancyGuardReentrantCall"; type: "error"; }, { inputs: readonly []; name: "Unauthorized"; type: "error"; }, { inputs: readonly []; name: "ZeroTeamRewardRecipient"; type: "error"; }, { anonymous: false; inputs: readonly [{ indexed: false; internalType: "address"; name: "oldClankerDeployer"; type: "address"; }, { indexed: false; internalType: "address"; name: "newClankerDeployer"; type: "address"; }]; name: "ClankerDeployerUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: false; internalType: "address"; name: "oldLocker"; type: "address"; }, { indexed: false; internalType: "address"; name: "newLocker"; type: "address"; }]; name: "LiquidityLockerUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "previousOwner"; type: "address"; }, { indexed: true; internalType: "address"; name: "newOwner"; type: "address"; }]; name: "OwnershipTransferred"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: false; internalType: "address"; name: "admin"; type: "address"; }, { indexed: false; internalType: "bool"; name: "isAdmin"; type: "bool"; }]; name: "SetAdmin"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: false; internalType: "bool"; name: "deprecated"; type: "bool"; }]; name: "SetDeprecated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "tokenAddress"; type: "address"; }, { indexed: true; internalType: "address"; name: "creatorAdmin"; type: "address"; }, { indexed: true; internalType: "address"; name: "interfaceAdmin"; type: "address"; }, { indexed: false; internalType: "address"; name: "creatorRewardRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "interfaceRewardRecipient"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "positionId"; type: "uint256"; }, { indexed: false; internalType: "string"; name: "name"; type: "string"; }, { indexed: false; internalType: "string"; name: "symbol"; type: "string"; }, { indexed: false; internalType: "int24"; name: "startingTickIfToken0IsNewToken"; type: "int24"; }, { indexed: false; internalType: "string"; name: "metadata"; type: "string"; }, { indexed: false; internalType: "uint256"; name: "amountTokensBought"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "vaultDuration"; type: "uint256"; }, { indexed: false; internalType: "uint8"; name: "vaultPercentage"; type: "uint8"; }, { indexed: false; internalType: "address"; name: "msgSender"; type: "address"; }]; name: "TokenCreated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: false; internalType: "address"; name: "oldVault"; type: "address"; }, { indexed: false; internalType: "address"; name: "newVault"; type: "address"; }]; name: "VaultUpdated"; type: "event"; }, { inputs: readonly []; name: "MAX_CREATOR_REWARD"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "MAX_TICK"; outputs: readonly [{ internalType: "int24"; name: ""; type: "int24"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "MAX_VAULT_PERCENTAGE"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "POOL_FEE"; outputs: readonly [{ internalType: "uint24"; name: ""; type: "uint24"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "TICK_SPACING"; outputs: readonly [{ internalType: "int24"; name: ""; type: "int24"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "TOKEN_SUPPLY"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; name: "admins"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "token"; type: "address"; }]; name: "claimRewards"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ components: readonly [{ components: readonly [{ internalType: "string"; name: "name"; type: "string"; }, { internalType: "string"; name: "symbol"; type: "string"; }, { internalType: "bytes32"; name: "salt"; type: "bytes32"; }, { internalType: "string"; name: "image"; type: "string"; }, { internalType: "string"; name: "metadata"; type: "string"; }, { internalType: "string"; name: "context"; type: "string"; }, { internalType: "uint256"; name: "originatingChainId"; type: "uint256"; }]; internalType: "struct IClanker.TokenConfig"; name: "tokenConfig"; type: "tuple"; }, { components: readonly [{ internalType: "uint8"; name: "vaultPercentage"; type: "uint8"; }, { internalType: "uint256"; name: "vaultDuration"; type: "uint256"; }]; internalType: "struct IClanker.VaultConfig"; name: "vaultConfig"; type: "tuple"; }, { components: readonly [{ internalType: "address"; name: "pairedToken"; type: "address"; }, { internalType: "int24"; name: "tickIfToken0IsNewToken"; type: "int24"; }]; internalType: "struct IClanker.PoolConfig"; name: "poolConfig"; type: "tuple"; }, { components: readonly [{ internalType: "uint24"; name: "pairedTokenPoolFee"; type: "uint24"; }, { internalType: "uint256"; name: "pairedTokenSwapAmountOutMinimum"; type: "uint256"; }]; internalType: "struct IClanker.InitialBuyConfig"; name: "initialBuyConfig"; type: "tuple"; }, { components: readonly [{ internalType: "uint256"; name: "creatorReward"; type: "uint256"; }, { internalType: "address"; name: "creatorAdmin"; type: "address"; }, { internalType: "address"; name: "creatorRewardRecipient"; type: "address"; }, { internalType: "address"; name: "interfaceAdmin"; type: "address"; }, { internalType: "address"; name: "interfaceRewardRecipient"; type: "address"; }]; internalType: "struct IClanker.RewardsConfig"; name: "rewardsConfig"; type: "tuple"; }]; internalType: "struct IClanker.DeploymentConfig"; name: "deploymentConfig"; type: "tuple"; }]; name: "deployToken"; outputs: readonly [{ internalType: "address"; name: "tokenAddress"; type: "address"; }, { internalType: "uint256"; name: "positionId"; type: "uint256"; }]; stateMutability: "payable"; type: "function"; }, { inputs: readonly [{ components: readonly [{ components: readonly [{ internalType: "string"; name: "name"; type: "string"; }, { internalType: "string"; name: "symbol"; type: "string"; }, { internalType: "bytes32"; name: "salt"; type: "bytes32"; }, { internalType: "string"; name: "image"; type: "string"; }, { internalType: "string"; name: "metadata"; type: "string"; }, { internalType: "string"; name: "context"; type: "string"; }, { internalType: "uint256"; name: "originatingChainId"; type: "uint256"; }]; internalType: "struct IClanker.TokenConfig"; name: "tokenConfig"; type: "tuple"; }, { components: readonly [{ internalType: "uint8"; name: "vaultPercentage"; type: "uint8"; }, { internalType: "uint256"; name: "vaultDuration"; type: "uint256"; }]; internalType: "struct IClanker.VaultConfig"; name: "vaultConfig"; type: "tuple"; }, { components: readonly [{ internalType: "address"; name: "pairedToken"; type: "address"; }, { internalType: "int24"; name: "tickIfToken0IsNewToken"; type: "int24"; }]; internalType: "struct IClanker.PoolConfig"; name: "poolConfig"; type: "tuple"; }, { components: readonly [{ internalType: "uint24"; name: "pairedTokenPoolFee"; type: "uint24"; }, { internalType: "uint256"; name: "pairedTokenSwapAmountOutMinimum"; type: "uint256"; }]; internalType: "struct IClanker.InitialBuyConfig"; name: "initialBuyConfig"; type: "tuple"; }, { components: readonly [{ internalType: "uint256"; name: "creatorReward"; type: "uint256"; }, { internalType: "address"; name: "creatorAdmin"; type: "address"; }, { internalType: "address"; name: "creatorRewardRecipient"; type: "address"; }, { internalType: "address"; name: "interfaceAdmin"; type: "address"; }, { internalType: "address"; name: "interfaceRewardRecipient"; type: "address"; }]; internalType: "struct IClanker.RewardsConfig"; name: "rewardsConfig"; type: "tuple"; }]; internalType: "struct IClanker.DeploymentConfig"; name: "deploymentConfig"; type: "tuple"; }, { internalType: "address"; name: "teamRewardRecipient"; type: "address"; }]; name: "deployTokenWithCustomTeamRewardRecipient"; outputs: readonly [{ internalType: "address"; name: "tokenAddress"; type: "address"; }, { internalType: "uint256"; name: "positionId"; type: "uint256"; }]; stateMutability: "payable"; type: "function"; }, { inputs: readonly [{ components: readonly [{ internalType: "string"; name: "name"; type: "string"; }, { internalType: "string"; name: "symbol"; type: "string"; }, { internalType: "bytes32"; name: "salt"; type: "bytes32"; }, { internalType: "string"; name: "image"; type: "string"; }, { internalType: "string"; name: "metadata"; type: "string"; }, { internalType: "string"; name: "context"; type: "string"; }, { internalType: "uint256"; name: "originatingChainId"; type: "uint256"; }]; internalType: "struct IClanker.TokenConfig"; name: "tokenConfig"; type: "tuple"; }, { internalType: "address"; name: "tokenAdmin"; type: "address"; }]; name: "deployTokenZeroSupply"; outputs: readonly [{ internalType: "address"; name: "tokenAddress"; type: "address"; }]; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; name: "deploymentInfoForToken"; outputs: readonly [{ internalType: "address"; name: "token"; type: "address"; }, { internalType: "uint256"; name: "positionId"; type: "uint256"; }, { internalType: "address"; name: "locker"; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "deprecated"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "user"; type: "address"; }]; name: "getTokensDeployedByUser"; outputs: readonly [{ components: readonly [{ internalType: "address"; name: "token"; type: "address"; }, { internalType: "uint256"; name: "positionId"; type: "uint256"; }, { internalType: "address"; name: "locker"; type: "address"; }]; internalType: "struct IClanker.DeploymentInfo[]"; name: ""; type: "tuple[]"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "uniswapV3Factory_"; type: "address"; }, { internalType: "address"; name: "positionManager_"; type: "address"; }, { internalType: "address"; name: "swapRouter_"; type: "address"; }, { internalType: "address"; name: "weth_"; type: "address"; }, { internalType: "address"; name: "liquidityLocker_"; type: "address"; }, { internalType: "address"; name: "vault_"; type: "address"; }]; name: "initialize"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "liquidityLocker"; outputs: readonly [{ internalType: "contract ILpLockerv2"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "owner"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "positionManager"; outputs: readonly [{ internalType: "contract INonfungiblePositionManager"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "renounceOwnership"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "admin"; type: "address"; }, { internalType: "bool"; name: "isAdmin"; type: "bool"; }]; name: "setAdmin"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "bool"; name: "deprecated_"; type: "bool"; }]; name: "setDeprecated"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "swapRouter"; outputs: readonly [{ internalType: "contract ISwapRouter"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: ""; type: "address"; }, { internalType: "uint256"; name: ""; type: "uint256"; }]; name: "tokensDeployedByUsers"; outputs: readonly [{ internalType: "address"; name: "token"; type: "address"; }, { internalType: "uint256"; name: "positionId"; type: "uint256"; }, { internalType: "address"; name: "locker"; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "newOwner"; type: "address"; }]; name: "transferOwnership"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "uniswapV3Factory"; outputs: readonly [{ internalType: "contract IUniswapV3Factory"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "newLocker"; type: "address"; }]; name: "updateLiquidityLocker"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "newVault"; type: "address"; }]; name: "updateVault"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "vault"; outputs: readonly [{ internalType: "contract IClankerVault"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "weth"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }]>>

Abi transaction

getDeployTransaction()

Defined in: src/v3/index.ts:240

Get an abi-typed transaction for deploying a clanker.

Parameters

Parameter
Type
Description

token

{ chainId?: 8453 | 2741; context?: { id?: string; interface?: string; messageId?: string; platform?: string; }; devBuy?: { amountOutMin?: number; ethAmount: number; poolKey?: { currency0: `0x${string}`; currency1: `0x${string}`; fee: number; hooks: `0x${string}`; tickSpacing: number; }; }; image?: string; metadata?: { auditUrls?: string[]; description?: string; socialMediaUrls?: { platform: string; url: string; }[]; }; name: string; pool?: { initialMarketCap?: number; quoteToken: `0x${string}`; }; rewards?: { creatorAdmin?: `0x${string}`; creatorReward?: number; creatorRewardRecipient?: `0x${string}`; interfaceAdmin?: `0x${string}`; interfaceRewardRecipient?: `0x${string}`; }; symbol: string; vault?: { durationInDays: number; percentage: number; }; }

The token to deploy

token.chainId?

8453 | 2741

Id of the chain that the token will be deployed to. Defaults to base (8453).

token.context?

{ id?: string; interface?: string; messageId?: string; platform?: string; }

Social provenance for the token. Interface defaults to "SDK" if not set.

token.context.id?

string

User id of the poster on the social platform the token was deployed from. Used for provenance and will be verified by aggregators.

token.context.interface?

string

System the token was deployed via. Defaults to "SDK".

token.context.messageId?

string

Id of the message on the social platform the token was deployed from. Used for provenance and will be verified by aggregators.

token.context.platform?

string

Social platform the token was deployed from. Used for provenance and will be verified by aggregators.

token.devBuy?

{ amountOutMin?: number; ethAmount: number; poolKey?: { currency0: `0x${string}`; currency1: `0x${string}`; fee: number; hooks: `0x${string}`; tickSpacing: number; }; }

Buy some amount of tokens in the deployment transaction.

token.devBuy.amountOutMin?

number

If the paired token is not ETH, add an amount expected for the ETH -> pair buy.

token.devBuy.ethAmount

number

Value in ETH of the tokens to buy

token.devBuy.poolKey?

{ currency0: `0x${string}`; currency1: `0x${string}`; fee: number; hooks: `0x${string}`; tickSpacing: number; }

If the paired token is not ETH, add a route for the ETH to buy the pair.

token.devBuy.poolKey.currency0

`0x${string}`

-

token.devBuy.poolKey.currency1

`0x${string}`

-

token.devBuy.poolKey.fee

number

-

token.devBuy.poolKey.hooks

`0x${string}`

-

token.devBuy.poolKey.tickSpacing

number

-

token.image?

string

Image for the token. This should be a normal or ipfs url.

token.metadata?

{ auditUrls?: string[]; description?: string; socialMediaUrls?: { platform: string; url: string; }[]; }

Metadata for the token.

token.metadata.auditUrls?

string[]

Audits for other contracts or services offered by the project.

token.metadata.description?

string

Description of the token or token project.

token.metadata.socialMediaUrls?

{ platform: string; url: string; }[]

Socials for the token. These may be displayed on aggregators.

token.name

string

Name of the token. Example: "My Token".

token.pool?

{ initialMarketCap?: number; quoteToken: `0x${string}`; }

Defines the paired token and initial marketcap. Defaults to WETH (on Base) and 10 ETH mc.

token.pool.initialMarketCap?

number

Initial marketcap for the clanker.

token.pool.quoteToken

`0x${string}`

Token to pair the clanker with.

token.rewards?

{ creatorAdmin?: `0x${string}`; creatorReward?: number; creatorRewardRecipient?: `0x${string}`; interfaceAdmin?: `0x${string}`; interfaceRewardRecipient?: `0x${string}`; }

Rewards and admins for the token.

token.rewards.creatorAdmin?

`0x${string}`

-

token.rewards.creatorReward?

number

-

token.rewards.creatorRewardRecipient?

`0x${string}`

-

token.rewards.interfaceAdmin?

`0x${string}`

-

token.rewards.interfaceRewardRecipient?

`0x${string}`

-

token.symbol

string

Symbol for the token. Example: "MTK".

token.vault?

{ durationInDays: number; percentage: number; }

Vault a percent of the tokens for some number of days.

token.vault.durationInDays

number

How many days to vault for.

token.vault.percentage

number

What percentage of the tokens to vault.

requestorAddress

`0x${string}`

Requestor for the deployment. Various admins will fall back to this.

Returns

Promise<ClankerTransactionConfig<readonly [{ inputs: readonly [{ internalType: "address"; name: "owner_"; type: "address"; }]; stateMutability: "nonpayable"; type: "constructor"; }, { inputs: readonly []; name: "Deprecated"; type: "error"; }, { inputs: readonly []; name: "InvalidCreatorInfo"; type: "error"; }, { inputs: readonly []; name: "InvalidCreatorReward"; type: "error"; }, { inputs: readonly []; name: "InvalidInterfaceInfo"; type: "error"; }, { inputs: readonly []; name: "InvalidTick"; type: "error"; }, { inputs: readonly []; name: "InvalidVaultConfiguration"; type: "error"; }, { inputs: readonly []; name: "NotFound"; type: "error"; }, { inputs: readonly []; name: "OnlyNonOriginatingChains"; type: "error"; }, { inputs: readonly []; name: "OnlyOriginatingChain"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "owner"; type: "address"; }]; name: "OwnableInvalidOwner"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "OwnableUnauthorizedAccount"; type: "error"; }, { inputs: readonly []; name: "ReentrancyGuardReentrantCall"; type: "error"; }, { inputs: readonly []; name: "Unauthorized"; type: "error"; }, { inputs: readonly []; name: "ZeroTeamRewardRecipient"; type: "error"; }, { anonymous: false; inputs: readonly [{ indexed: false; internalType: "address"; name: "oldClankerDeployer"; type: "address"; }, { indexed: false; internalType: "address"; name: "newClankerDeployer"; type: "address"; }]; name: "ClankerDeployerUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: false; internalType: "address"; name: "oldLocker"; type: "address"; }, { indexed: false; internalType: "address"; name: "newLocker"; type: "address"; }]; name: "LiquidityLockerUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "previousOwner"; type: "address"; }, { indexed: true; internalType: "address"; name: "newOwner"; type: "address"; }]; name: "OwnershipTransferred"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: false; internalType: "address"; name: "admin"; type: "address"; }, { indexed: false; internalType: "bool"; name: "isAdmin"; type: "bool"; }]; name: "SetAdmin"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: false; internalType: "bool"; name: "deprecated"; type: "bool"; }]; name: "SetDeprecated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "tokenAddress"; type: "address"; }, { indexed: true; internalType: "address"; name: "creatorAdmin"; type: "address"; }, { indexed: true; internalType: "address"; name: "interfaceAdmin"; type: "address"; }, { indexed: false; internalType: "address"; name: "creatorRewardRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "interfaceRewardRecipient"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "positionId"; type: "uint256"; }, { indexed: false; internalType: "string"; name: "name"; type: "string"; }, { indexed: false; internalType: "string"; name: "symbol"; type: "string"; }, { indexed: false; internalType: "int24"; name: "startingTickIfToken0IsNewToken"; type: "int24"; }, { indexed: false; internalType: "string"; name: "metadata"; type: "string"; }, { indexed: false; internalType: "uint256"; name: "amountTokensBought"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "vaultDuration"; type: "uint256"; }, { indexed: false; internalType: "uint8"; name: "vaultPercentage"; type: "uint8"; }, { indexed: false; internalType: "address"; name: "msgSender"; type: "address"; }]; name: "TokenCreated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: false; internalType: "address"; name: "oldVault"; type: "address"; }, { indexed: false; internalType: "address"; name: "newVault"; type: "address"; }]; name: "VaultUpdated"; type: "event"; }, { inputs: readonly []; name: "MAX_CREATOR_REWARD"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "MAX_TICK"; outputs: readonly [{ internalType: "int24"; name: ""; type: "int24"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "MAX_VAULT_PERCENTAGE"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "POOL_FEE"; outputs: readonly [{ internalType: "uint24"; name: ""; type: "uint24"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "TICK_SPACING"; outputs: readonly [{ internalType: "int24"; name: ""; type: "int24"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "TOKEN_SUPPLY"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; name: "admins"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "token"; type: "address"; }]; name: "claimRewards"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ components: readonly [{ components: readonly [{ internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }]; internalType: "struct IClanker.TokenConfig"; name: "tokenConfig"; type: "tuple"; }, { components: readonly [{ internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }]; internalType: "struct IClanker.VaultConfig"; name: "vaultConfig"; type: "tuple"; }, { components: readonly [{ internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }]; internalType: "struct IClanker.PoolConfig"; name: "poolConfig"; type: "tuple"; }, { components: readonly [{ internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }]; internalType: "struct IClanker.InitialBuyConfig"; name: "initialBuyConfig"; type: "tuple"; }, { components: readonly [{ internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }]; internalType: "struct IClanker.RewardsConfig"; name: "rewardsConfig"; type: "tuple"; }]; internalType: "struct IClanker.DeploymentConfig"; name: "deploymentConfig"; type: "tuple"; }]; name: "deployToken"; outputs: readonly [{ internalType: "address"; name: "tokenAddress"; type: "address"; }, { internalType: "uint256"; name: "positionId"; type: "uint256"; }]; stateMutability: "payable"; type: "function"; }, { inputs: readonly [{ components: readonly [{ components: readonly [{ internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }]; internalType: "struct IClanker.TokenConfig"; name: "tokenConfig"; type: "tuple"; }, { components: readonly [{ internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }]; internalType: "struct IClanker.VaultConfig"; name: "vaultConfig"; type: "tuple"; }, { components: readonly [{ internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }]; internalType: "struct IClanker.PoolConfig"; name: "poolConfig"; type: "tuple"; }, { components: readonly [{ internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }]; internalType: "struct IClanker.InitialBuyConfig"; name: "initialBuyConfig"; type: "tuple"; }, { components: readonly [{ internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }]; internalType: "struct IClanker.RewardsConfig"; name: "rewardsConfig"; type: "tuple"; }]; internalType: "struct IClanker.DeploymentConfig"; name: "deploymentConfig"; type: "tuple"; }, { internalType: "address"; name: "teamRewardRecipient"; type: "address"; }]; name: "deployTokenWithCustomTeamRewardRecipient"; outputs: readonly [{ internalType: "address"; name: "tokenAddress"; type: "address"; }, { internalType: "uint256"; name: "positionId"; type: "uint256"; }]; stateMutability: "payable"; type: "function"; }, { inputs: readonly [{ components: readonly [{ internalType: "string"; name: "name"; type: "string"; }, { internalType: "string"; name: "symbol"; type: "string"; }, { internalType: "bytes32"; name: "salt"; type: "bytes32"; }, { internalType: "string"; name: "image"; type: "string"; }, { internalType: "string"; name: "metadata"; type: "string"; }, { internalType: "string"; name: "context"; type: "string"; }, { internalType: "uint256"; name: "originatingChainId"; type: "uint256"; }]; internalType: "struct IClanker.TokenConfig"; name: "tokenConfig"; type: "tuple"; }, { internalType: "address"; name: "tokenAdmin"; type: "address"; }]; name: "deployTokenZeroSupply"; outputs: readonly [{ internalType: "address"; name: "tokenAddress"; type: "address"; }]; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; name: "deploymentInfoForToken"; outputs: readonly [{ internalType: "address"; name: "token"; type: "address"; }, { internalType: "uint256"; name: "positionId"; type: "uint256"; }, { internalType: "address"; name: "locker"; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "deprecated"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "user"; type: "address"; }]; name: "getTokensDeployedByUser"; outputs: readonly [{ components: readonly [{ internalType: "address"; name: "token"; type: "address"; }, { internalType: "uint256"; name: "positionId"; type: "uint256"; }, { internalType: "address"; name: "locker"; type: "address"; }]; internalType: "struct IClanker.DeploymentInfo[]"; name: ""; type: "tuple[]"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "uniswapV3Factory_"; type: "address"; }, { internalType: "address"; name: "positionManager_"; type: "address"; }, { internalType: "address"; name: "swapRouter_"; type: "address"; }, { internalType: "address"; name: "weth_"; type: "address"; }, { internalType: "address"; name: "liquidityLocker_"; type: "address"; }, { internalType: "address"; name: "vault_"; type: "address"; }]; name: "initialize"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "liquidityLocker"; outputs: readonly [{ internalType: "contract ILpLockerv2"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "owner"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "positionManager"; outputs: readonly [{ internalType: "contract INonfungiblePositionManager"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "renounceOwnership"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "admin"; type: "address"; }, { internalType: "bool"; name: "isAdmin"; type: "bool"; }]; name: "setAdmin"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "bool"; name: "deprecated_"; type: "bool"; }]; name: "setDeprecated"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "swapRouter"; outputs: readonly [{ internalType: "contract ISwapRouter"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: ""; type: "address"; }, { internalType: "uint256"; name: ""; type: "uint256"; }]; name: "tokensDeployedByUsers"; outputs: readonly [{ internalType: "address"; name: "token"; type: "address"; }, { internalType: "uint256"; name: "positionId"; type: "uint256"; }, { internalType: "address"; name: "locker"; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "newOwner"; type: "address"; }]; name: "transferOwnership"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "uniswapV3Factory"; outputs: readonly [{ internalType: "contract IUniswapV3Factory"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "newLocker"; type: "address"; }]; name: "updateLiquidityLocker"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "newVault"; type: "address"; }]; name: "updateVault"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "vault"; outputs: readonly [{ internalType: "contract IClankerVault"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "weth"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }], "deployToken"> & { expectedAddress?: `0x${string}`; }>

Abi transaction

getUpdateCreatorRewardAdminTransaction()

Defined in: src/v3/index.ts:179

Get an abi-typed transaction for updating the creator reward admin.

Parameters

Parameter
Type
Description

tokenId

bigint

The token ID to update the creator reward admin for

newAdmin

`0x${string}`

The new admin address

Returns

Promise<{ abi: readonly [{ inputs: readonly [{ internalType: "address"; name: "owner_"; type: "address"; }, { internalType: "address"; name: "tokenFactory_"; type: "address"; }, { internalType: "address"; name: "positionManager_"; type: "address"; }, { internalType: "address"; name: "teamRecipient_"; type: "address"; }]; stateMutability: "nonpayable"; type: "constructor"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }]; name: "AlreadyKnownTokenId"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "creatorReward"; type: "uint256"; }]; name: "InvalidCreatorReward"; type: "error"; }, { inputs: readonly []; name: "InvalidMaxCreatorReward"; type: "error"; }, { inputs: readonly []; name: "InvalidTeamRecipient"; type: "error"; }, { inputs: readonly []; name: "MaxCreatorRewardNotSet"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "user"; type: "address"; }]; name: "NotAllowed"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "owner"; type: "address"; }]; name: "OwnableInvalidOwner"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "OwnableUnauthorizedAccount"; type: "error"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "creatorRecipient"; type: "address"; }, { indexed: true; internalType: "address"; name: "interfaceRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "teamRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "token0"; type: "address"; }, { indexed: false; internalType: "address"; name: "token1"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "creatorReward0"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "creatorReward1"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "interfaceReward0"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "interfaceReward1"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "teamReward0"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "teamReward1"; type: "uint256"; }]; name: "ClaimedRewards"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "oldAdmin"; type: "address"; }, { indexed: false; internalType: "address"; name: "newAdmin"; type: "address"; }]; name: "CreatorRewardRecipientAdminUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "oldRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "CreatorRewardRecipientUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "oldAdmin"; type: "address"; }, { indexed: false; internalType: "address"; name: "newAdmin"; type: "address"; }]; name: "InterfaceRewardRecipientAdminUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "oldRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "InterfaceRewardRecipientUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "previousOwner"; type: "address"; }, { indexed: true; internalType: "address"; name: "newOwner"; type: "address"; }]; name: "OwnershipTransferred"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "from"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "tokenId"; type: "uint256"; }]; name: "Received"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "oldRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "TeamOverrideRewardRecipientUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "oldRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "TeamRecipientUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: false; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "creatorReward"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "creator"; type: "address"; }, { indexed: true; internalType: "address"; name: "interfacer"; type: "address"; }]; name: "TokenRewardAdded"; type: "event"; }, { inputs: readonly []; name: "MAX_CREATOR_REWARD"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "TEAM_REWARD"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ components: readonly [{ internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { internalType: "uint256"; name: "creatorReward"; type: "uint256"; }, { components: readonly [{ internalType: "address"; name: "admin"; type: "address"; }, { internalType: "address"; name: "recipient"; type: "address"; }]; internalType: "struct ILpLockerv2.RewardRecipient"; name: "creator"; type: "tuple"; }, { components: readonly [{ internalType: "address"; name: "admin"; type: "address"; }, { internalType: "address"; name: "recipient"; type: "address"; }]; internalType: "struct ILpLockerv2.RewardRecipient"; name: "interfacer"; type: "tuple"; }]; internalType: "struct ILpLockerv2.TokenRewardInfo"; name: "tokenRewardInfo"; type: "tuple"; }]; name: "addTokenReward"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }]; name: "collectRewards"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: ""; type: "address"; }, { internalType: "uint256"; name: ""; type: "uint256"; }]; name: "creatorTokenIds"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "factory"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "user"; type: "address"; }]; name: "getLpTokenIdsForCreator"; outputs: readonly [{ internalType: "uint256[]"; name: ""; type: "uint256[]"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: ""; type: "address"; }, { internalType: "address"; name: "from"; type: "address"; }, { internalType: "uint256"; name: "id"; type: "uint256"; }, { internalType: "bytes"; name: ""; type: "bytes"; }]; name: "onERC721Received"; outputs: readonly [{ internalType: "bytes4"; name: ""; type: "bytes4"; }]; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "owner"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "positionManager"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "renounceOwnership"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }, { internalType: "address"; name: "newTeamRecipient"; type: "address"; }]; name: "setOverrideTeamRewardRecipientForToken"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; name: "teamOverrideRewardRecipientForToken"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "teamRecipient"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; name: "tokenRewards"; outputs: readonly [{ internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { internalType: "uint256"; name: "creatorReward"; type: "uint256"; }, { components: readonly [{ internalType: "address"; name: "admin"; type: "address"; }, { internalType: "address"; name: "recipient"; type: "address"; }]; internalType: "struct ILpLockerv2.RewardRecipient"; name: "creator"; type: "tuple"; }, { components: readonly [{ internalType: "address"; name: "admin"; type: "address"; }, { internalType: "address"; name: "recipient"; type: "address"; }]; internalType: "struct ILpLockerv2.RewardRecipient"; name: "interfacer"; type: "tuple"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "newOwner"; type: "address"; }]; name: "transferOwnership"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }, { internalType: "address"; name: "newAdmin"; type: "address"; }]; name: "updateCreatorRewardAdmin"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }, { internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "updateCreatorRewardRecipient"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }, { internalType: "address"; name: "newAdmin"; type: "address"; }]; name: "updateInterfaceRewardAdmin"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }, { internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "updateInterfaceRewardRecipient"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "updateTeamRecipient"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "version"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "token"; type: "address"; }, { internalType: "address"; name: "recipient"; type: "address"; }]; name: "withdrawERC20"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "recipient"; type: "address"; }]; name: "withdrawETH"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }]; address: `0x${string}`; args: readonly [bigint, `0x${string}`]; functionName: "updateCreatorRewardAdmin"; }>

Abi transaction

getUpdateCreatorRewardRecipientTransaction()

Defined in: src/v3/index.ts:118

Get an abi-typed transaction for updating the creator reward recipient.

Parameters

Parameter
Type
Description

tokenId

bigint

The token ID to update the creator reward recipient for

newRecipient

`0x${string}`

The new recipient address

Returns

Promise<{ abi: readonly [{ inputs: readonly [{ internalType: "address"; name: "owner_"; type: "address"; }, { internalType: "address"; name: "tokenFactory_"; type: "address"; }, { internalType: "address"; name: "positionManager_"; type: "address"; }, { internalType: "address"; name: "teamRecipient_"; type: "address"; }]; stateMutability: "nonpayable"; type: "constructor"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }]; name: "AlreadyKnownTokenId"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "creatorReward"; type: "uint256"; }]; name: "InvalidCreatorReward"; type: "error"; }, { inputs: readonly []; name: "InvalidMaxCreatorReward"; type: "error"; }, { inputs: readonly []; name: "InvalidTeamRecipient"; type: "error"; }, { inputs: readonly []; name: "MaxCreatorRewardNotSet"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "user"; type: "address"; }]; name: "NotAllowed"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "owner"; type: "address"; }]; name: "OwnableInvalidOwner"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "OwnableUnauthorizedAccount"; type: "error"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "creatorRecipient"; type: "address"; }, { indexed: true; internalType: "address"; name: "interfaceRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "teamRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "token0"; type: "address"; }, { indexed: false; internalType: "address"; name: "token1"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "creatorReward0"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "creatorReward1"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "interfaceReward0"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "interfaceReward1"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "teamReward0"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "teamReward1"; type: "uint256"; }]; name: "ClaimedRewards"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "oldAdmin"; type: "address"; }, { indexed: false; internalType: "address"; name: "newAdmin"; type: "address"; }]; name: "CreatorRewardRecipientAdminUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "oldRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "CreatorRewardRecipientUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "oldAdmin"; type: "address"; }, { indexed: false; internalType: "address"; name: "newAdmin"; type: "address"; }]; name: "InterfaceRewardRecipientAdminUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "oldRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "InterfaceRewardRecipientUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "previousOwner"; type: "address"; }, { indexed: true; internalType: "address"; name: "newOwner"; type: "address"; }]; name: "OwnershipTransferred"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "from"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "tokenId"; type: "uint256"; }]; name: "Received"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "oldRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "TeamOverrideRewardRecipientUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "oldRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "TeamRecipientUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: false; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "creatorReward"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "creator"; type: "address"; }, { indexed: true; internalType: "address"; name: "interfacer"; type: "address"; }]; name: "TokenRewardAdded"; type: "event"; }, { inputs: readonly []; name: "MAX_CREATOR_REWARD"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "TEAM_REWARD"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ components: readonly [{ internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { internalType: "uint256"; name: "creatorReward"; type: "uint256"; }, { components: readonly [{ internalType: "address"; name: "admin"; type: "address"; }, { internalType: "address"; name: "recipient"; type: "address"; }]; internalType: "struct ILpLockerv2.RewardRecipient"; name: "creator"; type: "tuple"; }, { components: readonly [{ internalType: "address"; name: "admin"; type: "address"; }, { internalType: "address"; name: "recipient"; type: "address"; }]; internalType: "struct ILpLockerv2.RewardRecipient"; name: "interfacer"; type: "tuple"; }]; internalType: "struct ILpLockerv2.TokenRewardInfo"; name: "tokenRewardInfo"; type: "tuple"; }]; name: "addTokenReward"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }]; name: "collectRewards"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: ""; type: "address"; }, { internalType: "uint256"; name: ""; type: "uint256"; }]; name: "creatorTokenIds"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "factory"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "user"; type: "address"; }]; name: "getLpTokenIdsForCreator"; outputs: readonly [{ internalType: "uint256[]"; name: ""; type: "uint256[]"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: ""; type: "address"; }, { internalType: "address"; name: "from"; type: "address"; }, { internalType: "uint256"; name: "id"; type: "uint256"; }, { internalType: "bytes"; name: ""; type: "bytes"; }]; name: "onERC721Received"; outputs: readonly [{ internalType: "bytes4"; name: ""; type: "bytes4"; }]; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "owner"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "positionManager"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "renounceOwnership"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }, { internalType: "address"; name: "newTeamRecipient"; type: "address"; }]; name: "setOverrideTeamRewardRecipientForToken"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; name: "teamOverrideRewardRecipientForToken"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "teamRecipient"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; name: "tokenRewards"; outputs: readonly [{ internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { internalType: "uint256"; name: "creatorReward"; type: "uint256"; }, { components: readonly [{ internalType: "address"; name: "admin"; type: "address"; }, { internalType: "address"; name: "recipient"; type: "address"; }]; internalType: "struct ILpLockerv2.RewardRecipient"; name: "creator"; type: "tuple"; }, { components: readonly [{ internalType: "address"; name: "admin"; type: "address"; }, { internalType: "address"; name: "recipient"; type: "address"; }]; internalType: "struct ILpLockerv2.RewardRecipient"; name: "interfacer"; type: "tuple"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "newOwner"; type: "address"; }]; name: "transferOwnership"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }, { internalType: "address"; name: "newAdmin"; type: "address"; }]; name: "updateCreatorRewardAdmin"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }, { internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "updateCreatorRewardRecipient"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }, { internalType: "address"; name: "newAdmin"; type: "address"; }]; name: "updateInterfaceRewardAdmin"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }, { internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "updateInterfaceRewardRecipient"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "updateTeamRecipient"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "version"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "token"; type: "address"; }, { internalType: "address"; name: "recipient"; type: "address"; }]; name: "withdrawERC20"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "recipient"; type: "address"; }]; name: "withdrawETH"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }]; address: `0x${string}`; args: readonly [bigint, `0x${string}`]; functionName: "updateCreatorRewardRecipient"; }>

Abi transaction

getUpdateImageTransaction()

Defined in: src/v3/index.ts:283

Get an abi-typed transaction for updating the token image.

Parameters

Parameter
Type
Description

token

{ newImage: string; token: `0x${string}`; }

The token to update the image for

token.newImage

string

-

token.token

`0x${string}`

-

Returns

Promise<ClankerTransactionConfig<readonly [{ inputs: readonly [{ internalType: "string"; name: "name_"; type: "string"; }, { internalType: "string"; name: "symbol_"; type: "string"; }, { internalType: "uint256"; name: "maxSupply_"; type: "uint256"; }, { internalType: "address"; name: "admin_"; type: "address"; }, { internalType: "string"; name: "image_"; type: "string"; }, { internalType: "string"; name: "metadata_"; type: "string"; }, { internalType: "string"; name: "context_"; type: "string"; }, { internalType: "uint256"; name: "initialSupplyChainId_"; type: "uint256"; }]; stateMutability: "nonpayable"; type: "constructor"; }, { inputs: readonly []; name: "CLOCK_MODE"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "DOMAIN_SEPARATOR"; outputs: readonly [{ internalType: "bytes32"; name: ""; type: "bytes32"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "admin"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "owner"; type: "address"; }, { internalType: "address"; name: "spender"; type: "address"; }]; name: "allowance"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "spender"; type: "address"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "approve"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "balanceOf"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "burn"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "burnFrom"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }, { internalType: "uint32"; name: "pos"; type: "uint32"; }]; name: "checkpoints"; outputs: readonly [{ components: readonly [{ internalType: "uint48"; name: "_key"; type: "uint48"; }, { internalType: "uint208"; name: "_value"; type: "uint208"; }]; internalType: "struct Checkpoints.Checkpoint208"; name: ""; type: "tuple"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "clock"; outputs: readonly [{ internalType: "uint48"; name: ""; type: "uint48"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "context"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "_from"; type: "address"; }, { internalType: "uint256"; name: "_amount"; type: "uint256"; }]; name: "crosschainBurn"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "_to"; type: "address"; }, { internalType: "uint256"; name: "_amount"; type: "uint256"; }]; name: "crosschainMint"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "decimals"; outputs: readonly [{ internalType: "uint8"; name: ""; type: "uint8"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "delegatee"; type: "address"; }]; name: "delegate"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "delegatee"; type: "address"; }, { internalType: "uint256"; name: "nonce"; type: "uint256"; }, { internalType: "uint256"; name: "expiry"; type: "uint256"; }, { internalType: "uint8"; name: "v"; type: "uint8"; }, { internalType: "bytes32"; name: "r"; type: "bytes32"; }, { internalType: "bytes32"; name: "s"; type: "bytes32"; }]; name: "delegateBySig"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "delegates"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "eip712Domain"; outputs: readonly [{ internalType: "bytes1"; name: "fields"; type: "bytes1"; }, { internalType: "string"; name: "name"; type: "string"; }, { internalType: "string"; name: "version"; type: "string"; }, { internalType: "uint256"; name: "chainId"; type: "uint256"; }, { internalType: "address"; name: "verifyingContract"; type: "address"; }, { internalType: "bytes32"; name: "salt"; type: "bytes32"; }, { internalType: "uint256[]"; name: "extensions"; type: "uint256[]"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "timepoint"; type: "uint256"; }]; name: "getPastTotalSupply"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }, { internalType: "uint256"; name: "timepoint"; type: "uint256"; }]; name: "getPastVotes"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "getVotes"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "imageUrl"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "isVerified"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "metadata"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "name"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "owner"; type: "address"; }]; name: "nonces"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "numCheckpoints"; outputs: readonly [{ internalType: "uint32"; name: ""; type: "uint32"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "owner"; type: "address"; }, { internalType: "address"; name: "spender"; type: "address"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }, { internalType: "uint256"; name: "deadline"; type: "uint256"; }, { internalType: "uint8"; name: "v"; type: "uint8"; }, { internalType: "bytes32"; name: "r"; type: "bytes32"; }, { internalType: "bytes32"; name: "s"; type: "bytes32"; }]; name: "permit"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "bytes4"; name: "_interfaceId"; type: "bytes4"; }]; name: "supportsInterface"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "pure"; type: "function"; }, { inputs: readonly []; name: "symbol"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "totalSupply"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "to"; type: "address"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "transfer"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "from"; type: "address"; }, { internalType: "address"; name: "to"; type: "address"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "transferFrom"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "string"; name: "image_"; type: "string"; }]; name: "updateImage"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "string"; name: "metadata_"; type: "string"; }]; name: "updateMetadata"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "verify"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "owner"; type: "address"; }, { indexed: true; internalType: "address"; name: "spender"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "Approval"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "from"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "amount"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "sender"; type: "address"; }]; name: "CrosschainBurn"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "to"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "amount"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "sender"; type: "address"; }]; name: "CrosschainMint"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "delegator"; type: "address"; }, { indexed: true; internalType: "address"; name: "fromDelegate"; type: "address"; }, { indexed: true; internalType: "address"; name: "toDelegate"; type: "address"; }]; name: "DelegateChanged"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "delegate"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "previousVotes"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "newVotes"; type: "uint256"; }]; name: "DelegateVotesChanged"; type: "event"; }, { anonymous: false; inputs: readonly []; name: "EIP712DomainChanged"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "from"; type: "address"; }, { indexed: true; internalType: "address"; name: "to"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "Transfer"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "admin"; type: "address"; }, { indexed: true; internalType: "address"; name: "token"; type: "address"; }]; name: "Verified"; type: "event"; }, { inputs: readonly []; name: "AlreadyVerified"; type: "error"; }, { inputs: readonly []; name: "CheckpointUnorderedInsertion"; type: "error"; }, { inputs: readonly []; name: "ECDSAInvalidSignature"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "length"; type: "uint256"; }]; name: "ECDSAInvalidSignatureLength"; type: "error"; }, { inputs: readonly [{ internalType: "bytes32"; name: "s"; type: "bytes32"; }]; name: "ECDSAInvalidSignatureS"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "increasedSupply"; type: "uint256"; }, { internalType: "uint256"; name: "cap"; type: "uint256"; }]; name: "ERC20ExceededSafeSupply"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "spender"; type: "address"; }, { internalType: "uint256"; name: "allowance"; type: "uint256"; }, { internalType: "uint256"; name: "needed"; type: "uint256"; }]; name: "ERC20InsufficientAllowance"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "sender"; type: "address"; }, { internalType: "uint256"; name: "balance"; type: "uint256"; }, { internalType: "uint256"; name: "needed"; type: "uint256"; }]; name: "ERC20InsufficientBalance"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "approver"; type: "address"; }]; name: "ERC20InvalidApprover"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "receiver"; type: "address"; }]; name: "ERC20InvalidReceiver"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "sender"; type: "address"; }]; name: "ERC20InvalidSender"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "spender"; type: "address"; }]; name: "ERC20InvalidSpender"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "deadline"; type: "uint256"; }]; name: "ERC2612ExpiredSignature"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "signer"; type: "address"; }, { internalType: "address"; name: "owner"; type: "address"; }]; name: "ERC2612InvalidSigner"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "timepoint"; type: "uint256"; }, { internalType: "uint48"; name: "clock"; type: "uint48"; }]; name: "ERC5805FutureLookup"; type: "error"; }, { inputs: readonly []; name: "ERC6372InconsistentClock"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }, { internalType: "uint256"; name: "currentNonce"; type: "uint256"; }]; name: "InvalidAccountNonce"; type: "error"; }, { inputs: readonly []; name: "InvalidShortString"; type: "error"; }, { inputs: readonly []; name: "NotAdmin"; type: "error"; }, { inputs: readonly [{ internalType: "uint8"; name: "bits"; type: "uint8"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "SafeCastOverflowedUintDowncast"; type: "error"; }, { inputs: readonly [{ internalType: "string"; name: "str"; type: "string"; }]; name: "StringTooLong"; type: "error"; }, { inputs: readonly []; name: "Unauthorized"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "expiry"; type: "uint256"; }]; name: "VotesExpiredSignature"; type: "error"; }]>>

Abi transaction

getUpdateMetadataTransaction()

Defined in: src/v3/index.ts:305

Get an abi-typed transaction for updating the token metadata.

Parameters

Parameter
Type
Description

token

{ metadata: string; token: `0x${string}`; }

The token to update the metadata for

token.metadata

string

-

token.token

`0x${string}`

-

Returns

Promise<ClankerTransactionConfig<readonly [{ inputs: readonly [{ internalType: "string"; name: "name_"; type: "string"; }, { internalType: "string"; name: "symbol_"; type: "string"; }, { internalType: "uint256"; name: "maxSupply_"; type: "uint256"; }, { internalType: "address"; name: "admin_"; type: "address"; }, { internalType: "string"; name: "image_"; type: "string"; }, { internalType: "string"; name: "metadata_"; type: "string"; }, { internalType: "string"; name: "context_"; type: "string"; }, { internalType: "uint256"; name: "initialSupplyChainId_"; type: "uint256"; }]; stateMutability: "nonpayable"; type: "constructor"; }, { inputs: readonly []; name: "CLOCK_MODE"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "DOMAIN_SEPARATOR"; outputs: readonly [{ internalType: "bytes32"; name: ""; type: "bytes32"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "admin"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "owner"; type: "address"; }, { internalType: "address"; name: "spender"; type: "address"; }]; name: "allowance"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "spender"; type: "address"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "approve"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "balanceOf"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "burn"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "burnFrom"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }, { internalType: "uint32"; name: "pos"; type: "uint32"; }]; name: "checkpoints"; outputs: readonly [{ components: readonly [{ internalType: "uint48"; name: "_key"; type: "uint48"; }, { internalType: "uint208"; name: "_value"; type: "uint208"; }]; internalType: "struct Checkpoints.Checkpoint208"; name: ""; type: "tuple"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "clock"; outputs: readonly [{ internalType: "uint48"; name: ""; type: "uint48"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "context"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "_from"; type: "address"; }, { internalType: "uint256"; name: "_amount"; type: "uint256"; }]; name: "crosschainBurn"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "_to"; type: "address"; }, { internalType: "uint256"; name: "_amount"; type: "uint256"; }]; name: "crosschainMint"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "decimals"; outputs: readonly [{ internalType: "uint8"; name: ""; type: "uint8"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "delegatee"; type: "address"; }]; name: "delegate"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "delegatee"; type: "address"; }, { internalType: "uint256"; name: "nonce"; type: "uint256"; }, { internalType: "uint256"; name: "expiry"; type: "uint256"; }, { internalType: "uint8"; name: "v"; type: "uint8"; }, { internalType: "bytes32"; name: "r"; type: "bytes32"; }, { internalType: "bytes32"; name: "s"; type: "bytes32"; }]; name: "delegateBySig"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "delegates"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "eip712Domain"; outputs: readonly [{ internalType: "bytes1"; name: "fields"; type: "bytes1"; }, { internalType: "string"; name: "name"; type: "string"; }, { internalType: "string"; name: "version"; type: "string"; }, { internalType: "uint256"; name: "chainId"; type: "uint256"; }, { internalType: "address"; name: "verifyingContract"; type: "address"; }, { internalType: "bytes32"; name: "salt"; type: "bytes32"; }, { internalType: "uint256[]"; name: "extensions"; type: "uint256[]"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "timepoint"; type: "uint256"; }]; name: "getPastTotalSupply"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }, { internalType: "uint256"; name: "timepoint"; type: "uint256"; }]; name: "getPastVotes"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "getVotes"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "imageUrl"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "isVerified"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "metadata"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "name"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "owner"; type: "address"; }]; name: "nonces"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "numCheckpoints"; outputs: readonly [{ internalType: "uint32"; name: ""; type: "uint32"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "owner"; type: "address"; }, { internalType: "address"; name: "spender"; type: "address"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }, { internalType: "uint256"; name: "deadline"; type: "uint256"; }, { internalType: "uint8"; name: "v"; type: "uint8"; }, { internalType: "bytes32"; name: "r"; type: "bytes32"; }, { internalType: "bytes32"; name: "s"; type: "bytes32"; }]; name: "permit"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "bytes4"; name: "_interfaceId"; type: "bytes4"; }]; name: "supportsInterface"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "pure"; type: "function"; }, { inputs: readonly []; name: "symbol"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "totalSupply"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "to"; type: "address"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "transfer"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "from"; type: "address"; }, { internalType: "address"; name: "to"; type: "address"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "transferFrom"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "string"; name: "image_"; type: "string"; }]; name: "updateImage"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "string"; name: "metadata_"; type: "string"; }]; name: "updateMetadata"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "verify"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "owner"; type: "address"; }, { indexed: true; internalType: "address"; name: "spender"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "Approval"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "from"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "amount"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "sender"; type: "address"; }]; name: "CrosschainBurn"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "to"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "amount"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "sender"; type: "address"; }]; name: "CrosschainMint"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "delegator"; type: "address"; }, { indexed: true; internalType: "address"; name: "fromDelegate"; type: "address"; }, { indexed: true; internalType: "address"; name: "toDelegate"; type: "address"; }]; name: "DelegateChanged"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "delegate"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "previousVotes"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "newVotes"; type: "uint256"; }]; name: "DelegateVotesChanged"; type: "event"; }, { anonymous: false; inputs: readonly []; name: "EIP712DomainChanged"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "from"; type: "address"; }, { indexed: true; internalType: "address"; name: "to"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "Transfer"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "admin"; type: "address"; }, { indexed: true; internalType: "address"; name: "token"; type: "address"; }]; name: "Verified"; type: "event"; }, { inputs: readonly []; name: "AlreadyVerified"; type: "error"; }, { inputs: readonly []; name: "CheckpointUnorderedInsertion"; type: "error"; }, { inputs: readonly []; name: "ECDSAInvalidSignature"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "length"; type: "uint256"; }]; name: "ECDSAInvalidSignatureLength"; type: "error"; }, { inputs: readonly [{ internalType: "bytes32"; name: "s"; type: "bytes32"; }]; name: "ECDSAInvalidSignatureS"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "increasedSupply"; type: "uint256"; }, { internalType: "uint256"; name: "cap"; type: "uint256"; }]; name: "ERC20ExceededSafeSupply"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "spender"; type: "address"; }, { internalType: "uint256"; name: "allowance"; type: "uint256"; }, { internalType: "uint256"; name: "needed"; type: "uint256"; }]; name: "ERC20InsufficientAllowance"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "sender"; type: "address"; }, { internalType: "uint256"; name: "balance"; type: "uint256"; }, { internalType: "uint256"; name: "needed"; type: "uint256"; }]; name: "ERC20InsufficientBalance"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "approver"; type: "address"; }]; name: "ERC20InvalidApprover"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "receiver"; type: "address"; }]; name: "ERC20InvalidReceiver"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "sender"; type: "address"; }]; name: "ERC20InvalidSender"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "spender"; type: "address"; }]; name: "ERC20InvalidSpender"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "deadline"; type: "uint256"; }]; name: "ERC2612ExpiredSignature"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "signer"; type: "address"; }, { internalType: "address"; name: "owner"; type: "address"; }]; name: "ERC2612InvalidSigner"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "timepoint"; type: "uint256"; }, { internalType: "uint48"; name: "clock"; type: "uint48"; }]; name: "ERC5805FutureLookup"; type: "error"; }, { inputs: readonly []; name: "ERC6372InconsistentClock"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }, { internalType: "uint256"; name: "currentNonce"; type: "uint256"; }]; name: "InvalidAccountNonce"; type: "error"; }, { inputs: readonly []; name: "InvalidShortString"; type: "error"; }, { inputs: readonly []; name: "NotAdmin"; type: "error"; }, { inputs: readonly [{ internalType: "uint8"; name: "bits"; type: "uint8"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "SafeCastOverflowedUintDowncast"; type: "error"; }, { inputs: readonly [{ internalType: "string"; name: "str"; type: "string"; }]; name: "StringTooLong"; type: "error"; }, { inputs: readonly []; name: "Unauthorized"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "expiry"; type: "uint256"; }]; name: "VotesExpiredSignature"; type: "error"; }]>>

Abi transaction

updateCreatorRewardAdmin()

Defined in: src/v3/index.ts:219

Update the creator reward admin for a token.

Parameters

Parameter
Type
Description

tokenId

bigint

The token ID to update the creator reward admin for

newAdmin

`0x${string}`

The new admin address

Returns

Promise< | { error: undefined; txHash: `0x${string}`; } | { error: ClankerError; txHash: undefined; }>

Transaction hash of the update or error

updateCreatorRewardAdminSimulate()

Defined in: src/v3/index.ts:198

Simulate updating the creator reward admin. Will use the wallet account on the Clanker class or the passed-in account.

Parameters

Parameter
Type
Description

tokenId

bigint

The token ID to update the creator reward admin for

newAdmin

`0x${string}`

The new admin address

account?

Account

Optional account to simulate calling for

Returns

Promise< | SimulateContractReturnType<readonly [{ inputs: readonly [{ internalType: "address"; name: "owner_"; type: "address"; }, { internalType: "address"; name: "tokenFactory_"; type: "address"; }, { internalType: "address"; name: "positionManager_"; type: "address"; }, { internalType: "address"; name: "teamRecipient_"; type: "address"; }]; stateMutability: "nonpayable"; type: "constructor"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }]; name: "AlreadyKnownTokenId"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "creatorReward"; type: "uint256"; }]; name: "InvalidCreatorReward"; type: "error"; }, { inputs: readonly []; name: "InvalidMaxCreatorReward"; type: "error"; }, { inputs: readonly []; name: "InvalidTeamRecipient"; type: "error"; }, { inputs: readonly []; name: "MaxCreatorRewardNotSet"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "user"; type: "address"; }]; name: "NotAllowed"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "owner"; type: "address"; }]; name: "OwnableInvalidOwner"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "OwnableUnauthorizedAccount"; type: "error"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "creatorRecipient"; type: "address"; }, { indexed: true; internalType: "address"; name: "interfaceRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "teamRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "token0"; type: "address"; }, { indexed: false; internalType: "address"; name: "token1"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "creatorReward0"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "creatorReward1"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "interfaceReward0"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "interfaceReward1"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "teamReward0"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "teamReward1"; type: "uint256"; }]; name: "ClaimedRewards"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "oldAdmin"; type: "address"; }, { indexed: false; internalType: "address"; name: "newAdmin"; type: "address"; }]; name: "CreatorRewardRecipientAdminUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "oldRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "CreatorRewardRecipientUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "oldAdmin"; type: "address"; }, { indexed: false; internalType: "address"; name: "newAdmin"; type: "address"; }]; name: "InterfaceRewardRecipientAdminUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "oldRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "InterfaceRewardRecipientUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "previousOwner"; type: "address"; }, { indexed: true; internalType: "address"; name: "newOwner"; type: "address"; }]; name: "OwnershipTransferred"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "from"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "tokenId"; type: "uint256"; }]; name: "Received"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "oldRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "TeamOverrideRewardRecipientUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "oldRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "TeamRecipientUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: false; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "creatorReward"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "creator"; type: "address"; }, { indexed: true; internalType: "address"; name: "interfacer"; type: "address"; }]; name: "TokenRewardAdded"; type: "event"; }, { inputs: readonly []; name: "MAX_CREATOR_REWARD"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "TEAM_REWARD"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ components: readonly [{ internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { internalType: "uint256"; name: "creatorReward"; type: "uint256"; }, { components: readonly [..., ...]; internalType: "struct ILpLockerv2.RewardRecipient"; name: "creator"; type: "tuple"; }, { components: readonly [..., ...]; internalType: "struct ILpLockerv2.RewardRecipient"; name: "interfacer"; type: "tuple"; }]; internalType: "struct ILpLockerv2.TokenRewardInfo"; name: "tokenRewardInfo"; type: "tuple"; }]; name: "addTokenReward"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }]; name: "collectRewards"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: ""; type: "address"; }, { internalType: "uint256"; name: ""; type: "uint256"; }]; name: "creatorTokenIds"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "factory"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "user"; type: "address"; }]; name: "getLpTokenIdsForCreator"; outputs: readonly [{ internalType: "uint256[]"; name: ""; type: "uint256[]"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: ""; type: "address"; }, { internalType: "address"; name: "from"; type: "address"; }, { internalType: "uint256"; name: "id"; type: "uint256"; }, { internalType: "bytes"; name: ""; type: "bytes"; }]; name: "onERC721Received"; outputs: readonly [{ internalType: "bytes4"; name: ""; type: "bytes4"; }]; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "owner"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "positionManager"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "renounceOwnership"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }, { internalType: "address"; name: "newTeamRecipient"; type: "address"; }]; name: "setOverrideTeamRewardRecipientForToken"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; name: "teamOverrideRewardRecipientForToken"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "teamRecipient"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; name: "tokenRewards"; outputs: readonly [{ internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { internalType: "uint256"; name: "creatorReward"; type: "uint256"; }, { components: readonly [{ internalType: "address"; name: "admin"; type: "address"; }, { internalType: "address"; name: "recipient"; type: "address"; }]; internalType: "struct ILpLockerv2.RewardRecipient"; name: "creator"; type: "tuple"; }, { components: readonly [{ internalType: "address"; name: "admin"; type: "address"; }, { internalType: "address"; name: "recipient"; type: "address"; }]; internalType: "struct ILpLockerv2.RewardRecipient"; name: "interfacer"; type: "tuple"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "newOwner"; type: "address"; }]; name: "transferOwnership"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }, { internalType: "address"; name: "newAdmin"; type: "address"; }]; name: "updateCreatorRewardAdmin"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }, { internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "updateCreatorRewardRecipient"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }, { internalType: "address"; name: "newAdmin"; type: "address"; }]; name: "updateInterfaceRewardAdmin"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }, { internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "updateInterfaceRewardRecipient"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "updateTeamRecipient"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "version"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "token"; type: "address"; }, { internalType: "address"; name: "recipient"; type: "address"; }]; name: "withdrawERC20"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "recipient"; type: "address"; }]; name: "withdrawETH"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }], | "renounceOwnership" | "transferOwnership" | "collectRewards" | "onERC721Received" | "withdrawERC20" | "withdrawETH" | "addTokenReward" | "setOverrideTeamRewardRecipientForToken" | "updateCreatorRewardAdmin" | "updateCreatorRewardRecipient" | "updateInterfaceRewardAdmin" | "updateInterfaceRewardRecipient" | "updateTeamRecipient"> & { error?: undefined; } | UndefinedValues<SimulateContractReturnType<readonly [{ inputs: readonly [{ internalType: "address"; name: "owner_"; type: "address"; }, { internalType: "address"; name: "tokenFactory_"; type: "address"; }, { internalType: "address"; name: "positionManager_"; type: "address"; }, { internalType: "address"; name: "teamRecipient_"; type: "address"; }]; stateMutability: "nonpayable"; type: "constructor"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }]; name: "AlreadyKnownTokenId"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "creatorReward"; type: "uint256"; }]; name: "InvalidCreatorReward"; type: "error"; }, { inputs: readonly []; name: "InvalidMaxCreatorReward"; type: "error"; }, { inputs: readonly []; name: "InvalidTeamRecipient"; type: "error"; }, { inputs: readonly []; name: "MaxCreatorRewardNotSet"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "user"; type: "address"; }]; name: "NotAllowed"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "owner"; type: "address"; }]; name: "OwnableInvalidOwner"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "OwnableUnauthorizedAccount"; type: "error"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "creatorRecipient"; type: "address"; }, { indexed: true; internalType: "address"; name: "interfaceRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "teamRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "token0"; type: "address"; }, { indexed: false; internalType: "address"; name: "token1"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "creatorReward0"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "creatorReward1"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "interfaceReward0"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "interfaceReward1"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "teamReward0"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "teamReward1"; type: "uint256"; }]; name: "ClaimedRewards"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "oldAdmin"; type: "address"; }, { indexed: false; internalType: "address"; name: "newAdmin"; type: "address"; }]; name: "CreatorRewardRecipientAdminUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "oldRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "CreatorRewardRecipientUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "oldAdmin"; type: "address"; }, { indexed: false; internalType: "address"; name: "newAdmin"; type: "address"; }]; name: "InterfaceRewardRecipientAdminUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "oldRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "InterfaceRewardRecipientUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "previousOwner"; type: "address"; }, { indexed: true; internalType: "address"; name: "newOwner"; type: "address"; }]; name: "OwnershipTransferred"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "from"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "tokenId"; type: "uint256"; }]; name: "Received"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "oldRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "TeamOverrideRewardRecipientUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "oldRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "TeamRecipientUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: false; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "creatorReward"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "creator"; type: "address"; }, { indexed: true; internalType: "address"; name: "interfacer"; type: "address"; }]; name: "TokenRewardAdded"; type: "event"; }, { inputs: readonly []; name: "MAX_CREATOR_REWARD"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "TEAM_REWARD"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ components: readonly [{ internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }, { components: ...; internalType: ...; name: ...; type: ...; }, { components: ...; internalType: ...; name: ...; type: ...; }]; internalType: "struct ILpLockerv2.TokenRewardInfo"; name: "tokenRewardInfo"; type: "tuple"; }]; name: "addTokenReward"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }]; name: "collectRewards"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: ""; type: "address"; }, { internalType: "uint256"; name: ""; type: "uint256"; }]; name: "creatorTokenIds"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "factory"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "user"; type: "address"; }]; name: "getLpTokenIdsForCreator"; outputs: readonly [{ internalType: "uint256[]"; name: ""; type: "uint256[]"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: ""; type: "address"; }, { internalType: "address"; name: "from"; type: "address"; }, { internalType: "uint256"; name: "id"; type: "uint256"; }, { internalType: "bytes"; name: ""; type: "bytes"; }]; name: "onERC721Received"; outputs: readonly [{ internalType: "bytes4"; name: ""; type: "bytes4"; }]; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "owner"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "positionManager"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "renounceOwnership"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }, { internalType: "address"; name: "newTeamRecipient"; type: "address"; }]; name: "setOverrideTeamRewardRecipientForToken"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; name: "teamOverrideRewardRecipientForToken"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "teamRecipient"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; name: "tokenRewards"; outputs: readonly [{ internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { internalType: "uint256"; name: "creatorReward"; type: "uint256"; }, { components: readonly [{ internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }]; internalType: "struct ILpLockerv2.RewardRecipient"; name: "creator"; type: "tuple"; }, { components: readonly [{ internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }]; internalType: "struct ILpLockerv2.RewardRecipient"; name: "interfacer"; type: "tuple"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "newOwner"; type: "address"; }]; name: "transferOwnership"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }, { internalType: "address"; name: "newAdmin"; type: "address"; }]; name: "updateCreatorRewardAdmin"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }, { internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "updateCreatorRewardRecipient"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }, { internalType: "address"; name: "newAdmin"; type: "address"; }]; name: "updateInterfaceRewardAdmin"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }, { internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "updateInterfaceRewardRecipient"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "updateTeamRecipient"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "version"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "token"; type: "address"; }, { internalType: "address"; name: "recipient"; type: "address"; }]; name: "withdrawERC20"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "recipient"; type: "address"; }]; name: "withdrawETH"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }], | "renounceOwnership" | "transferOwnership" | "collectRewards" | "onERC721Received" | "withdrawERC20" | "withdrawETH" | "addTokenReward" | "setOverrideTeamRewardRecipientForToken" | "updateCreatorRewardAdmin" | "updateCreatorRewardRecipient" | "updateInterfaceRewardAdmin" | "updateInterfaceRewardRecipient" | "updateTeamRecipient">> & { error: ClankerError; }>

The simulated output

updateCreatorRewardRecipient()

Defined in: src/v3/index.ts:158

Update the creator reward recipient for a token.

Parameters

Parameter
Type
Description

tokenId

bigint

The token ID to update the creator reward recipient for

newRecipient

`0x${string}`

The new recipient address

Returns

Promise< | { error: undefined; txHash: `0x${string}`; } | { error: ClankerError; txHash: undefined; }>

Transaction hash of the update or error

updateCreatorRewardRecipientSimulate()

Defined in: src/v3/index.ts:137

Simulate updating the creator reward recipient. Will use the wallet account on the Clanker class or the passed-in account.

Parameters

Parameter
Type
Description

tokenId

bigint

The token ID to update the creator reward recipient for

newRecipient

`0x${string}`

The new recipient address

account?

Account

Optional account to simulate calling for

Returns

Promise< | SimulateContractReturnType<readonly [{ inputs: readonly [{ internalType: "address"; name: "owner_"; type: "address"; }, { internalType: "address"; name: "tokenFactory_"; type: "address"; }, { internalType: "address"; name: "positionManager_"; type: "address"; }, { internalType: "address"; name: "teamRecipient_"; type: "address"; }]; stateMutability: "nonpayable"; type: "constructor"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }]; name: "AlreadyKnownTokenId"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "creatorReward"; type: "uint256"; }]; name: "InvalidCreatorReward"; type: "error"; }, { inputs: readonly []; name: "InvalidMaxCreatorReward"; type: "error"; }, { inputs: readonly []; name: "InvalidTeamRecipient"; type: "error"; }, { inputs: readonly []; name: "MaxCreatorRewardNotSet"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "user"; type: "address"; }]; name: "NotAllowed"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "owner"; type: "address"; }]; name: "OwnableInvalidOwner"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "OwnableUnauthorizedAccount"; type: "error"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "creatorRecipient"; type: "address"; }, { indexed: true; internalType: "address"; name: "interfaceRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "teamRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "token0"; type: "address"; }, { indexed: false; internalType: "address"; name: "token1"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "creatorReward0"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "creatorReward1"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "interfaceReward0"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "interfaceReward1"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "teamReward0"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "teamReward1"; type: "uint256"; }]; name: "ClaimedRewards"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "oldAdmin"; type: "address"; }, { indexed: false; internalType: "address"; name: "newAdmin"; type: "address"; }]; name: "CreatorRewardRecipientAdminUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "oldRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "CreatorRewardRecipientUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "oldAdmin"; type: "address"; }, { indexed: false; internalType: "address"; name: "newAdmin"; type: "address"; }]; name: "InterfaceRewardRecipientAdminUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "oldRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "InterfaceRewardRecipientUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "previousOwner"; type: "address"; }, { indexed: true; internalType: "address"; name: "newOwner"; type: "address"; }]; name: "OwnershipTransferred"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "from"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "tokenId"; type: "uint256"; }]; name: "Received"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "oldRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "TeamOverrideRewardRecipientUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "oldRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "TeamRecipientUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: false; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "creatorReward"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "creator"; type: "address"; }, { indexed: true; internalType: "address"; name: "interfacer"; type: "address"; }]; name: "TokenRewardAdded"; type: "event"; }, { inputs: readonly []; name: "MAX_CREATOR_REWARD"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "TEAM_REWARD"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ components: readonly [{ internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { internalType: "uint256"; name: "creatorReward"; type: "uint256"; }, { components: readonly [..., ...]; internalType: "struct ILpLockerv2.RewardRecipient"; name: "creator"; type: "tuple"; }, { components: readonly [..., ...]; internalType: "struct ILpLockerv2.RewardRecipient"; name: "interfacer"; type: "tuple"; }]; internalType: "struct ILpLockerv2.TokenRewardInfo"; name: "tokenRewardInfo"; type: "tuple"; }]; name: "addTokenReward"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }]; name: "collectRewards"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: ""; type: "address"; }, { internalType: "uint256"; name: ""; type: "uint256"; }]; name: "creatorTokenIds"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "factory"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "user"; type: "address"; }]; name: "getLpTokenIdsForCreator"; outputs: readonly [{ internalType: "uint256[]"; name: ""; type: "uint256[]"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: ""; type: "address"; }, { internalType: "address"; name: "from"; type: "address"; }, { internalType: "uint256"; name: "id"; type: "uint256"; }, { internalType: "bytes"; name: ""; type: "bytes"; }]; name: "onERC721Received"; outputs: readonly [{ internalType: "bytes4"; name: ""; type: "bytes4"; }]; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "owner"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "positionManager"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "renounceOwnership"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }, { internalType: "address"; name: "newTeamRecipient"; type: "address"; }]; name: "setOverrideTeamRewardRecipientForToken"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; name: "teamOverrideRewardRecipientForToken"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "teamRecipient"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; name: "tokenRewards"; outputs: readonly [{ internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { internalType: "uint256"; name: "creatorReward"; type: "uint256"; }, { components: readonly [{ internalType: "address"; name: "admin"; type: "address"; }, { internalType: "address"; name: "recipient"; type: "address"; }]; internalType: "struct ILpLockerv2.RewardRecipient"; name: "creator"; type: "tuple"; }, { components: readonly [{ internalType: "address"; name: "admin"; type: "address"; }, { internalType: "address"; name: "recipient"; type: "address"; }]; internalType: "struct ILpLockerv2.RewardRecipient"; name: "interfacer"; type: "tuple"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "newOwner"; type: "address"; }]; name: "transferOwnership"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }, { internalType: "address"; name: "newAdmin"; type: "address"; }]; name: "updateCreatorRewardAdmin"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }, { internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "updateCreatorRewardRecipient"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }, { internalType: "address"; name: "newAdmin"; type: "address"; }]; name: "updateInterfaceRewardAdmin"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }, { internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "updateInterfaceRewardRecipient"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "updateTeamRecipient"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "version"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "token"; type: "address"; }, { internalType: "address"; name: "recipient"; type: "address"; }]; name: "withdrawERC20"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "recipient"; type: "address"; }]; name: "withdrawETH"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }], | "renounceOwnership" | "transferOwnership" | "collectRewards" | "onERC721Received" | "withdrawERC20" | "withdrawETH" | "addTokenReward" | "setOverrideTeamRewardRecipientForToken" | "updateCreatorRewardAdmin" | "updateCreatorRewardRecipient" | "updateInterfaceRewardAdmin" | "updateInterfaceRewardRecipient" | "updateTeamRecipient"> & { error?: undefined; } | UndefinedValues<SimulateContractReturnType<readonly [{ inputs: readonly [{ internalType: "address"; name: "owner_"; type: "address"; }, { internalType: "address"; name: "tokenFactory_"; type: "address"; }, { internalType: "address"; name: "positionManager_"; type: "address"; }, { internalType: "address"; name: "teamRecipient_"; type: "address"; }]; stateMutability: "nonpayable"; type: "constructor"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }]; name: "AlreadyKnownTokenId"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "creatorReward"; type: "uint256"; }]; name: "InvalidCreatorReward"; type: "error"; }, { inputs: readonly []; name: "InvalidMaxCreatorReward"; type: "error"; }, { inputs: readonly []; name: "InvalidTeamRecipient"; type: "error"; }, { inputs: readonly []; name: "MaxCreatorRewardNotSet"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "user"; type: "address"; }]; name: "NotAllowed"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "owner"; type: "address"; }]; name: "OwnableInvalidOwner"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "OwnableUnauthorizedAccount"; type: "error"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "creatorRecipient"; type: "address"; }, { indexed: true; internalType: "address"; name: "interfaceRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "teamRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "token0"; type: "address"; }, { indexed: false; internalType: "address"; name: "token1"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "creatorReward0"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "creatorReward1"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "interfaceReward0"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "interfaceReward1"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "teamReward0"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "teamReward1"; type: "uint256"; }]; name: "ClaimedRewards"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "oldAdmin"; type: "address"; }, { indexed: false; internalType: "address"; name: "newAdmin"; type: "address"; }]; name: "CreatorRewardRecipientAdminUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "oldRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "CreatorRewardRecipientUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "oldAdmin"; type: "address"; }, { indexed: false; internalType: "address"; name: "newAdmin"; type: "address"; }]; name: "InterfaceRewardRecipientAdminUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "oldRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "InterfaceRewardRecipientUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "previousOwner"; type: "address"; }, { indexed: true; internalType: "address"; name: "newOwner"; type: "address"; }]; name: "OwnershipTransferred"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "from"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "tokenId"; type: "uint256"; }]; name: "Received"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "oldRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "TeamOverrideRewardRecipientUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "oldRecipient"; type: "address"; }, { indexed: false; internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "TeamRecipientUpdated"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: false; internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "creatorReward"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "creator"; type: "address"; }, { indexed: true; internalType: "address"; name: "interfacer"; type: "address"; }]; name: "TokenRewardAdded"; type: "event"; }, { inputs: readonly []; name: "MAX_CREATOR_REWARD"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "TEAM_REWARD"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ components: readonly [{ internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }, { components: ...; internalType: ...; name: ...; type: ...; }, { components: ...; internalType: ...; name: ...; type: ...; }]; internalType: "struct ILpLockerv2.TokenRewardInfo"; name: "tokenRewardInfo"; type: "tuple"; }]; name: "addTokenReward"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }]; name: "collectRewards"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: ""; type: "address"; }, { internalType: "uint256"; name: ""; type: "uint256"; }]; name: "creatorTokenIds"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "factory"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "user"; type: "address"; }]; name: "getLpTokenIdsForCreator"; outputs: readonly [{ internalType: "uint256[]"; name: ""; type: "uint256[]"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: ""; type: "address"; }, { internalType: "address"; name: "from"; type: "address"; }, { internalType: "uint256"; name: "id"; type: "uint256"; }, { internalType: "bytes"; name: ""; type: "bytes"; }]; name: "onERC721Received"; outputs: readonly [{ internalType: "bytes4"; name: ""; type: "bytes4"; }]; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "owner"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "positionManager"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "renounceOwnership"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }, { internalType: "address"; name: "newTeamRecipient"; type: "address"; }]; name: "setOverrideTeamRewardRecipientForToken"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; name: "teamOverrideRewardRecipientForToken"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "teamRecipient"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; name: "tokenRewards"; outputs: readonly [{ internalType: "uint256"; name: "lpTokenId"; type: "uint256"; }, { internalType: "uint256"; name: "creatorReward"; type: "uint256"; }, { components: readonly [{ internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }]; internalType: "struct ILpLockerv2.RewardRecipient"; name: "creator"; type: "tuple"; }, { components: readonly [{ internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }]; internalType: "struct ILpLockerv2.RewardRecipient"; name: "interfacer"; type: "tuple"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "newOwner"; type: "address"; }]; name: "transferOwnership"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }, { internalType: "address"; name: "newAdmin"; type: "address"; }]; name: "updateCreatorRewardAdmin"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }, { internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "updateCreatorRewardRecipient"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }, { internalType: "address"; name: "newAdmin"; type: "address"; }]; name: "updateInterfaceRewardAdmin"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "tokenId"; type: "uint256"; }, { internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "updateInterfaceRewardRecipient"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "newRecipient"; type: "address"; }]; name: "updateTeamRecipient"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "version"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "token"; type: "address"; }, { internalType: "address"; name: "recipient"; type: "address"; }]; name: "withdrawERC20"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "recipient"; type: "address"; }]; name: "withdrawETH"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }], | "renounceOwnership" | "transferOwnership" | "collectRewards" | "onERC721Received" | "withdrawERC20" | "withdrawETH" | "addTokenReward" | "setOverrideTeamRewardRecipientForToken" | "updateCreatorRewardAdmin" | "updateCreatorRewardRecipient" | "updateInterfaceRewardAdmin" | "updateInterfaceRewardRecipient" | "updateTeamRecipient">> & { error: ClankerError; }>

The simulated output

updateImage()

Defined in: src/v3/index.ts:371

Update the token image.

Parameters

Parameter
Type
Description

token

{ newImage: string; token: `0x${string}`; }

The token to update the image for

token.newImage

string

-

token.token

`0x${string}`

-

Returns

Promise< | { error: undefined; txHash: `0x${string}`; } | { error: ClankerError; txHash: undefined; }>

Transaction hash of the update or error

updateImageSimulate()

Defined in: src/v3/index.ts:329

Simulate updating the token image. Will use the wallet account on the Clanker class or the passed-in account.

Parameters

Parameter
Type
Description

token

{ newImage: string; token: `0x${string}`; }

The token to update the image for

token.newImage

string

-

token.token?

`0x${string}`

-

account?

Account

Optional account to simulate calling for

Returns

Promise< | SimulateContractReturnType<readonly [{ inputs: readonly [{ internalType: "string"; name: "name_"; type: "string"; }, { internalType: "string"; name: "symbol_"; type: "string"; }, { internalType: "uint256"; name: "maxSupply_"; type: "uint256"; }, { internalType: "address"; name: "admin_"; type: "address"; }, { internalType: "string"; name: "image_"; type: "string"; }, { internalType: "string"; name: "metadata_"; type: "string"; }, { internalType: "string"; name: "context_"; type: "string"; }, { internalType: "uint256"; name: "initialSupplyChainId_"; type: "uint256"; }]; stateMutability: "nonpayable"; type: "constructor"; }, { inputs: readonly []; name: "CLOCK_MODE"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "DOMAIN_SEPARATOR"; outputs: readonly [{ internalType: "bytes32"; name: ""; type: "bytes32"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "admin"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "owner"; type: "address"; }, { internalType: "address"; name: "spender"; type: "address"; }]; name: "allowance"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "spender"; type: "address"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "approve"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "balanceOf"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "burn"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "burnFrom"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }, { internalType: "uint32"; name: "pos"; type: "uint32"; }]; name: "checkpoints"; outputs: readonly [{ components: readonly [{ internalType: "uint48"; name: "_key"; type: "uint48"; }, { internalType: "uint208"; name: "_value"; type: "uint208"; }]; internalType: "struct Checkpoints.Checkpoint208"; name: ""; type: "tuple"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "clock"; outputs: readonly [{ internalType: "uint48"; name: ""; type: "uint48"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "context"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "_from"; type: "address"; }, { internalType: "uint256"; name: "_amount"; type: "uint256"; }]; name: "crosschainBurn"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "_to"; type: "address"; }, { internalType: "uint256"; name: "_amount"; type: "uint256"; }]; name: "crosschainMint"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "decimals"; outputs: readonly [{ internalType: "uint8"; name: ""; type: "uint8"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "delegatee"; type: "address"; }]; name: "delegate"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "delegatee"; type: "address"; }, { internalType: "uint256"; name: "nonce"; type: "uint256"; }, { internalType: "uint256"; name: "expiry"; type: "uint256"; }, { internalType: "uint8"; name: "v"; type: "uint8"; }, { internalType: "bytes32"; name: "r"; type: "bytes32"; }, { internalType: "bytes32"; name: "s"; type: "bytes32"; }]; name: "delegateBySig"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "delegates"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "eip712Domain"; outputs: readonly [{ internalType: "bytes1"; name: "fields"; type: "bytes1"; }, { internalType: "string"; name: "name"; type: "string"; }, { internalType: "string"; name: "version"; type: "string"; }, { internalType: "uint256"; name: "chainId"; type: "uint256"; }, { internalType: "address"; name: "verifyingContract"; type: "address"; }, { internalType: "bytes32"; name: "salt"; type: "bytes32"; }, { internalType: "uint256[]"; name: "extensions"; type: "uint256[]"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "timepoint"; type: "uint256"; }]; name: "getPastTotalSupply"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }, { internalType: "uint256"; name: "timepoint"; type: "uint256"; }]; name: "getPastVotes"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "getVotes"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "imageUrl"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "isVerified"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "metadata"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "name"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "owner"; type: "address"; }]; name: "nonces"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "numCheckpoints"; outputs: readonly [{ internalType: "uint32"; name: ""; type: "uint32"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "owner"; type: "address"; }, { internalType: "address"; name: "spender"; type: "address"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }, { internalType: "uint256"; name: "deadline"; type: "uint256"; }, { internalType: "uint8"; name: "v"; type: "uint8"; }, { internalType: "bytes32"; name: "r"; type: "bytes32"; }, { internalType: "bytes32"; name: "s"; type: "bytes32"; }]; name: "permit"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "bytes4"; name: "_interfaceId"; type: "bytes4"; }]; name: "supportsInterface"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "pure"; type: "function"; }, { inputs: readonly []; name: "symbol"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "totalSupply"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "to"; type: "address"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "transfer"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "from"; type: "address"; }, { internalType: "address"; name: "to"; type: "address"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "transferFrom"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "string"; name: "image_"; type: "string"; }]; name: "updateImage"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "string"; name: "metadata_"; type: "string"; }]; name: "updateMetadata"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "verify"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "owner"; type: "address"; }, { indexed: true; internalType: "address"; name: "spender"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "Approval"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "from"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "amount"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "sender"; type: "address"; }]; name: "CrosschainBurn"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "to"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "amount"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "sender"; type: "address"; }]; name: "CrosschainMint"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "delegator"; type: "address"; }, { indexed: true; internalType: "address"; name: "fromDelegate"; type: "address"; }, { indexed: true; internalType: "address"; name: "toDelegate"; type: "address"; }]; name: "DelegateChanged"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "delegate"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "previousVotes"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "newVotes"; type: "uint256"; }]; name: "DelegateVotesChanged"; type: "event"; }, { anonymous: false; inputs: readonly []; name: "EIP712DomainChanged"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "from"; type: "address"; }, { indexed: true; internalType: "address"; name: "to"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "Transfer"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "admin"; type: "address"; }, { indexed: true; internalType: "address"; name: "token"; type: "address"; }]; name: "Verified"; type: "event"; }, { inputs: readonly []; name: "AlreadyVerified"; type: "error"; }, { inputs: readonly []; name: "CheckpointUnorderedInsertion"; type: "error"; }, { inputs: readonly []; name: "ECDSAInvalidSignature"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "length"; type: "uint256"; }]; name: "ECDSAInvalidSignatureLength"; type: "error"; }, { inputs: readonly [{ internalType: "bytes32"; name: "s"; type: "bytes32"; }]; name: "ECDSAInvalidSignatureS"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "increasedSupply"; type: "uint256"; }, { internalType: "uint256"; name: "cap"; type: "uint256"; }]; name: "ERC20ExceededSafeSupply"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "spender"; type: "address"; }, { internalType: "uint256"; name: "allowance"; type: "uint256"; }, { internalType: "uint256"; name: "needed"; type: "uint256"; }]; name: "ERC20InsufficientAllowance"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "sender"; type: "address"; }, { internalType: "uint256"; name: "balance"; type: "uint256"; }, { internalType: "uint256"; name: "needed"; type: "uint256"; }]; name: "ERC20InsufficientBalance"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "approver"; type: "address"; }]; name: "ERC20InvalidApprover"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "receiver"; type: "address"; }]; name: "ERC20InvalidReceiver"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "sender"; type: "address"; }]; name: "ERC20InvalidSender"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "spender"; type: "address"; }]; name: "ERC20InvalidSpender"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "deadline"; type: "uint256"; }]; name: "ERC2612ExpiredSignature"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "signer"; type: "address"; }, { internalType: "address"; name: "owner"; type: "address"; }]; name: "ERC2612InvalidSigner"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "timepoint"; type: "uint256"; }, { internalType: "uint48"; name: "clock"; type: "uint48"; }]; name: "ERC5805FutureLookup"; type: "error"; }, { inputs: readonly []; name: "ERC6372InconsistentClock"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }, { internalType: "uint256"; name: "currentNonce"; type: "uint256"; }]; name: "InvalidAccountNonce"; type: "error"; }, { inputs: readonly []; name: "InvalidShortString"; type: "error"; }, { inputs: readonly []; name: "NotAdmin"; type: "error"; }, { inputs: readonly [{ internalType: "uint8"; name: "bits"; type: "uint8"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "SafeCastOverflowedUintDowncast"; type: "error"; }, { inputs: readonly [{ internalType: "string"; name: "str"; type: "string"; }]; name: "StringTooLong"; type: "error"; }, { inputs: readonly []; name: "Unauthorized"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "expiry"; type: "uint256"; }]; name: "VotesExpiredSignature"; type: "error"; }], | "approve" | "burn" | "burnFrom" | "crosschainBurn" | "crosschainMint" | "delegate" | "delegateBySig" | "permit" | "transfer" | "transferFrom" | "updateImage" | "updateMetadata" | "verify"> & { error?: undefined; } | UndefinedValues<SimulateContractReturnType<readonly [{ inputs: readonly [{ internalType: "string"; name: "name_"; type: "string"; }, { internalType: "string"; name: "symbol_"; type: "string"; }, { internalType: "uint256"; name: "maxSupply_"; type: "uint256"; }, { internalType: "address"; name: "admin_"; type: "address"; }, { internalType: "string"; name: "image_"; type: "string"; }, { internalType: "string"; name: "metadata_"; type: "string"; }, { internalType: "string"; name: "context_"; type: "string"; }, { internalType: "uint256"; name: "initialSupplyChainId_"; type: "uint256"; }]; stateMutability: "nonpayable"; type: "constructor"; }, { inputs: readonly []; name: "CLOCK_MODE"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "DOMAIN_SEPARATOR"; outputs: readonly [{ internalType: "bytes32"; name: ""; type: "bytes32"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "admin"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "owner"; type: "address"; }, { internalType: "address"; name: "spender"; type: "address"; }]; name: "allowance"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "spender"; type: "address"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "approve"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "balanceOf"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "burn"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "burnFrom"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }, { internalType: "uint32"; name: "pos"; type: "uint32"; }]; name: "checkpoints"; outputs: readonly [{ components: readonly [{ internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }]; internalType: "struct Checkpoints.Checkpoint208"; name: ""; type: "tuple"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "clock"; outputs: readonly [{ internalType: "uint48"; name: ""; type: "uint48"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "context"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "_from"; type: "address"; }, { internalType: "uint256"; name: "_amount"; type: "uint256"; }]; name: "crosschainBurn"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "_to"; type: "address"; }, { internalType: "uint256"; name: "_amount"; type: "uint256"; }]; name: "crosschainMint"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "decimals"; outputs: readonly [{ internalType: "uint8"; name: ""; type: "uint8"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "delegatee"; type: "address"; }]; name: "delegate"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "delegatee"; type: "address"; }, { internalType: "uint256"; name: "nonce"; type: "uint256"; }, { internalType: "uint256"; name: "expiry"; type: "uint256"; }, { internalType: "uint8"; name: "v"; type: "uint8"; }, { internalType: "bytes32"; name: "r"; type: "bytes32"; }, { internalType: "bytes32"; name: "s"; type: "bytes32"; }]; name: "delegateBySig"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "delegates"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "eip712Domain"; outputs: readonly [{ internalType: "bytes1"; name: "fields"; type: "bytes1"; }, { internalType: "string"; name: "name"; type: "string"; }, { internalType: "string"; name: "version"; type: "string"; }, { internalType: "uint256"; name: "chainId"; type: "uint256"; }, { internalType: "address"; name: "verifyingContract"; type: "address"; }, { internalType: "bytes32"; name: "salt"; type: "bytes32"; }, { internalType: "uint256[]"; name: "extensions"; type: "uint256[]"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "timepoint"; type: "uint256"; }]; name: "getPastTotalSupply"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }, { internalType: "uint256"; name: "timepoint"; type: "uint256"; }]; name: "getPastVotes"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "getVotes"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "imageUrl"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "isVerified"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "metadata"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "name"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "owner"; type: "address"; }]; name: "nonces"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "numCheckpoints"; outputs: readonly [{ internalType: "uint32"; name: ""; type: "uint32"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "owner"; type: "address"; }, { internalType: "address"; name: "spender"; type: "address"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }, { internalType: "uint256"; name: "deadline"; type: "uint256"; }, { internalType: "uint8"; name: "v"; type: "uint8"; }, { internalType: "bytes32"; name: "r"; type: "bytes32"; }, { internalType: "bytes32"; name: "s"; type: "bytes32"; }]; name: "permit"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "bytes4"; name: "_interfaceId"; type: "bytes4"; }]; name: "supportsInterface"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "pure"; type: "function"; }, { inputs: readonly []; name: "symbol"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "totalSupply"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "to"; type: "address"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "transfer"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "from"; type: "address"; }, { internalType: "address"; name: "to"; type: "address"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "transferFrom"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "string"; name: "image_"; type: "string"; }]; name: "updateImage"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "string"; name: "metadata_"; type: "string"; }]; name: "updateMetadata"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "verify"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "owner"; type: "address"; }, { indexed: true; internalType: "address"; name: "spender"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "Approval"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "from"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "amount"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "sender"; type: "address"; }]; name: "CrosschainBurn"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "to"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "amount"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "sender"; type: "address"; }]; name: "CrosschainMint"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "delegator"; type: "address"; }, { indexed: true; internalType: "address"; name: "fromDelegate"; type: "address"; }, { indexed: true; internalType: "address"; name: "toDelegate"; type: "address"; }]; name: "DelegateChanged"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "delegate"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "previousVotes"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "newVotes"; type: "uint256"; }]; name: "DelegateVotesChanged"; type: "event"; }, { anonymous: false; inputs: readonly []; name: "EIP712DomainChanged"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "from"; type: "address"; }, { indexed: true; internalType: "address"; name: "to"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "Transfer"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "admin"; type: "address"; }, { indexed: true; internalType: "address"; name: "token"; type: "address"; }]; name: "Verified"; type: "event"; }, { inputs: readonly []; name: "AlreadyVerified"; type: "error"; }, { inputs: readonly []; name: "CheckpointUnorderedInsertion"; type: "error"; }, { inputs: readonly []; name: "ECDSAInvalidSignature"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "length"; type: "uint256"; }]; name: "ECDSAInvalidSignatureLength"; type: "error"; }, { inputs: readonly [{ internalType: "bytes32"; name: "s"; type: "bytes32"; }]; name: "ECDSAInvalidSignatureS"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "increasedSupply"; type: "uint256"; }, { internalType: "uint256"; name: "cap"; type: "uint256"; }]; name: "ERC20ExceededSafeSupply"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "spender"; type: "address"; }, { internalType: "uint256"; name: "allowance"; type: "uint256"; }, { internalType: "uint256"; name: "needed"; type: "uint256"; }]; name: "ERC20InsufficientAllowance"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "sender"; type: "address"; }, { internalType: "uint256"; name: "balance"; type: "uint256"; }, { internalType: "uint256"; name: "needed"; type: "uint256"; }]; name: "ERC20InsufficientBalance"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "approver"; type: "address"; }]; name: "ERC20InvalidApprover"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "receiver"; type: "address"; }]; name: "ERC20InvalidReceiver"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "sender"; type: "address"; }]; name: "ERC20InvalidSender"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "spender"; type: "address"; }]; name: "ERC20InvalidSpender"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "deadline"; type: "uint256"; }]; name: "ERC2612ExpiredSignature"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "signer"; type: "address"; }, { internalType: "address"; name: "owner"; type: "address"; }]; name: "ERC2612InvalidSigner"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "timepoint"; type: "uint256"; }, { internalType: "uint48"; name: "clock"; type: "uint48"; }]; name: "ERC5805FutureLookup"; type: "error"; }, { inputs: readonly []; name: "ERC6372InconsistentClock"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }, { internalType: "uint256"; name: "currentNonce"; type: "uint256"; }]; name: "InvalidAccountNonce"; type: "error"; }, { inputs: readonly []; name: "InvalidShortString"; type: "error"; }, { inputs: readonly []; name: "NotAdmin"; type: "error"; }, { inputs: readonly [{ internalType: "uint8"; name: "bits"; type: "uint8"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "SafeCastOverflowedUintDowncast"; type: "error"; }, { inputs: readonly [{ internalType: "string"; name: "str"; type: "string"; }]; name: "StringTooLong"; type: "error"; }, { inputs: readonly []; name: "Unauthorized"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "expiry"; type: "uint256"; }]; name: "VotesExpiredSignature"; type: "error"; }], | "approve" | "burn" | "burnFrom" | "crosschainBurn" | "crosschainMint" | "delegate" | "delegateBySig" | "permit" | "transfer" | "transferFrom" | "updateImage" | "updateMetadata" | "verify">> & { error: ClankerError; }>

The simulated output

updateMetadata()

Defined in: src/v3/index.ts:395

Update the token metadata.

Parameters

Parameter
Type
Description

token

{ metadata: string; token: `0x${string}`; }

The token to update the metadata for

token.metadata

string

-

token.token

`0x${string}`

-

Returns

Promise< | { error: undefined; txHash: `0x${string}`; } | { error: ClankerError; txHash: undefined; }>

Transaction hash of the update or error

updateMetadataSimulate()

Defined in: src/v3/index.ts:351

Simulate updating the token metadata. Will use the wallet account on the Clanker class or the passed-in account.

Parameters

Parameter
Type
Description

token

{ metadata: string; token: `0x${string}`; }

The token to update the metadata for

token.metadata

string

-

token.token?

`0x${string}`

-

account?

Account

Optional account to simulate calling for

Returns

Promise< | SimulateContractReturnType<readonly [{ inputs: readonly [{ internalType: "string"; name: "name_"; type: "string"; }, { internalType: "string"; name: "symbol_"; type: "string"; }, { internalType: "uint256"; name: "maxSupply_"; type: "uint256"; }, { internalType: "address"; name: "admin_"; type: "address"; }, { internalType: "string"; name: "image_"; type: "string"; }, { internalType: "string"; name: "metadata_"; type: "string"; }, { internalType: "string"; name: "context_"; type: "string"; }, { internalType: "uint256"; name: "initialSupplyChainId_"; type: "uint256"; }]; stateMutability: "nonpayable"; type: "constructor"; }, { inputs: readonly []; name: "CLOCK_MODE"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "DOMAIN_SEPARATOR"; outputs: readonly [{ internalType: "bytes32"; name: ""; type: "bytes32"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "admin"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "owner"; type: "address"; }, { internalType: "address"; name: "spender"; type: "address"; }]; name: "allowance"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "spender"; type: "address"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "approve"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "balanceOf"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "burn"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "burnFrom"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }, { internalType: "uint32"; name: "pos"; type: "uint32"; }]; name: "checkpoints"; outputs: readonly [{ components: readonly [{ internalType: "uint48"; name: "_key"; type: "uint48"; }, { internalType: "uint208"; name: "_value"; type: "uint208"; }]; internalType: "struct Checkpoints.Checkpoint208"; name: ""; type: "tuple"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "clock"; outputs: readonly [{ internalType: "uint48"; name: ""; type: "uint48"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "context"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "_from"; type: "address"; }, { internalType: "uint256"; name: "_amount"; type: "uint256"; }]; name: "crosschainBurn"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "_to"; type: "address"; }, { internalType: "uint256"; name: "_amount"; type: "uint256"; }]; name: "crosschainMint"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "decimals"; outputs: readonly [{ internalType: "uint8"; name: ""; type: "uint8"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "delegatee"; type: "address"; }]; name: "delegate"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "delegatee"; type: "address"; }, { internalType: "uint256"; name: "nonce"; type: "uint256"; }, { internalType: "uint256"; name: "expiry"; type: "uint256"; }, { internalType: "uint8"; name: "v"; type: "uint8"; }, { internalType: "bytes32"; name: "r"; type: "bytes32"; }, { internalType: "bytes32"; name: "s"; type: "bytes32"; }]; name: "delegateBySig"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "delegates"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "eip712Domain"; outputs: readonly [{ internalType: "bytes1"; name: "fields"; type: "bytes1"; }, { internalType: "string"; name: "name"; type: "string"; }, { internalType: "string"; name: "version"; type: "string"; }, { internalType: "uint256"; name: "chainId"; type: "uint256"; }, { internalType: "address"; name: "verifyingContract"; type: "address"; }, { internalType: "bytes32"; name: "salt"; type: "bytes32"; }, { internalType: "uint256[]"; name: "extensions"; type: "uint256[]"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "timepoint"; type: "uint256"; }]; name: "getPastTotalSupply"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }, { internalType: "uint256"; name: "timepoint"; type: "uint256"; }]; name: "getPastVotes"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "getVotes"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "imageUrl"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "isVerified"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "metadata"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "name"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "owner"; type: "address"; }]; name: "nonces"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "numCheckpoints"; outputs: readonly [{ internalType: "uint32"; name: ""; type: "uint32"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "owner"; type: "address"; }, { internalType: "address"; name: "spender"; type: "address"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }, { internalType: "uint256"; name: "deadline"; type: "uint256"; }, { internalType: "uint8"; name: "v"; type: "uint8"; }, { internalType: "bytes32"; name: "r"; type: "bytes32"; }, { internalType: "bytes32"; name: "s"; type: "bytes32"; }]; name: "permit"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "bytes4"; name: "_interfaceId"; type: "bytes4"; }]; name: "supportsInterface"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "pure"; type: "function"; }, { inputs: readonly []; name: "symbol"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "totalSupply"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "to"; type: "address"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "transfer"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "from"; type: "address"; }, { internalType: "address"; name: "to"; type: "address"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "transferFrom"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "string"; name: "image_"; type: "string"; }]; name: "updateImage"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "string"; name: "metadata_"; type: "string"; }]; name: "updateMetadata"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "verify"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "owner"; type: "address"; }, { indexed: true; internalType: "address"; name: "spender"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "Approval"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "from"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "amount"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "sender"; type: "address"; }]; name: "CrosschainBurn"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "to"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "amount"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "sender"; type: "address"; }]; name: "CrosschainMint"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "delegator"; type: "address"; }, { indexed: true; internalType: "address"; name: "fromDelegate"; type: "address"; }, { indexed: true; internalType: "address"; name: "toDelegate"; type: "address"; }]; name: "DelegateChanged"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "delegate"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "previousVotes"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "newVotes"; type: "uint256"; }]; name: "DelegateVotesChanged"; type: "event"; }, { anonymous: false; inputs: readonly []; name: "EIP712DomainChanged"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "from"; type: "address"; }, { indexed: true; internalType: "address"; name: "to"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "Transfer"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "admin"; type: "address"; }, { indexed: true; internalType: "address"; name: "token"; type: "address"; }]; name: "Verified"; type: "event"; }, { inputs: readonly []; name: "AlreadyVerified"; type: "error"; }, { inputs: readonly []; name: "CheckpointUnorderedInsertion"; type: "error"; }, { inputs: readonly []; name: "ECDSAInvalidSignature"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "length"; type: "uint256"; }]; name: "ECDSAInvalidSignatureLength"; type: "error"; }, { inputs: readonly [{ internalType: "bytes32"; name: "s"; type: "bytes32"; }]; name: "ECDSAInvalidSignatureS"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "increasedSupply"; type: "uint256"; }, { internalType: "uint256"; name: "cap"; type: "uint256"; }]; name: "ERC20ExceededSafeSupply"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "spender"; type: "address"; }, { internalType: "uint256"; name: "allowance"; type: "uint256"; }, { internalType: "uint256"; name: "needed"; type: "uint256"; }]; name: "ERC20InsufficientAllowance"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "sender"; type: "address"; }, { internalType: "uint256"; name: "balance"; type: "uint256"; }, { internalType: "uint256"; name: "needed"; type: "uint256"; }]; name: "ERC20InsufficientBalance"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "approver"; type: "address"; }]; name: "ERC20InvalidApprover"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "receiver"; type: "address"; }]; name: "ERC20InvalidReceiver"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "sender"; type: "address"; }]; name: "ERC20InvalidSender"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "spender"; type: "address"; }]; name: "ERC20InvalidSpender"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "deadline"; type: "uint256"; }]; name: "ERC2612ExpiredSignature"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "signer"; type: "address"; }, { internalType: "address"; name: "owner"; type: "address"; }]; name: "ERC2612InvalidSigner"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "timepoint"; type: "uint256"; }, { internalType: "uint48"; name: "clock"; type: "uint48"; }]; name: "ERC5805FutureLookup"; type: "error"; }, { inputs: readonly []; name: "ERC6372InconsistentClock"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }, { internalType: "uint256"; name: "currentNonce"; type: "uint256"; }]; name: "InvalidAccountNonce"; type: "error"; }, { inputs: readonly []; name: "InvalidShortString"; type: "error"; }, { inputs: readonly []; name: "NotAdmin"; type: "error"; }, { inputs: readonly [{ internalType: "uint8"; name: "bits"; type: "uint8"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "SafeCastOverflowedUintDowncast"; type: "error"; }, { inputs: readonly [{ internalType: "string"; name: "str"; type: "string"; }]; name: "StringTooLong"; type: "error"; }, { inputs: readonly []; name: "Unauthorized"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "expiry"; type: "uint256"; }]; name: "VotesExpiredSignature"; type: "error"; }], | "approve" | "burn" | "burnFrom" | "crosschainBurn" | "crosschainMint" | "delegate" | "delegateBySig" | "permit" | "transfer" | "transferFrom" | "updateImage" | "updateMetadata" | "verify"> & { error?: undefined; } | UndefinedValues<SimulateContractReturnType<readonly [{ inputs: readonly [{ internalType: "string"; name: "name_"; type: "string"; }, { internalType: "string"; name: "symbol_"; type: "string"; }, { internalType: "uint256"; name: "maxSupply_"; type: "uint256"; }, { internalType: "address"; name: "admin_"; type: "address"; }, { internalType: "string"; name: "image_"; type: "string"; }, { internalType: "string"; name: "metadata_"; type: "string"; }, { internalType: "string"; name: "context_"; type: "string"; }, { internalType: "uint256"; name: "initialSupplyChainId_"; type: "uint256"; }]; stateMutability: "nonpayable"; type: "constructor"; }, { inputs: readonly []; name: "CLOCK_MODE"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "DOMAIN_SEPARATOR"; outputs: readonly [{ internalType: "bytes32"; name: ""; type: "bytes32"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "admin"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "owner"; type: "address"; }, { internalType: "address"; name: "spender"; type: "address"; }]; name: "allowance"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "spender"; type: "address"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "approve"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "balanceOf"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "burn"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "burnFrom"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }, { internalType: "uint32"; name: "pos"; type: "uint32"; }]; name: "checkpoints"; outputs: readonly [{ components: readonly [{ internalType: ...; name: ...; type: ...; }, { internalType: ...; name: ...; type: ...; }]; internalType: "struct Checkpoints.Checkpoint208"; name: ""; type: "tuple"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "clock"; outputs: readonly [{ internalType: "uint48"; name: ""; type: "uint48"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "context"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "_from"; type: "address"; }, { internalType: "uint256"; name: "_amount"; type: "uint256"; }]; name: "crosschainBurn"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "_to"; type: "address"; }, { internalType: "uint256"; name: "_amount"; type: "uint256"; }]; name: "crosschainMint"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "decimals"; outputs: readonly [{ internalType: "uint8"; name: ""; type: "uint8"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "delegatee"; type: "address"; }]; name: "delegate"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "delegatee"; type: "address"; }, { internalType: "uint256"; name: "nonce"; type: "uint256"; }, { internalType: "uint256"; name: "expiry"; type: "uint256"; }, { internalType: "uint8"; name: "v"; type: "uint8"; }, { internalType: "bytes32"; name: "r"; type: "bytes32"; }, { internalType: "bytes32"; name: "s"; type: "bytes32"; }]; name: "delegateBySig"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "delegates"; outputs: readonly [{ internalType: "address"; name: ""; type: "address"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "eip712Domain"; outputs: readonly [{ internalType: "bytes1"; name: "fields"; type: "bytes1"; }, { internalType: "string"; name: "name"; type: "string"; }, { internalType: "string"; name: "version"; type: "string"; }, { internalType: "uint256"; name: "chainId"; type: "uint256"; }, { internalType: "address"; name: "verifyingContract"; type: "address"; }, { internalType: "bytes32"; name: "salt"; type: "bytes32"; }, { internalType: "uint256[]"; name: "extensions"; type: "uint256[]"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "uint256"; name: "timepoint"; type: "uint256"; }]; name: "getPastTotalSupply"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }, { internalType: "uint256"; name: "timepoint"; type: "uint256"; }]; name: "getPastVotes"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "getVotes"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "imageUrl"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "isVerified"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "metadata"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "name"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "owner"; type: "address"; }]; name: "nonces"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }]; name: "numCheckpoints"; outputs: readonly [{ internalType: "uint32"; name: ""; type: "uint32"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "owner"; type: "address"; }, { internalType: "address"; name: "spender"; type: "address"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }, { internalType: "uint256"; name: "deadline"; type: "uint256"; }, { internalType: "uint8"; name: "v"; type: "uint8"; }, { internalType: "bytes32"; name: "r"; type: "bytes32"; }, { internalType: "bytes32"; name: "s"; type: "bytes32"; }]; name: "permit"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "bytes4"; name: "_interfaceId"; type: "bytes4"; }]; name: "supportsInterface"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "pure"; type: "function"; }, { inputs: readonly []; name: "symbol"; outputs: readonly [{ internalType: "string"; name: ""; type: "string"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly []; name: "totalSupply"; outputs: readonly [{ internalType: "uint256"; name: ""; type: "uint256"; }]; stateMutability: "view"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "to"; type: "address"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "transfer"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "address"; name: "from"; type: "address"; }, { internalType: "address"; name: "to"; type: "address"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "transferFrom"; outputs: readonly [{ internalType: "bool"; name: ""; type: "bool"; }]; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "string"; name: "image_"; type: "string"; }]; name: "updateImage"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly [{ internalType: "string"; name: "metadata_"; type: "string"; }]; name: "updateMetadata"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { inputs: readonly []; name: "verify"; outputs: readonly []; stateMutability: "nonpayable"; type: "function"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "owner"; type: "address"; }, { indexed: true; internalType: "address"; name: "spender"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "Approval"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "from"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "amount"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "sender"; type: "address"; }]; name: "CrosschainBurn"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "to"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "amount"; type: "uint256"; }, { indexed: true; internalType: "address"; name: "sender"; type: "address"; }]; name: "CrosschainMint"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "delegator"; type: "address"; }, { indexed: true; internalType: "address"; name: "fromDelegate"; type: "address"; }, { indexed: true; internalType: "address"; name: "toDelegate"; type: "address"; }]; name: "DelegateChanged"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "delegate"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "previousVotes"; type: "uint256"; }, { indexed: false; internalType: "uint256"; name: "newVotes"; type: "uint256"; }]; name: "DelegateVotesChanged"; type: "event"; }, { anonymous: false; inputs: readonly []; name: "EIP712DomainChanged"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "from"; type: "address"; }, { indexed: true; internalType: "address"; name: "to"; type: "address"; }, { indexed: false; internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "Transfer"; type: "event"; }, { anonymous: false; inputs: readonly [{ indexed: true; internalType: "address"; name: "admin"; type: "address"; }, { indexed: true; internalType: "address"; name: "token"; type: "address"; }]; name: "Verified"; type: "event"; }, { inputs: readonly []; name: "AlreadyVerified"; type: "error"; }, { inputs: readonly []; name: "CheckpointUnorderedInsertion"; type: "error"; }, { inputs: readonly []; name: "ECDSAInvalidSignature"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "length"; type: "uint256"; }]; name: "ECDSAInvalidSignatureLength"; type: "error"; }, { inputs: readonly [{ internalType: "bytes32"; name: "s"; type: "bytes32"; }]; name: "ECDSAInvalidSignatureS"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "increasedSupply"; type: "uint256"; }, { internalType: "uint256"; name: "cap"; type: "uint256"; }]; name: "ERC20ExceededSafeSupply"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "spender"; type: "address"; }, { internalType: "uint256"; name: "allowance"; type: "uint256"; }, { internalType: "uint256"; name: "needed"; type: "uint256"; }]; name: "ERC20InsufficientAllowance"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "sender"; type: "address"; }, { internalType: "uint256"; name: "balance"; type: "uint256"; }, { internalType: "uint256"; name: "needed"; type: "uint256"; }]; name: "ERC20InsufficientBalance"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "approver"; type: "address"; }]; name: "ERC20InvalidApprover"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "receiver"; type: "address"; }]; name: "ERC20InvalidReceiver"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "sender"; type: "address"; }]; name: "ERC20InvalidSender"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "spender"; type: "address"; }]; name: "ERC20InvalidSpender"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "deadline"; type: "uint256"; }]; name: "ERC2612ExpiredSignature"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "signer"; type: "address"; }, { internalType: "address"; name: "owner"; type: "address"; }]; name: "ERC2612InvalidSigner"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "timepoint"; type: "uint256"; }, { internalType: "uint48"; name: "clock"; type: "uint48"; }]; name: "ERC5805FutureLookup"; type: "error"; }, { inputs: readonly []; name: "ERC6372InconsistentClock"; type: "error"; }, { inputs: readonly [{ internalType: "address"; name: "account"; type: "address"; }, { internalType: "uint256"; name: "currentNonce"; type: "uint256"; }]; name: "InvalidAccountNonce"; type: "error"; }, { inputs: readonly []; name: "InvalidShortString"; type: "error"; }, { inputs: readonly []; name: "NotAdmin"; type: "error"; }, { inputs: readonly [{ internalType: "uint8"; name: "bits"; type: "uint8"; }, { internalType: "uint256"; name: "value"; type: "uint256"; }]; name: "SafeCastOverflowedUintDowncast"; type: "error"; }, { inputs: readonly [{ internalType: "string"; name: "str"; type: "string"; }]; name: "StringTooLong"; type: "error"; }, { inputs: readonly []; name: "Unauthorized"; type: "error"; }, { inputs: readonly [{ internalType: "uint256"; name: "expiry"; type: "uint256"; }]; name: "VotesExpiredSignature"; type: "error"; }], | "approve" | "burn" | "burnFrom" | "crosschainBurn" | "crosschainMint" | "delegate" | "delegateBySig" | "permit" | "transfer" | "transferFrom" | "updateImage" | "updateMetadata" | "verify">> & { error: ClankerError; }>

The simulated output

Last updated