ERC721

Returns the number of NFTs owned by account.

Returns the owner address of token_id.

Transfer ownership of token_id from from to to, checking first that to is aware of the ERC721 protocol to prevent tokens being locked forever. For information regarding how contracts communicate their awareness of the ERC721 protocol, see Receiving Tokens.

Emits a Transfer event.

Transfer ownership of token_id from from to to.

Note that the caller is responsible to confirm that the recipient is capable of receiving ERC721 transfers or else they may be permanently lost. Usage of IERC721::safe_transfer_from prevents loss, though the caller must understand this adds an external call which potentially creates a reentrancy vulnerability.

Emits a Transfer event.

Change or reaffirm the approved address for an NFT.

Emits an Approval event.

Enable or disable approval for operator to manage all of the caller's assets.

Emits an ApprovalForAll event.

Returns the address approved for token_id.

Query if operator is an authorized operator for owner.

Emitted when owner enables approved to manage the token_id token.

Emitted when owner enables or disables operator to manage the token_id token.

Emitted when token_id token is transferred from from to to.

Returns the NFT name.

Returns the NFT ticker symbol.

Returns the Uniform Resource Identifier (URI) for the token_id token. If the URI is not set for token_id, the return value will be an empty ByteArray.

Whenever an IERC721 token_id token is transferred to this non-account contract via IERC721::safe_transfer_from by operator from from, this function is called.

Returns the total amount of tokens stored by the contract.

Returns a token id at a given index of all the tokens stored by the contract. Use along with IERC721Enumerable::total_supply to enumerate all tokens.

Returns the token id owned by owner at a given index of its token list. Use along with IERC721::balance_of to enumerate all of owner's tokens.

Handles an ERC721 safe-transfer callback with mutable contract state. A successful implementation returns the IERC721Receiver interface ID.

Returns the address of the underlying ERC721 token.

Deposits the underlying token_ids and mints matching wrapped tokens to receiver.

Burns the caller's wrapped token_ids and transfers the matching underlying tokens to receiver.

use openzeppelin_token::erc721::ERC721Component::ERC721TokenOwnerTrait;

Defines owner_of(self: @ComponentState, token_id: u256) → ContractAddress for internal ownership resolution.

Custom implementations must preserve the invariant that balance_of(account) equals the number of token IDs resolved to account. Use increase_balance when an extension establishes ownership outside the core ownership map. Avoid external calls from this trait because ownership checks occur throughout state-changing operations and external calls can introduce reentrancy.

use openzeppelin_token::erc721::ERC721OwnerOfDefaultImpl;

Resolves ownership from the core ERC721_owners storage map. It returns the zero address when the token does not exist.

use openzeppelin_token::erc721::ERC721Component::ConsecutiveERC721TokenOwnerImpl;

Resolves ordinary ownership from core storage and unresolved consecutive token IDs from ERC721ConsecutiveComponent, excluding sequential tokens recorded as burned.

use openzeppelin_token::erc721::ERC721Component::ERC721TokenURITrait;

Defines token_uri(self: @ComponentState, token_id: u256) → ByteArray, which is used by ERC721MetadataImpl.

use openzeppelin_token::erc721::ERC721TokenURIDefaultImpl;

Requires token_id to exist. Returns an empty ByteArray when the base URI is empty; otherwise returns the base URI concatenated with the decimal token ID.

Function executed at the beginning of the update function prior to any other logic.

Function executed at the end of the update function.

See IERC721::balance_of.

See IERC721::owner_of.

Requirements:

• token_id exists.

See IERC721::safe_transfer_from.

Requirements:

• Caller is either approved or the token_id owner.
• to is not the zero address.
• from is not the zero address.
• token_id exists.
• to is either an account contract or supports the IERC721Receiver interface.

See IERC721::transfer_from.

Requirements:

• Caller either approved or the token_id owner.
• to is not the zero address.
• from is not the zero address.
• token_id exists.

See IERC721::approve.

Requirements:

• The caller is either an approved operator or the token_id owner.
• to cannot be the token owner or the zero address.
• token_id exists.

See IERC721::set_approval_for_all.

Requirements:

• operator is not the zero address.

See IERC721::get_approved.

Requirements:

• token_id exists.

See IERC721::is_approved_for_all.

See IERC721Metadata::name.

See IERC721Metadata::symbol.

Returns the Uniform Resource Identifier (URI) for the token_id token. If a base URI is set, the resulting URI for each token will be the concatenation of the base URI and the token ID. For example, the base URI https://token-cdn-domain/ would be returned as https://token-cdn-domain/123 for token ID 123.

If the URI is not set for token_id, the return value will be an empty ByteArray.

See ERC721Component::balance_of.

See ERC721Component::owner_of.

See ERC721Component::safe_transfer_from.

See ERC721Component::transfer_from.

See ERC721Component::set_approval_for_all.

See ERC721Component::get_approved.

See ERC721Component::is_approved_for_all.

See ERC721Component::token_uri.

