AavegotchiFacet

PetOperatorApprovalForAll

event PetOperatorApprovalForAll(address _owner, address _operator, bool _approved)

totalSupply

function totalSupply() external view returns (uint256 totalSupply_)

Query the universal totalSupply of all NFTs ever minted

Return Values

NameTypeDescription

totalSupply_

uint256

the number of all NFTs that have been minted

balanceOf

function balanceOf(address _owner) external view returns (uint256 balance_)

Count all NFTs assigned to an owner

NFTs assigned to the zero address are considered invalid, and this. function throws for queries about the zero address.

Parameters

NameTypeDescription

_owner

address

An address for whom to query the balance

Return Values

NameTypeDescription

balance_

uint256

The number of NFTs owned by _owner, possibly zero

getAavegotchi

function getAavegotchi(uint256 _tokenId) external view returns (struct AavegotchiInfo aavegotchiInfo_)

Query all details relating to an NFT

Parameters

NameTypeDescription

_tokenId

uint256

the identifier of the NFT to query

Return Values

NameTypeDescription

aavegotchiInfo_

struct AavegotchiInfo

a struct containing all details about

aavegotchiClaimTime

function aavegotchiClaimTime(uint256 _tokenId) external view returns (uint256 claimTime_)

returns the time an NFT was claimed

will return 0 if the NFT is still an unclaimed portal

Parameters

NameTypeDescription

_tokenId

uint256

the identifier of the NFT

Return Values

NameTypeDescription

claimTime_

uint256

the time the NFT was claimed

tokenByIndex

function tokenByIndex(uint256 _index) external view returns (uint256 tokenId_)

tokenOfOwnerByIndex

function tokenOfOwnerByIndex(address _owner, uint256 _index) external view returns (uint256 tokenId_)

tokenIdsOfOwner

function tokenIdsOfOwner(address _owner) external view returns (uint32[] tokenIds_)

Get all the Ids of NFTs owned by an address

Parameters

NameTypeDescription

_owner

address

The address to check for the NFTs

Return Values

NameTypeDescription

tokenIds_

uint32[]

an array of unsigned integers,each representing the tokenId of each NFT

allAavegotchisOfOwner

function allAavegotchisOfOwner(address _owner) external view returns (struct AavegotchiInfo[] aavegotchiInfos_)

Get all details about all the NFTs owned by an address

Parameters

NameTypeDescription

_owner

address

The address to check for the NFTs

Return Values

NameTypeDescription

aavegotchiInfos_

struct AavegotchiInfo[]

an array of structs,where each struct contains all the details of each NFT

batchOwnerOf

function batchOwnerOf(uint256[] _tokenIds) external view returns (address[] owners_)

ownerOf

function ownerOf(uint256 _tokenId) external view returns (address owner_)

Find the owner of an NFT

NFTs assigned to zero address are considered invalid, and queries about them do throw.

Parameters

NameTypeDescription

_tokenId

uint256

The identifier for an NFT

Return Values

NameTypeDescription

owner_

address

The address of the owner of the NFT

getApproved

function getApproved(uint256 _tokenId) external view returns (address approved_)

Get the approved address for a single NFT

Throws if _tokenId is not a valid NFT.

Parameters

NameTypeDescription

_tokenId

uint256

The NFT to find the approved address for

Return Values

NameTypeDescription

approved_

address

The approved address for this NFT, or the zero address if there is none

isApprovedForAll

function isApprovedForAll(address _owner, address _operator) external view returns (bool approved_)

Query if an address is an authorized operator for another address

Parameters

NameTypeDescription

_owner

address

The address that owns the NFTs

_operator

address

The address that acts on behalf of the owner

Return Values

NameTypeDescription

approved_

bool

True if _operator is an approved operator for _owner, false otherwise

isPetOperatorForAll

function isPetOperatorForAll(address _owner, address _operator) external view returns (bool approved_)

Check if an address _operator is an authorized pet operator for another address _owner

Parameters

NameTypeDescription

_owner

address

address of the lender of the NFTs

_operator

address

address that acts pets the gotchis on behalf of the owner

Return Values

NameTypeDescription

approved_

bool

true if operator is an approved pet operator, False if otherwise

safeTransferFrom

