Class GenericMRC721Royalty

abi

address

bytecode

provider

approve

• approve(to, tokenId): Promise<Transaction>

• Gives permission to to to transfer tokenId token to another account. The approval is cleared when the token is transferred.

  Only a single account can be approved at a time, so approving the zero address clears previous approvals.

  Requirements:

  • The caller must own the token or be an approved operator.
  • tokenId must exist.

  Emits an Approval event.

  Parameters

  • to: string
  • tokenId: bigint

  Returns Promise<Transaction>

balance

• balance(): Promise<bigint>

• Get this contract balance

  Returns Promise<bigint>

  the satoshi balance of this contract

balanceOf

• balanceOf(owner): Promise<bigint>

• Returns the number of tokens in owner's account.

  Parameters

  • owner: string

  Returns Promise<bigint>

call

• call(method, args): Promise<undefined | Result>

• Perform calltocontract

  Parameters

  • method: string

    The contract method to call
  • args: any[]

    The arguments

  Returns Promise<undefined | Result>

  see Result

controllers

• controllers(operator): Promise<boolean>

• Checks if a given address is a controller

  Parameters

  • operator: string

  Returns Promise<boolean>

  if the operator is a controller

getApproved

• getApproved(tokenId): Promise<string>

• Returns the account approved for tokenId token.

  Requirements:

  • tokenId must exist.

  Parameters

  • tokenId: bigint

  Returns Promise<string>

getEventLogs

• getEventLogs(): Promise<EventLogs>

• Get receipts from a transaction

  Returns Promise<EventLogs>

  an EventLogs object

isApprovedForAll

• isApprovedForAll(owner, operator): Promise<boolean>

• Returns if the operator is allowed to manage all of the assets of owner.

  See setApprovalForAll

  Parameters

  • owner: string
  • operator: string

  Returns Promise<boolean>

mintUnique

• mintUnique(receiver, tokenId): Promise<Transaction>

• Mint a new MRC721 token

  Parameters

  • receiver: string

    the EVM style address of the receiver
  • tokenId: bigint

    the uint256 id for the token

  Returns Promise<Transaction>

  an array of TransactionReceipt objects

mintUniqueBatch

• mintUniqueBatch(receiver, tokenId, batchSize, gasLimit?): Promise<Transaction>

• Batch mint new MRC721 tokens

  Parameters

  • receiver: string

    the EVM style address of the receiver
  • tokenId: bigint

    the uint256 id for the token
  • batchSize: bigint

    the uint8 size of the batch
  • OptionalgasLimit: number

  Returns Promise<Transaction>

  an array of TransactionReceipt objects

name

• name(): Promise<string>

• Returns the token collection name.

  Returns Promise<string>

owner

• owner(): Promise<string>

• Get the contract owner

  Returns Promise<string>

  the EVM style address of the owner of this contract

ownerOf

• ownerOf(tokenId): Promise<string>

• Returns the owner of the tokenId token.

  Requirements:

  • tokenId must exist.

  Parameters

  • tokenId: bigint

  Returns Promise<string>

renounceOwnership

• renounceOwnership(): Promise<Transaction>

• Renounce ownership of this contract

  Returns Promise<Transaction>

  an array of TransactionReceipt objects

safeTransferFrom

• safeTransferFrom(from, to, tokenId): Promise<Transaction>

• Safely transfers tokenId token from from to to, checking first that contract recipients are aware of the ERC721 protocol to prevent tokens from being forever locked.

  Requirements:

  • from cannot be the zero address.
  • to cannot be the zero address.
  • tokenId token must exist and be owned by from.
  • If the caller is not from, it must be have been allowed to move this token by either approve or setApprovalForAll.
  • If to refers to a smart contract, it must implement IERC721Receiver-onERC721Received, which is called upon a safe transfer.

  Emits a Transfer event.

  Parameters

  • from: string
  • to: string
  • tokenId: bigint

  Returns Promise<Transaction>

safeTransferFromData

• safeTransferFromData(from, to, tokenId, data): Promise<Transaction>

