View Source Ethers.Contracts.ERC721 (Ethers v0.0.3)

ERC721 token interface

More info: https://ethereum.org/en/developers/docs/standards/tokens/erc-721/

Link to this section Summary

Functions

Executes approve(address to, uint256 tokenId) on the contract.

Executes balanceOf(address owner) on the contract.

Prepares contract constructor values.

Default address of the contract. Returns nil if not specified.

Executes getApproved(uint256 tokenId) on the contract.

Executes isApprovedForAll(address owner, address operator) on the contract.

Executes name() on the contract.

Same as name/1 but raises Ethers.ExecutionError on errors.

Executes ownerOf(uint256 tokenId) on the contract.

Executes safeTransferFrom(address from, address to, uint256 tokenId) on the contract.

Executes safeTransferFrom(address from, address to, uint256 tokenId, bytes data) on the contract.

Executes setApprovalForAll(address operator, bool _approved) on the contract.

Executes supportsInterface(bytes4 interfaceId) on the contract.

Executes symbol() on the contract.

Executes tokenURI(uint256 tokenId) on the contract.

Executes totalSupply() on the contract.

Executes transferFrom(address from, address to, uint256 tokenId) on the contract.

Link to this section Functions

Link to this function

approve(to, token_id, overrides \\ [])

View Source
@spec approve(Ethers.Types.t_address(), non_neg_integer(), Keyword.t()) ::
  {:ok, [[]]}
  | {:ok, Ethers.Types.t_hash()}
  | {:ok, Ethers.Contract.t_function_output()}
  | {:error, term()}

Executes approve(address to, uint256 tokenId) on the contract.

Default action for this function is :send. To override default action see Execution Options in Ethers.Contract.

parameters

Parameters

  • to: :address
  • tokenId: {:uint, 256}
  • overrides: Overrides and options for the call. See Execution Options in Ethers.Contract.

return-types

Return Types

Link to this function

approve!(to, token_id, overrides \\ [])

View Source

Same as approve/3 but raises Ethers.ExecutionError on errors.

Link to this function

balance_of(owner, overrides \\ [])

View Source
@spec balance_of(Ethers.Types.t_address(), Keyword.t()) ::
  {:ok, [non_neg_integer()]}
  | {:ok, Ethers.Types.t_hash()}
  | {:ok, Ethers.Contract.t_function_output()}
  | {:error, term()}

Executes balanceOf(address owner) on the contract.

Default action for this function is :call. To override default action see Execution Options in Ethers.Contract.

parameters

Parameters

  • owner: :address
  • overrides: Overrides and options for the call. See Execution Options in Ethers.Contract.

return-types

Return Types

  • {:uint, 256}
Link to this function

balance_of!(owner, overrides \\ [])

View Source

Same as balance_of/2 but raises Ethers.ExecutionError on errors.

@spec constructor() :: binary()

Prepares contract constructor values.

To deploy a contracts see Ethers.deploy/3.

parameters

Parameters

@spec default_address() :: Ethers.Types.t_address() | nil

Default address of the contract. Returns nil if not specified.

To specify a default address see Ethers.Contract

Link to this function

get_approved(token_id, overrides \\ [])

View Source
@spec get_approved(non_neg_integer(), Keyword.t()) ::
  {:ok, [Ethers.Types.t_address()]}
  | {:ok, Ethers.Types.t_hash()}
  | {:ok, Ethers.Contract.t_function_output()}
  | {:error, term()}

Executes getApproved(uint256 tokenId) on the contract.

Default action for this function is :call. To override default action see Execution Options in Ethers.Contract.

parameters

Parameters

  • tokenId: {:uint, 256}
  • overrides: Overrides and options for the call. See Execution Options in Ethers.Contract.

return-types

Return Types

  • :address
Link to this function

get_approved!(token_id, overrides \\ [])

View Source

Same as get_approved/2 but raises Ethers.ExecutionError on errors.

Link to this function

is_approved_for_all(owner, operator, overrides \\ [])

View Source
@spec is_approved_for_all(
  Ethers.Types.t_address(),
  Ethers.Types.t_address(),
  Keyword.t()
) ::
  {:ok, [boolean()]}
  | {:ok, Ethers.Types.t_hash()}
  | {:ok, Ethers.Contract.t_function_output()}
  | {:error, term()}

Executes isApprovedForAll(address owner, address operator) on the contract.