function safeTransferFrom(address _from, address _to, uint256 _tokenId, bytes _data) external

Transfers the ownership of an NFT from one address to another address

Throws unless LibMeta.msgSender() is the current owner, an authorized operator, or the approved address for this NFT. Throws if _from is not the current owner. Throws if _to is the zero address. Throws if _tokenId is not a valid NFT. When transfer is complete, this function checks if _to is a smart contract (code size > 0). If so, it calls onERC721Received on _to and throws if the return value is not bytes4(keccak256("onERC721Received(address,address,uint256,bytes)")).

Parameters

NameTypeDescription

_from

address

The current owner of the NFT

_to

address

The new owner

_tokenId

uint256

The NFT to transfer

_data

bytes

Additional data with no specified format, sent in call to _to

safeBatchTransferFrom

function safeBatchTransferFrom(address _from, address _to, uint256[] _tokenIds, bytes _data) external

Throws unless LibMeta.msgSender() is the current owner, an authorized operator, or the approved address of each of the NFTs in _tokenIds. Throws if _from is not the current owner. Throws if _to is the zero address. Throws if one of the NFTs in _tokenIds is not a valid NFT. When transfer is complete, this function checks if _to is a smart contract (code size > 0). If so, it calls onERC721Received on _to and throws if the return value is not bytes4(keccak256("onERC721Received(address,address,uint256,bytes)")).

Parameters

NameTypeDescription

_from

address

The current owner of the NFTs

_to

address

The new owner

_tokenIds

uint256[]

An array containing the identifiers of the NFTs to transfer

_data

bytes

Additional data with no specified format, sent in call to _to

safeTransferFrom

function safeTransferFrom(address _from, address _to, uint256 _tokenId) external

Transfers the ownership of an NFT from one address to another address

This works identically to the other function with an extra data parameter, except this function just sets data to "".

Parameters

NameTypeDescription

_from

address

The current owner of the NFT

_to

address

The new owner

_tokenId

uint256

The NFT to transfer

transferFrom

function transferFrom(address _from, address _to, uint256 _tokenId) external

Transfer ownership of an NFT -- THE CALLER IS RESPONSIBLE TO CONFIRM THAT _to IS CAPABLE OF RECEIVING NFTS OR ELSE THEY MAY BE PERMANENTLY LOST

Throws unless LibMeta.msgSender() is the current owner, an authorized operator, or the approved address for this NFT. Throws if _from is not the current owner. Throws if _to is the zero address. Throws if _tokenId is not a valid NFT.

Parameters

NameTypeDescription

_from

address

The current owner of the NFT

_to

address

The new owner

_tokenId

uint256

The NFT to transfer

approve

function approve(address _approved, uint256 _tokenId) external

Change or reaffirm the approved address for an NFT

The zero address indicates there is no approved address. Throws unless LibMeta.msgSender() is the current NFT owner, or an authorized operator of the current owner.

Parameters

NameTypeDescription

_approved

address

The new approved NFT controller

_tokenId

uint256

The NFT to approve

setApprovalForAll

function setApprovalForAll(address _operator, bool _approved) external

Enable or disable approval for a third party ("operator") to manage all of LibMeta.msgSender()'s assets

Emits the ApprovalForAll event. The contract MUST allow multiple operators per owner.

Parameters

NameTypeDescription

_operator

address

Address to add to the set of authorized operators

_approved

bool

True if the operator is approved, false to revoke approval

setPetOperatorForAll

function setPetOperatorForAll(address _operator, bool _approved) external

Enable or disable approval for a third party("operator") to help pet LibMeta.msgSender()'s gotchis

Emits the PetOperatorApprovalForAll event

Parameters

NameTypeDescription

_operator

address

Address to disable/enable as a pet operator

_approved

bool

True if operator is approved,False if approval is revoked

name

function name() external view returns (string)

Return the universal name of the NFT

symbol

function symbol() external view returns (string)

An abbreviated name for NFTs in this contract

tokenURI

function tokenURI(uint256 _tokenId) external pure returns (string)

A distinct Uniform Resource Identifier (URI) for a given asset.

Throws if _tokenId is not a valid NFT. URIs are defined in RFC 3986. The URI may point to a JSON file that conforms to the "ERC721 Metadata JSON Schema".