MultiToken API

This module provides the full MultiToken module API.

For an overview of the module, read the MultiToken guide.

Core

MultiToken

import "./node-modules/@openzeppelin-compact/contracts/src/token/MultiToken";

Ledger

_balances: Map<Uint<128>, Map<Either<ZswapCoinPublicKey, ContractAddress>, Uint<128>>>

ledger

Mapping from token ID to account balances.

_operatorApprovals: Map<Either<ZswapCoinPublicKey, ContractAddress>, Map<Either<ZswapCoinPublicKey, ContractAddress>, Boolean>>

ledger

Mapping from account to operator approvals.

_uri: Opaque<"string">

ledger

Base URI for computing token URIs.

Circuits

initialize(uri_: Opaque<"string">) → []

circuit

Initializes the contract by setting the base URI for all tokens.

This MUST be called in the implementing contract’s constructor. Failure to do so can lead to an irreparable contract.

Requirements:

Contract is not initialized.

k=10, rows=45

uri(id: Uint<128>) → Opaque<"string">

circuit

This implementation returns the same URI for all token types. It relies on the token type ID substitution mechanism defined in the EIP: ERC1155-Metadata. Clients calling this function must replace the \id\ substring with the actual token type ID.

Requirements:

Contract is initialized.

k=10, rows=90

balanceOf(account: Either<ZswapCoinPublicKey, ContractAddress>, id: Uint<128>) → Uint<128>

circuit

Returns the amount of id tokens owned by account.

Requirements:

Contract is initialized.

k=10, rows=439

setApprovalForAll(
  operator: Either<ZswapCoinPublicKey, ContractAddress>,
  approved: Boolean
) → []

circuit

Enables or disables approval for operator to manage all of the caller’s assets.

Requirements:

Contract is initialized.
operator is not the zero address.

k=10, rows=404

isApprovedForAll(
  account: Either<ZswapCoinPublicKey, ContractAddress>,
  operator: Either<ZswapCoinPublicKey, ContractAddress>
) → Boolean

circuit

Queries if operator is an authorized operator for owner.

Requirements:

Contract is initialized.

k=10, rows=619

transferFrom(
  from: Either<ZswapCoinPublicKey, ContractAddress>,
  to: Either<ZswapCoinPublicKey, ContractAddress>,
  id: Uint<128>,
  value: Uint<128>
) → []

circuit

Transfers ownership of value amount of id tokens from from to to. The caller must be from or approved to transfer on their behalf.

Transfers to contract addresses are currently disallowed until contract-to-contract interactions are supported in Compact. This restriction prevents assets from being inadvertently locked in contracts that cannot currently handle token receipt.

Requirements:

Contract is initialized.
to is not a ContractAddress.
to is not the zero address.
from is not the zero address.
Caller must be from or approved via setApprovalForAll.
from must have an id balance of at least value.

k=11, rows=1882

_transfer(
  from: Either<ZswapCoinPublicKey, ContractAddress>,
  to: Either<ZswapCoinPublicKey, ContractAddress>,
  id: Uint<128>,
  value: Uint<128>
): []

circuit

Transfers ownership of value amount of id tokens from from to to. Does not impose restrictions on the caller, making it suitable for composition in higher-level contract logic.

Requirements:

Contract is initialized.
to is not a ContractAddress.
to is not the zero address.
from is not the zero address.
from must have an id balance of at least value.

k=11, rows=1487

_update(
  from: Either<ZswapCoinPublicKey, ContractAddress>,
  to: Either<ZswapCoinPublicKey, ContractAddress>,
  id: Uint<128>,
  value: Uint<128>
): []

circuit

Transfers a value amount of tokens of type id from from to to. This circuit will mint (or burn) if from (or to) is the zero address.

Requirements:

Contract is initialized.
If from is not zero, the balance of id of from must be >= value.

k=11, rows=1482

_unsafeTransferFrom(
  from: Either<ZswapCoinPublicKey, ContractAddress>,
  to: Either<ZswapCoinPublicKey, ContractAddress>,
  id: Uint<128>,
  value: Uint<128>
) → []

circuit

Unsafe variant of transferFrom which allows transfers to contract addresses. The caller must be from or approved to transfer on their behalf.

Transfers to contract addresses are considered unsafe because contract-to-contract calls are not currently supported. Tokens sent to a contract address may become irretrievable. Once contract-to-contract calls are supported, this circuit may be deprecated.

Requirements:

Contract is initialized.
to is not the zero address.
from is not the zero address.
Caller must be from or approved via setApprovalForAll.
from must have an id balance of at least value.

k=11, rows=1881

_unsafeTransfer(
  from: Either<ZswapCoinPublicKey, ContractAddress>,
  to: Either<ZswapCoinPublicKey, ContractAddress>,
  id: Uint<128>,
  value: Uint<128>
) → []

circuit

Unsafe variant of _transfer which allows transfers to contract addresses. Does not impose restrictions on the caller, making it suitable as a low-level building block for advanced contract logic.

Requirements:

Contract is initialized.
from is not the zero address.
to is not the zero address.
from must have an id balance of at least value.

k=11, rows=1486

_setURI(newURI: Opaque<"string">) → []

circuit

Sets a new URI for all token types, by relying on the token type ID substitution mechanism defined in the MultiToken standard. See https://eips.ethereum.org/EIPS/eip-1155#metadata.

By this mechanism, any occurrence of the \id\ substring in either the URI or any of the values in the JSON file at said URI will be replaced by clients with the token type ID.

For example, the https://token-cdn-domain/\id\.json URI would be interpreted by clients as https://token-cdn-domain/000000000000000000000000000000000000000000000000000000000004cce0.json for token type ID 0x4cce0.

Requirements:

Contract is initialized.

k=10, rows=39

_mint(
  to: Either<ZswapCoinPublicKey, ContractAddress>,
  id: Uint<128>,
  value: Uint<128>
) → []

circuit

Creates a value amount of tokens of type token_id, and assigns them to to.

Requirements:

Contract is initialized.
to is not the zero address.
to is not a ContractAddress

k=10, rows=912

_unsafeMint(
  to: Either<ZswapCoinPublicKey, ContractAddress>,
  id: Uint<128>,
  value: Uint<128>
) → []

circuit

Unsafe variant of _mint which allows transfers to contract addresses.

Requirements:

Contract is initialized.
to is not the zero address.

k=10, rows=911

_burn(
  from: Either<ZswapCoinPublicKey, ContractAddress>,
  id: Uint<128>,
  value: Uint<128>
) → []

circuit

Destroys a value amount of tokens of type token_id from from.

Requirements:

Contract is initialized.
from is not the zero address.
from must have an id balance of at least value.

k=10, rows=688

_setApprovalForAll(
  owner: Either<ZswapCoinPublicKey, ContractAddress>,
  operator: Either<ZswapCoinPublicKey, ContractAddress>,
  approved: Boolean
) → []

circuit

Enables or disables approval for operator to manage all of the caller’s assets. This circuit does not check for access permissions but can be useful as a building block for more complex contract logic.

Requirements:

Contract is initialized.
operator is not the zero address.

k=10, rows=518

MultiToken API

Core

MultiToken

Ledger

Witnesses

Circuits

On this page