Global

Type Definitions

multiProviderOptions

Dictionary of options specific to TokenProvider classes representing many smart contract addresses.
Properties:
Name Type Description
contract Object Dictionary of contract scoping options
Properties
Name Type Description
allow Array Set of supported smart contract addresses.
deny Array Set of smart contract addresses to omit from query results.

pageCursor

Pagination metadata used to gather tokens for the subsequent page given a specific tokenQuery. This should be passed back to TokenFetch#fetchTokens for the next page of tokens for the given query.
Type:
  • Object

selectorQuery

Query partial used to constrain token results via field comparison.
Type:
  • Object
Properties:
Name Type Attributes Description
$eq * <optional>
 Property value is equal to the comparison value.
$neq * <optional>
 Property value is not equal to the comparison value.
$in Array <optional>
 Property value is included in comparison value set.
$nin Array <optional>
 Property value is not included in comparison value set.

sortQuery

Query partial used to sort token results. Possible sort values are 'ASC' and 'DESC'.
Type:
  • Object
Properties:
Name Type Attributes Description
date String <optional>
 Sort value used to sort tokens by date minted.

tokenFetchResponse

Dictionary returned by TokenFetcher.fetchTokens.
Properties:
Name Type Description
tokens Array Set of tokenMetadata.
cursor Object Call TokenFetcher#fetchTokens with the same tokenQuery, and a pageCursor as a second argument, to get the next page of results.

tokenMetadata

Normalized token metadata.
Type:
  • Object
Properties:
Name Type Description
contract Object Token's smart contract metadata.
Properties
Name Type Description
address String Smart contract address.
tokenId String Smart contract identifier assigned to the token.
createdAt Date Token's mint date.
description String Token description.
ipfs Object IPFS metadata.
Properties
Name Type Description
artifact String IPFS address of the token's artifact.
display String IPFS address of the token's display image.
issuer Object
Properties
Name Type Description
address String Wallet address of the token issuer.
mimeType String Token file mime type.
name String Token name. {Object} platform Platform metadata. {String} platform.name Name of the platform the token was minted on. {String} platform.url URL of the platform the token was minted on. {Object} platform.issuer Platform derived metadata for the issuer. {String} platform.issuer.url URL of the issuer's platform specific page.
tid String The unified token identifier (TID). Generally this is in the format "contract:contract_token_id".
_metadata Object Additional TokenFetchJS metadata.
Properties
Name Type Description
providerKey String The provider that the token was gathered from.

tokenQuery

Query dictionary used to refine token fetch results.
Type:
  • Object
Properties:
Name Type Attributes Description
after Date <optional>
 Date constraint limiting tokens to after the provided timestamp.
before Date <optional>
 Date constraint limiting tokens to before the provided timestamp.
issuer Object <optional>
 Token creator address selectorQuery.
limit Number <optional>
 Number of results to take. Default is 50.
mimeType Object <optional>
 File mime-type selectorQuery.
orderBy Object <optional>
 Token sort order options sortQuery
owner Object <optional>
 Token holder address selectorQuery.
tid Object <optional>
 Unified Token Identifier (TID) selectorQuery.