clanker-sdk / legacyFeeClaims
Classes
LegacyCreatorFees
Defined in: src/legacyFeeClaims/claimCreatorFees.ts:146 Legacy Creator Fee Claims for Clanker v0–v3.1 on Base.Example
Constructors
LegacyCreatorFees
Properties
Methods
Promise<
| {
error: undefined;
txHash: `0x${string}`;
}
| {
error: ClankerError;
txHash: undefined;
}>
Transaction hash or error
Promise<
| SimulateContractReturnType<Abi | readonly unknown[], string, readonly unknown[], Chain | undefined, undefined, undefined, undefined, readonly [never], undefined>
| {
error: ClankerError;
}>
Simulation result or error
LegacyClaimTransactionConfig
Transaction config
LegacyClaimTransactionConfig
Transaction config
LegacyFeeClaims
Defined in: src/legacyFeeClaims/index.ts:264 SDK for claiming legacy fees from Clanker v0-v3.1 tokens. Creators of Clankers v0-v3.1 can claim their returned fees by interacting with the ClankerSafeErc20Spender contract. Creators have three main actions:- Initialize their ownership of the token’s fees, with optional ability to set a different admin key
- Update the admin key that can trigger claims
- Claim the generated fees for their token
Constructors
LegacyFeeClaims
Properties
Methods
Promise<LegacyClaimTx>
Transaction object with { kind, to, data, value? }
View full generated declaration (402 lines)
Defined in: src/legacyFeeClaims/index.ts:484
Get an abi-typed transaction for initializing token creator ownership.
This must be called once per token by the original creator to claim ownership
of the token’s fees. During this call, the creator can optionally set a different
admin key to manage the token’s rewards.
View full generated declaration (402 lines)
Abi transaction config
Promise<LegacyClaimableFees>
Claimable fees with position owner, token0, token1, amount0, amount1
Promise<`0x${string}`>
The creator address for the token
Promise<`0x${string}`>
The current token creator Merkle root
View full generated declaration (402 lines)
Defined in: src/legacyFeeClaims/index.ts:688
Get an abi-typed transaction for claiming token creator fees.
This allows the authorized creator to transfer all accumulated fees from the
Safe wallet to any recipient address. Only callable by the authorized creator
for the specified token.
View full generated declaration (402 lines)
Abi transaction config
View full generated declaration (402 lines)
Defined in: src/legacyFeeClaims/index.ts:590
Get an abi-typed transaction for updating the token creator admin address.
This allows the current creator to change the address that can trigger claims.
Only callable by the current creator address for the specified token.
View full generated declaration (402 lines)
Abi transaction config
Promise<
| {
error: undefined;
txHash: `0x${string}`;
}
| {
error: ClankerError;
txHash: undefined;
}>
Transaction hash or error
Promise<any>
The simulated output
Promise<
| {
error: undefined;
txHash: `0x${string}`;
}
| {
error: ClankerError;
txHash: undefined;
}>
Transaction hash or error
Promise<any>
The simulated output
Promise<
| {
error: undefined;
txHash: `0x${string}`;
}
| {
error: ClankerError;
txHash: undefined;
}>
Transaction hash or error
Promise<any>
The simulated output
Interfaces
MerkleProofResult
Defined in: src/legacyFeeClaims/index.ts:839 Result of merkle proof generationProperties
TokenCreatorEntry
Defined in: src/legacyFeeClaims/index.ts:831 Interface for token creator entries in the CSV dataProperties
Type Aliases
ClaimLegacyCreatorFeesInput
token and version are required.
For v0/v1: Additional lockerParams are required.
Type Declaration
LegacyClaimableFees
Properties
LegacyClaimArgs
Properties
LegacyClaimFeesInput
Deprecated
Use LegacyClaimArgs insteadLegacyClaimFeesTransaction
Deprecated
Use LegacyClaimTx insteadLegacyClaimTransactionConfig
Properties
LegacyClaimTx
Properties
LegacyClaimTxKind
LegacyTokenType
LegacyVersion
LockerParams
Properties
Variables
BASE_CHAIN_ID
CLANKER_FACTORIES_BASE
Type Declaration
ClankerClaimRewardsAbi
ClankerTokenDeployerAbi
EXPECTED_MERKLE_ROOT
LEGACY_FACTORIES
Type Declaration
LEGACY_FEE_CLAIMS_ADDRESS
LockerCollectFeesAbi
MetaLockerCollectFeesAbi
NonfungiblePositionManagerCollectAbi
NonfungiblePositionManagerOwnerOfAbi
NonfungiblePositionManagerPositionsAbi
UNISWAP_V3_BASE
Type Declaration
Functions
getClaimLegacyCreatorFeesTransaction()
Parameters
Returns
LegacyClaimTransactionConfig
Transaction config
Example
getClaimLegacyFeesTransaction()
- v2/v3/v3.1: call factory.claimRewards(token)
- v0/v1: call locker.collectFees(recipient, tokenId) or metaLocker.collectFees(tokenId)
Parameters
Returns
Promise<LegacyClaimTx>
Transaction object with { kind, to, data, value? }
getInitializeTokenCreatorTransaction()
View full generated declaration (402 lines) Defined in: src/legacyFeeClaims/index.ts:934 Get a transaction config for initializing token creator ownership.Parameters
Returns
View full generated declaration (402 lines) Transaction configgetLegacyClaimableFees()
Parameters
Returns
Promise<LegacyClaimableFees>
Claimable fees with positionOwner, token0, token1, amount0, amount1
getTokenCreatorMerkleProof()
Parameters
Returns
MerkleProofResult | null
Merkle proof result or null if token not found
getTokenCreatorTransferTransaction()
View full generated declaration (402 lines) Defined in: src/legacyFeeClaims/index.ts:981 Get a transaction config for claiming token creator fees.Parameters
Returns
View full generated declaration (402 lines) Transaction configgetUpdateTokenCreatorTransaction()
View full generated declaration (402 lines) Defined in: src/legacyFeeClaims/index.ts:958 Get a transaction config for updating the token creator admin address.Parameters
Returns
View full generated declaration (402 lines) Transaction configparseTokenCreatorCSV()
Parameters
Returns
TokenCreatorEntry[]
Array of token-creator entries