Default action for this function is :call. To override default action see Execution Options in Ethers.Contract.

parameters

Parameters

  • owner: :address
  • operator: :address
  • overrides: Overrides and options for the call. See Execution Options in Ethers.Contract.

return-types

Return Types

  • :bool
Link to this function

is_approved_for_all!(owner, operator, overrides \\ [])

View Source

Same as is_approved_for_all/3 but raises Ethers.ExecutionError on errors.

@spec name(Keyword.t()) ::
  {:ok, [String.t()]}
  | {:ok, Ethers.Types.t_hash()}
  | {:ok, Ethers.Contract.t_function_output()}
  | {:error, term()}

Executes name() on the contract.

Default action for this function is :call. To override default action see Execution Options in Ethers.Contract.

parameters

Parameters

  • overrides: Overrides and options for the call. See Execution Options in Ethers.Contract.

return-types

Return Types

  • :string

Same as name/1 but raises Ethers.ExecutionError on errors.

Link to this function

owner_of(token_id, overrides \\ [])

View Source
@spec owner_of(non_neg_integer(), Keyword.t()) ::
  {:ok, [Ethers.Types.t_address()]}
  | {:ok, Ethers.Types.t_hash()}
  | {:ok, Ethers.Contract.t_function_output()}
  | {:error, term()}

Executes ownerOf(uint256 tokenId) on the contract.

Default action for this function is :call. To override default action see Execution Options in Ethers.Contract.

parameters

Parameters

  • tokenId: {:uint, 256}
  • overrides: Overrides and options for the call. See Execution Options in Ethers.Contract.

return-types

Return Types

  • :address
Link to this function

owner_of!(token_id, overrides \\ [])

View Source

Same as owner_of/2 but raises Ethers.ExecutionError on errors.

Link to this function

safe_transfer_from(from, to, token_id, overrides)

View Source
@spec safe_transfer_from(
  Ethers.Types.t_address(),
  Ethers.Types.t_address(),
  non_neg_integer(),
  Keyword.t()
) ::
  {:ok, [[]]}
  | {:ok, Ethers.Types.t_hash()}
  | {:ok, Ethers.Contract.t_function_output()}
  | {:error, term()}

Executes safeTransferFrom(address from, address to, uint256 tokenId) on the contract.

Default action for this function is :send. To override default action see Execution Options in Ethers.Contract.

parameters

Parameters

  • from: :address
  • to: :address
  • tokenId: {:uint, 256}
  • overrides: Overrides and options for the call. See Execution Options in Ethers.Contract.

return-types

Return Types

Link to this function

safe_transfer_from(from, to, token_id, data, overrides)

View Source
@spec safe_transfer_from(
  Ethers.Types.t_address(),
  Ethers.Types.t_address(),
  non_neg_integer(),
  binary(),
  Keyword.t()
) ::
  {:ok, [[]]}
  | {:ok, Ethers.Types.t_hash()}
  | {:ok, Ethers.Contract.t_function_output()}
  | {:error, term()}

Executes safeTransferFrom(address from, address to, uint256 tokenId, bytes data) on the contract.

Default action for this function is :send. To override default action see Execution Options in Ethers.Contract.

parameters

Parameters

  • from: :address
  • to: :address
  • tokenId: {:uint, 256}
  • data: :bytes
  • overrides: Overrides and options for the call. See Execution Options in Ethers.Contract.

return-types

Return Types

Link to this function

safe_transfer_from!(from, to, token_id, overrides)

View Source

Same as safe_transfer_from/4 but raises Ethers.ExecutionError on errors.

Link to this function

safe_transfer_from!(from, to, token_id, data, overrides)

View Source

Same as safe_transfer_from/5 but raises Ethers.ExecutionError on errors.

Link to this function

set_approval_for_all(operator, approved, overrides \\ [])

View Source
@spec set_approval_for_all(Ethers.Types.t_address(), boolean(), Keyword.t()) ::
  {:ok, [[]]}
  | {:ok, Ethers.Types.t_hash()}
  | {:ok, Ethers.Contract.t_function_output()}
  | {:error, term()}

Executes setApprovalForAll(address operator, bool _approved) on the contract.

Default action for this function is :send. To override default action see Execution Options in Ethers.Contract.

parameters