Initializes the contract by setting the token name and symbol. This should be used inside the contract's constructor.

Most ERC721 contracts expose the IERC721Metadata interface which is what this initializer is meant to support. If the contract DOES NOT expose the IERC721Metadata interface, meaning the token does not have a name, symbol, or URI, the contract must instead use initializer_no_metadata in the constructor. Failure to abide by these instructions can lead to unexpected issues especially with UIs.

Initializes the contract with no metadata by registering only the IERC721 interface.

This initializer should ONLY be used during construction in the very specific instance when the contract does NOT expose the IERC721Metadata interface. Initializing a contract with this initializer means that tokens will not have a name, symbol, or URI.

Internal function that returns whether token_id exists.

Tokens start existing when they are minted (mint), and stop existing when they are burned (burn).

Transfers token_id from from to to.

Internal function without access restriction.

This method may lead to the loss of tokens if to is not aware of the ERC721 protocol.

Requirements:

• to is not the zero address.
• from is the token owner.
• token_id exists.

Emits a Transfer event.

Mints token_id and transfers it to to. Internal function without access restriction.

This method may lead to the loss of tokens if to is not aware of the ERC721 protocol.

Requirements:

• to is not the zero address.
• token_id does not exist.

Emits a Transfer event.

Transfers ownership of token_id from from if to is either an account or IERC721Receiver.

data is additional data, it has no specified format and is forwarded in IERC721Receiver::on_erc721_received to to.

This method makes an external call to the recipient contract, which can lead to reentrancy vulnerabilities.

Requirements:

• to cannot be the zero address.
• from must be the token owner.
• token_id exists.
• to is either an account contract or supports the IERC721Receiver interface.

Emits a Transfer event.

Mints token_id if to is either an account or IERC721Receiver.

data is additional data, it has no specified format and is forwarded in IERC721Receiver::on_erc721_received to to.

This method makes an external call to the recipient contract, which can lead to reentrancy vulnerabilities.

Requirements:

• token_id does not exist.
• to is either an account contract or supports the IERC721Receiver interface.

Emits a Transfer event.

Destroys token_id. The approval is cleared when the token is burned.

This internal function does not check if the caller is authorized to operate on the token.

Requirements:

• token_id exists.

Emits a Transfer event.

Increases account's balance without writing token ownership. This unsafe primitive supports extensions whose ERC721TokenOwnerTrait implementation establishes ownership outside the core map.

The caller must keep the balance and ownership invariant consistent. value is limited to u128 to protect the u256 balance from overflow across increments.

Transfers token_id from its current owner to to, or alternatively mints (or burns) if the current owner (or to) is the zero address. Returns the owner of the token_id before the update.

The auth argument is optional. If the value passed is non-zero, then this function will check that auth is either the owner of the token, or approved to operate on the token (by the owner).

Emits a Transfer event.

This function can be extended using the ERC721HooksTrait, to add functionality before and/or after the transfer, mint, or burn.

Internal function that returns the owner address of token_id.

Version of _owner_of that panics if owner is the zero address.

Approve to to operate on token_id

The auth argument is optional. If the value passed is non-zero, then this function will check that auth is either the owner of the token, or approved to operate on all tokens held by this owner.

Emits an Approval event.

Variant of _approve with an optional flag to enable or disable the Approval event. The event is not emitted in the context of transfers.

If auth is zero and emit_event is false, this function will not check that the token exists.

Requirements:

• if auth is non-zero, it must be either the owner of the token or approved to operate on all of its tokens.

May emit an Approval event.

Enables or disables approval for operator to manage all of the owner assets.

Requirements:

• operator is not the zero address.

Emits an Approval event.

Internal function that sets the base_uri.

Base URI for computing token_uri.

If set, the resulting URI for each token will be the concatenation of the base URI and the token ID. Returns an empty ByteArray if not set.

Returns whether spender is allowed to manage owner's tokens, or token_id in particular (ignoring whether it is owned by owner).

This function assumes that owner is the actual owner of token_id and does not verify this assumption.

Checks if spender can operate on token_id, assuming the provided owner is the actual owner.

Requirements:

• owner cannot be the zero address.
• spender cannot be the zero address.
• spender must be the owner of token_id or be approved to operate on it.

This function assumes that owner is the actual owner of token_id and does not verify this assumption.

See IERC721::Approval.

See IERC721::ApprovalForAll.

See IERC721::Transfer.

Returns the IERC721Receiver interface ID.

See ERC721ReceiverComponent::on_erc721_received.

Registers the IERC721Receiver interface ID as supported through introspection.

Returns the total number of tokens tracked by the enumerable extension.

See IERC721Enumerable::token_by_index.

Requirements:

• index is less than the total token supply.

See IERC721Enumerable::token_of_owner_by_index.

Requirements:

• index is less than owner's token balance.
• owner is not the zero address.

Registers the IERC721Enumerable interface ID as supported through introspection.

Updates the ownership and token-tracking data structures.

When a token is minted (or burned), token_id is added to (or removed from) the token-tracking structures.

