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

ERC1155 token interface

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

Link to this section Summary

Functions

Executes balanceOf(address account, uint256 id) on the contract.

Executes balanceOfBatch(address[] accounts, uint256[] ids) on the contract.

Prepares contract constructor values.

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

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

Executes safeBatchTransferFrom(address from, address to, uint256[] ids, uint256[] amounts, bytes data) on the contract.

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

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

Executes supportsInterface(bytes4 interfaceId) on the contract.

Executes uri(uint256 id) on the contract.

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

Link to this section Functions

Link to this function

balance_of(account, id, overrides \\ [])

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

Executes balanceOf(address account, uint256 id) on the contract.

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

parameters

Parameters

  • account: :address
  • id: {:uint, 256}
  • 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!(account, id, overrides \\ [])

View Source

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

Link to this function

balance_of_batch(accounts, ids, overrides \\ [])

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

Executes balanceOfBatch(address[] accounts, uint256[] ids) on the contract.

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

parameters

Parameters

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

return-types

Return Types

  • {:array, {:uint, 256}}
Link to this function

balance_of_batch!(accounts, ids, overrides \\ [])

View Source

Same as balance_of_batch/3 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

is_approved_for_all(account, 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 account, address operator) on the contract.

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

parameters

Parameters

  • account: :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!(account, operator, overrides \\ [])

View Source

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

Link to this function

safe_batch_transfer_from(from, to, ids, amounts, data, overrides \\ [])

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

Executes safeBatchTransferFrom(address from, address to, uint256[] ids, uint256[] amounts, 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
  • ids: {:array, {:uint, 256}}
  • amounts: {:array, {: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_batch_transfer_from!(from, to, ids, amounts, data, overrides \\ [])

View Source

Same as safe_batch_transfer_from/6 but raises Ethers.ExecutionError on errors.

Link to this function

safe_transfer_from(from, to, id, amount, data, overrides \\ [])

View Source
@spec safe_transfer_from(
  Ethers.Types.t_address(),
  Ethers.Types.t_address(),
  non_neg_integer(),
  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 id, uint256 amount, 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
  • id: {:uint, 256}
  • amount: {: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, id, amount, data, overrides \\ [])

View Source

Same as safe_transfer_from/6 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.

Link to this function

uri(id, overrides \\ [])

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

Executes uri(uint256 id) on the contract.

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

parameters

Parameters

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

return-types

Return Types

  • :string
Link to this function

uri!(id, overrides \\ [])

View Source

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