Parameters

  • operator: :address
  • _approved: :bool
  • overrides: Overrides and options for the call. See Execution Options in Ethers.Contract.

return-types

Return Types

Link to this function

set_approval_for_all!(operator, approved, overrides \\ [])

View Source

Same as set_approval_for_all/3 but raises Ethers.ExecutionError on errors.

Link to this function

supports_interface(interface_id, overrides \\ [])

View Source
@spec supports_interface(<<_::32>> | <<_::80>>, Keyword.t()) ::
  {:ok, [boolean()]}
  | {:ok, Ethers.Types.t_hash()}
  | {:ok, Ethers.Contract.t_function_output()}
  | {:error, term()}

Executes supportsInterface(bytes4 interfaceId) on the contract.

Default action for this function is :call. To override default action see Execution Options in Ethers.Contract.

parameters

Parameters

  • interfaceId: {:bytes, 4}
  • overrides: Overrides and options for the call. See Execution Options in Ethers.Contract.

return-types

Return Types

  • :bool
Link to this function

supports_interface!(interface_id, overrides \\ [])

View Source
@spec supports_interface!(<<_::32>> | <<_::80>>, Keyword.t()) ::
  [boolean()]
  | Ethers.Types.t_hash()
  | Ethers.Contract.t_function_output()
  | no_return()

Same as supports_interface/2 but raises Ethers.ExecutionError on errors.

@spec symbol(Keyword.t()) ::
  {:ok, [String.t()]}
  | {:ok, Ethers.Types.t_hash()}
  | {:ok, Ethers.Contract.t_function_output()}
  | {:error, term()}

Executes symbol() on the contract.

Default action for this function is :call. To override default action see Execution Options in Ethers.Contract.

parameters

Parameters

  • overrides: Overrides and options for the call. See Execution Options in Ethers.Contract.

return-types

Return Types

  • :string
Link to this function

symbol!(overrides \\ [])

View Source

Same as symbol/1 but raises Ethers.ExecutionError on errors.

Link to this function

token_uri(token_id, overrides \\ [])

View Source
@spec token_uri(non_neg_integer(), Keyword.t()) ::
  {:ok, [String.t()]}
  | {:ok, Ethers.Types.t_hash()}
  | {:ok, Ethers.Contract.t_function_output()}
  | {:error, term()}

Executes tokenURI(uint256 tokenId) on the contract.

Default action for this function is :call. To override default action see Execution Options in Ethers.Contract.

parameters

Parameters

  • tokenId: {:uint, 256}
  • overrides: Overrides and options for the call. See Execution Options in Ethers.Contract.

return-types

Return Types

  • :string
Link to this function

token_uri!(token_id, overrides \\ [])

View Source

Same as token_uri/2 but raises Ethers.ExecutionError on errors.

Link to this function

total_supply(overrides \\ [])

View Source
@spec total_supply(Keyword.t()) ::
  {:ok, [non_neg_integer()]}
  | {:ok, Ethers.Types.t_hash()}
  | {:ok, Ethers.Contract.t_function_output()}
  | {:error, term()}

Executes totalSupply() on the contract.

Default action for this function is :call. To override default action see Execution Options in Ethers.Contract.

parameters

Parameters

  • overrides: Overrides and options for the call. See Execution Options in Ethers.Contract.

return-types

Return Types

  • {:uint, 256}
Link to this function

total_supply!(overrides \\ [])

View Source

Same as total_supply/1 but raises Ethers.ExecutionError on errors.

Link to this function

transfer_from(from, to, token_id, overrides \\ [])

View Source
@spec transfer_from(
  Ethers.Types.t_address(),
  Ethers.Types.t_address(),
  non_neg_integer(),
  Keyword.t()
) ::
  {:ok, [[]]}
  | {:ok, Ethers.Types.t_hash()}
  | {:ok, Ethers.Contract.t_function_output()}
  | {:error, term()}

Executes transferFrom(address from, address to, uint256 tokenId) on the contract.

Default action for this function is :send. To override default action see Execution Options in Ethers.Contract.

parameters

Parameters

  • from: :address
  • to: :address
  • tokenId: {:uint, 256}
  • overrides: Overrides and options for the call. See Execution Options in Ethers.Contract.

return-types

Return Types

Link to this function

transfer_from!(from, to, token_id, overrides \\ [])

View Source

Same as transfer_from/4 but raises Ethers.ExecutionError on errors.