When a token is transferred, minted, or burned, the ownership-tracking data structures reflect the change in ownership of token_id.

This must be added to the implementing contract's ERC721HooksTrait::before_update hook.

Returns a list of all token ids owned by the specified owner. This function provides a more efficient alternative to calling ERC721::balance_of and iterating through tokens with ERC721Enumerable::token_of_owner_by_index.

Requirements:

• owner is not the zero address.

Adds token to this extension's ownership-tracking data structures.

Adds token to this extension's token-tracking data structures.

Removes a token from this extension's ownership-tracking data structures.

This has 0(1) time complexity but alters the indexed order of owned tokens by swapping token_id and the index thereof with the last token id and the index thereof e.g. removing 1 from [1, 2, 3, 4] results in [4, 2, 3].

Removes token_id from this extension's token-tracking data structures.

This has 0(1) time complexity but alters the indexed order by swapping token_id and the index thereof with the last token id and the index thereof e.g. removing 1 from [1, 2, 3, 4] results in [4, 2, 3].

The default maximum consecutive mint batch size: 5000.

The default first consecutive token ID: 0.

Defines MAX_BATCH_SIZE: u64 and FIRST_CONSECUTIVE_ID: u64. Increasing the maximum above 5000 can exceed the batch sizes supported by off-chain indexers and marketplaces.

Uses DEFAULT_MAX_BATCH_SIZE and DEFAULT_FIRST_CONSECUTIVE_ID.

Ownership checkpoints for consecutive token ranges.

Bitmap recording burned tokens from consecutive ranges.

Returns whether the current entry point selector is constructor.

Returns ImmutableConfig::MAX_BATCH_SIZE.

Returns ImmutableConfig::FIRST_CONSECUTIVE_ID.

Returns the next token ID available for mint_consecutive.

Returns whether token_id from a consecutive range has been burned.

Returns the owner recorded by the first consecutive ownership checkpoint at or after token_id. The token ID must fit in u64, and the stored owner must fit in ContractAddress.

Mints batch_size consecutive token IDs to to and returns the first ID in the batch. A non-zero batch must run during construction, must not exceed max_batch_size, and must have a non-zero recipient.

When batch_size is zero, the function performs no mint and simply returns the next consecutive ID. A non-zero batch emits one ConsecutiveTransfer, increases the recipient balance, and does not emit individual Transfer events or call on_erc721_received.

Enforces the consecutive mint lifecycle. Core ERC721 minting is forbidden during construction; after construction, ordinary core minting is allowed and consecutive minting is not.

Forward the core ERC721HooksTrait::before_update hook to this function.

Marks a token from the consecutive range as burned when an update sends it to the zero address.

Forward the core ERC721HooksTrait::after_update hook to this function.

Emitted for a consecutive token range. from_token_id, from_address, and to_address are event keys.

'ERC721: forbidden batch mint'

'ERC721: max batch exceeded'

'ERC721: forbidden mint'

'ERC721: token id overflow'

'ERC721: address overflow'

Token-specific URI suffixes keyed by token ID.

Requires token_id to exist and resolves its URI as follows:

• With no base URI, returns the stored token-specific suffix, which can be empty.
• With a base URI and a stored suffix, returns their concatenation.
• With a base URI and no stored suffix, returns the base URI concatenated with the decimal token ID.

Stores token_uri for an existing token and emits MetadataUpdate.

Clears the stored token-specific URI when to is the zero address. Forward the core ERC721HooksTrait::after_update hook to this function.

Emitted when the stored URI for token_id changes. token_id is an event key. The event follows ERC-4906.

The configured underlying ERC721 token address.

Returns the address of the underlying ERC721 token.

For each token ID, transfers the underlying token from the caller to the wrapper with transfer_from, then safe-mints the matching wrapped token to receiver. Returns true when every deposit succeeds.

The underlying transfer intentionally does not invoke a receiver callback on the wrapper; the wrapped safe mint can invoke a callback on receiver.

For each token ID, uses the caller as authorization to burn the wrapped token, then safely transfers the matching underlying token to receiver. Returns true when every withdrawal succeeds.

Accepts a safe transfer only from the configured underlying token, safe-mints the matching wrapped token to from, and returns the IERC721Receiver interface ID.

Stores underlying and registers support for IERC721Receiver. The underlying address must be non-zero and must differ from the wrapper address.

Recovers an underlying token transferred to the wrapper without minting its wrapped counterpart. The wrapper must own the underlying token_id; the function safe-mints the corresponding wrapped token to account and returns token_id.

Expose this function with suitable access control when recovery is required.

'Wrapper: invalid underlying'

'Wrapper: unsupported token'

'Wrapper: incorrect owner'

Sets the name and symbol. Mints token_ids tokens to recipient and sets the base_uri. Assigns owner as the contract owner with permissions to upgrade.

Upgrades the contract to a new implementation given by new_class_hash.

Requirements:

• The caller is the contract owner.
• new_class_hash cannot be zero.