• Safely transfers tokenId token from from to to.

  Requirements:

  • from cannot be the zero address.
  • to cannot be the zero address.
  • tokenId token must exist and be owned by from.
  • If the caller is not from, it must be approved to move this token by either approve or setApprovalForAll.
  • If to refers to a smart contract, it must implement IERC721Receiver-onERC721Received, which is called upon a safe transfer.

  Emits a Transfer event.

  Parameters

  • from: string
  • to: string
  • tokenId: bigint
  • data: string

  Returns Promise<Transaction>

send

• send(method, args, value?, gasLimit?, gasPrice?): Promise<{
      hash160: string;
      sender: string;
      txid: string;
  }>

• Perform sendtocontract

  Parameters

  • method: string

    The contract method to send to
  • args: any[]

    The arguments to use
  • value: undefined | string = '0'

    The amount to send to the contract
  • gasLimit: undefined | number = 250000

    The amount of gas units allowed
  • gasPrice: undefined | number = 5000

    The satoshi price per gas

  Returns Promise<{
      hash160: string;
      sender: string;
      txid: string;
  }>

  see Result

setApprovalForAll

• setApprovalForAll(operator, approved): Promise<Transaction>

• Approve or remove operator as an operator for the caller. Operators can call transferFrom or safeTransferFrom for any token owned by the caller.

  Requirements:

  • The operator cannot be the caller.

  Emits an ApprovalForAll event.

  Parameters

  • operator: string
  • approved: boolean

  Returns Promise<Transaction>

setBaseURI

• setBaseURI(uri): Promise<Transaction>

• Set the baseURI for the tokens

  Parameters

  • uri: string

    the new baseURI for the tokens

  Returns Promise<Transaction>

  an array of TransactionReceipt objects

setController

• setController(operator, controller): Promise<Transaction>

• Allow or disallow a controller of this contract, controllers are able to call the mint function.

  Parameters

  • operator: string
  • controller: boolean

  Returns Promise<Transaction>

  an array of TransactionReceipt objects

supportsInterface

• supportsInterface(interfaceId): Promise<boolean>

• Returns true if this contract implements the interface defined by interfaceId. See the corresponding https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[EIP section] to learn more about how these ids are created.

  This function call must use less than 30 000 gas. Defined in EIP181.

  Parameters

  • interfaceId: string

    The MNS node to query.

  Returns Promise<boolean>

  if the interface is supported

symbol

• symbol(): Promise<string>

• Returns the token collection symbol.

  Returns Promise<string>

tokenByIndex

• tokenByIndex(index): Promise<string>

• Returns a token ID at a given index of all the tokens stored by the contract. Use along with totalSupply to enumerate all tokens.

  Parameters

  • index: bigint

  Returns Promise<string>

tokenOfOwnerByIndex

• tokenOfOwnerByIndex(owner, index): Promise<string>

• Returns a token ID owned by owner at a given index of its token list. Use along with balanceOf to enumerate all of owner's tokens.

  Parameters

  • owner: string
  • index: bigint

  Returns Promise<string>

tokenURI

• tokenURI(tokenId): Promise<string>

• Returns the Uniform Resource Identifier (URI) for tokenId token.

  Parameters

  • tokenId: bigint

  Returns Promise<string>

totalSupply

• totalSupply(): Promise<bigint>

• Returns the total amount of tokens stored by the contract.

  Returns Promise<bigint>

transferFrom

• transferFrom(from, to, tokenId): Promise<Transaction>

• Transfers tokenId token from from to to.

  WARNING: Usage of this method is discouraged, use safeTransferFrom whenever possible.

  Requirements:

  • from cannot be the zero address.
  • to cannot be the zero address.
  • tokenId token must be owned by from.
  • If the caller is not from, it must be approved to move this token by either approve or setApprovalForAll.

  Emits a Transfer event.

  Parameters

  • from: string
  • to: string
  • tokenId: bigint

  Returns Promise<Transaction>

transferOwnership

• transferOwnership(address): Promise<Transaction>

• Transfer ownership of this contract

  Parameters

  • address: string

    the EVM adddress of the receiver

  Returns Promise<Transaction>

  an array of TransactionReceipt objects