Clanker Documentation
  • Introduction to Clanker
  • Changelog
  • General
    • FAQ
    • Token Deployments
      • Farcaster Bot Deployments
      • Clanker.world Deployments
      • Preclank Deployments
      • Alternative Interface Deployments
    • Creator Rewards & Fees
    • Clanker.world Warning Tags
  • SDK
    • Quick Start
    • v4.0.0
    • v3.1.0
    • CLI
  • API
  • Quick Start
  • Public
    • Get Tokens
    • [PLANNED EOL] Get Tokens (Search)
  • Authenticated
    • Deploy Token (v4.0.0)
    • Get Token by Address
    • Get Tokens Deployed by Address
    • Get Estimated Rewards
    • Get Uncollected Fees
    • Deploy Token (v3.1.0)
    • Deploy Token w/Splits (v3.1.0)
  • References
    • Core Contracts
      • v4.0.0
        • Deployment Config
        • Fee Management Contracts
          • ClankerFeeLocker
          • ClankerLpLockerMultiple [Deprecated]
          • ClankerLpLockerFeeConversion
        • Extensions
          • ClankerVault
          • ClankerAirdrop
          • ClankerUniv4EthDevBuy
        • ClankerHook
          • ClankerHookStaticFee
          • ClankerHookDynamicFee
        • Mev Modules
          • ClankerMevModule2BlockDelay
          • ClankerSniperAuctionV0
        • ClankerToken
        • Administrative Permissions
      • v3.1.0
        • Clanker (Direct Contract Deployments)
        • LpLockerv2
        • ClankerVault
      • ClankerToken v3.1.0 and v4.0.0
    • Brand Assets
    • Audits
    • Compatible Trading Platforms
    • Deployed Contracts
    • Supported Quote Tokens
    • Core Team
    • Contact
Powered by GitBook
On this page
  1. References
  2. Core Contracts
  3. v3.1.0

ClankerVault

PreviousLpLockerv2NextClankerToken v3.1.0 and v4.0.0

Last updated 5 months ago

CtrlK

The ClankerVault contract manages locked tokens from the Clanker contract. Only the Clanker contract can deposit tokens into the vault, and tokens can only be vaulted once. Each token has the creatorAdmin as the initial admin for the token. The token's address (emitted and returned from deployToken()) is used as the token parameter for all ClankerVault functions.

User Functions

withdraw(): Allows users to withdraw tokens that have reached their unlock time

// note: will revert if not called by the token's admin
function withdraw(
    address token,    // Token to withdraw
    uint256 amount,   // Withdrawal amount
    address to        // Recipient address
) external {...}

editAllocationAdmin(): Allows changing the token's admin

// note: will revert if not called by the token's admin
function editAllocationAdmin(
    address token,    // Token to modify
    address newAdmin  // New administrator address
) external {...}