ICLBToken.sol

ICLBToken

Interface for CLBToken contract, which represents Liquidity Bin tokens.

totalSupply

function totalSupply(uint256 id) external view returns (uint256)

Total amount of tokens in with a given id.

• Parameters:

  Name	Type	Description
  id	uint256	The token ID for which to retrieve the total supply.

• Return Values:

  Name	Type	Description
  [0]	uint256	The total supply of tokens for the given token ID.

totalSupplyBatch

function totalSupplyBatch(uint256[] ids) external view returns (uint256[])

Total amounts of tokens in with the given ids.

• Parameters:

  Name	Type	Description
  ids	uint256[]	The token IDs for which to retrieve the total supply.

• Return Values:

  Name	Type	Description
  [0]	uint256[]	The total supples of tokens for the given token IDs.

mint

function mint(address to, uint256 id, uint256 amount, bytes data) external

Mints new tokens and assigns them to the specified address.

• Parameters:

  Name	Type	Description
  to	address	The address to which the minted tokens will be assigned.
  id	uint256	The token ID to mint.
  amount	uint256	The amount of tokens to mint.
  data	bytes	Additional data to pass during the minting process.

burn

function burn(address from, uint256 id, uint256 amount) external

Burns tokens from a specified address.

• Parameters:

  Name	Type	Description
  from	address	The address from which to burn tokens.
  id	uint256	The token ID to burn.
  amount	uint256	The amount of tokens to burn.

decimals

function decimals() external view returns (uint8)

Retrieves the number of decimals used for token amounts.

• Return Values:

  Name	Type	Description
  [0]	uint8	The number of decimals used for token amounts.

name

function name(uint256 id) external view returns (string)

Retrieves the name of a token.

• Parameters:

  Name	Type	Description
  id	uint256	The token ID for which to retrieve the name.

• Return Values:

  Name	Type	Description
  [0]	string	The name of the token.

description

function description(uint256 id) external view returns (string)

Retrieves the description of a token.

• Parameters:

  Name	Type	Description
  id	uint256	The token ID for which to retrieve the description.

• Return Values:

  Name	Type	Description
  [0]	string	The description of the token.

image

function image(uint256 id) external view returns (string)

Retrieves the image URI of a token.

• Parameters:

  Name	Type	Description
  id	uint256	The token ID for which to retrieve the image URI.

• Return Values:

  Name	Type	Description
  [0]	string	The image URI of the token.