CW721

The GraphQL queries that can be performed on the CW721 ADO.

Response Interface

export interface CW721Response<T> {
  cw721: T;
}

queryAllNFTInfo

Queries a CW721 contract for all info for a given token ID.

Contract query can be found here.

export async function queryAllNFTInfo(
  contractAddress: string,
  tokenId: string,
  includeExpired: boolean = false
): Promise<QueryCW721AllNFTInfoResponse["cw721"]["allNftInfo"]> {
  const resp = await query<QueryCW721AllNFTInfo, QueryCW721AllNFTInfoResponse>(
    QUERY_CW721_ALL_NFT_INFO,
    { contractAddress, tokenId, includeExpired }
  );

  return resp.cw721.allNftInfo;
}

Name	Type	Description
contractAddress	string	The contract address of the cw721 contract to query.
tokenId	string	The Id of the token/NFT to query info about.
includeExpired	boolean	Whether to include expired approvals or not. Set to false.

QueryCW721AllNFTInfo

export interface QueryCW721AllNFTInfo extends ContractAddressQuery {
  includeExpired: boolean;
  tokenId: string;
}

QueryCW721AllNFTInfoResponse

export type QueryCW721AllNFTInfoResponse = CW721Response<{
  allNftInfo: {
    access: NFTOwnerInfo;
    info: NFTInfo;
  };
}>;

Name	Type	Description
access	NFTOwnerInfo	Information on the owner and aproved operators of the NFT.
info	NFTInfo	Information on the NFT itself.

NFTOwnerInfo

export interface NFTOwnerInfo {
  approvals: NFTApproval[];
  owner: string;
}

Name	Type	Description
approvals	NFTApproval[]	Vector of the given approvals for the token/NFT.
owner	string	The address of the token/NFT owner.T

NFTApproval

export interface NFTApproval {
  expires: Expiry;
  spender: string;
}

Name	Type	Description
expires	Expiry	Expiry for the approval.
spender	string	The approved address.

NFTInfo

export interface NFTInfo {
  extension: NFTExtension;
  tokenUri: string;
}

Name	Type	Description
extension	NFTExtension	Additioinal information about the NFT.
tokenUri	string	The token URI.

NFTExtension

export interface NFTExtension {
  name: string;
  publisher: string;
  description?: string;
  attributes: NFTAttribute[];
  image: string;
  image_data?: string;
  external_url?: string;
  animation_url?: string;
  youtube_url?: string;
}

Name	Type	Description
name	string	The name of the token.
publisher	string	The original publisher of the token.
description	string	An optional description of the token.
attributes	NFTAttribute[]	The metadata of the token if it exists.
image	string	URL to the token image.
image_data	string	Optional raw SVG image data
external_url	string	Optional URL to the token's source.
animation_url	string	Optional URL to any multi-media attachments.
youtube_url	string	Optional URL to a related Youtube video.

NFTAttribute

export interface NFTAttribute {
  trait_type: string;
  value: string;
  display_type?: string;
}

Name	Type	Description
trait_type	string	The key for the attribute.
value	string	The value for the attribute
display_type?	string	The string used to display the attribute.

queryAllOperators

Queries any operators for a given address.

The contract query can be found here.

export async function queryAllOperators(
  contractAddress: string,
  owner: string,
  includeExpired: boolean = false,
  options?: AndrSearchOptions
): Promise<QueryCW721AllOperatorsResponse["cw721"]["allOperators"]> {
  const resp = await query<
    QueryCW721AllOperators,
    QueryCW721AllOperatorsResponse
  >(QUERY_CW721_ALL_OPERATORS, {
    contractAddress,
    includeExpired,
    owner,
    options,
  });

  return resp.cw721.allOperators;
}

Name	Type	Description
contractAddress	string	The contract address of the cw721 contract to query.
owner	string	The address to check approvals for.
includeExpired	boolean	Whether expired approvals should be shown. Set to false.
options	AndrSearchOptions	Optional set of options to set up the query and pagination.

QueryCW721AllOperators

export interface QueryCW721AllOperators
  extends ContractAddressQuery,
    PaginatedQuery {
  includeExpired: boolean;
  owner: string;
}

QueryCW721AllOperatorsResponse

export type QueryCW721AllOperatorsResponse = CW721Response<{
  allOperators: NFTApproval[];
}>;

Name	Type	Description
allOperators	NFTApproval[]	The operators of the specified owner address.

NFTApproval

export interface NFTApproval {
  expires: Expiry;
  spender: string;
}

Name	Type	Description
expires	Expiry	The expiration of the approval.
spender	string	The address of the approved operator.

queryAllTokens

Queries a CW721 contract for all tokens.

Contract query can be found here.

export async function queryAllTokens(
  contractAddress: string,
  options?: AndrSearchOptions
): Promise<string[]> {
  const resp = await query<QueryCW721AllTokens, QueryCW721AllTokensResponse>(
    QUERY_CW721_ALL_TOKENS,
    { contractAddress, options }
  );

  return resp.cw721.allTokens;
}

Name	Type	Description
contractAddress	string	The contract address of the cw721 contract to query.
options	AndrSearchOptions	Optional set of options to set up the query and pagination.

QueryCW721AllTokens

export interface QueryCW721AllTokens
  extends ContractAddressQuery,
    PaginatedQuery {}

QueryCW721AllTokensResponse

export type QueryCW721AllTokensResponse = CW721Response<{
  allTokens: string[];
}>;

Name	Type	Description
allTokens	string[]	Vector of strings containing the token Ids of all the tokens minted by the contract.

queryApproval

Queries a CW721 contract for whether a given address is an assigned operator for a given token.

Contract query can be found here.

export async function queryApproval(
  contractAddress: string,
  spender: string,
  tokenId: string,
  includeExpired: boolean = false
): Promise<NFTApproval> {
  const resp = await query<QueryCW721Approval, QueryCW721ApprovalResponse>(
    QUERY_CW721_APPROVAL,
    { contractAddress, spender, tokenId, includeExpired }
  );

  return resp.cw721.approval;
}

Name	Type	Description
contractAddress	string	The contract address of the cw721 contract to query.
spender	string	The address to check for the approval.
tokenId	string	The id of the token/NFT to check approval for.
includeExpired	boolean	Whether to include expired an expired approval. Set to false.

QueryCW721Approval

export interface QueryCW721Approval extends ContractAddressQuery {
  includeExpired: boolean;
  spender: string;
  tokenId: string;
}

QueryCW721ApprovalResponse

export type QueryCW721ApprovalResponse = CW721Response<{
  approval: NFTApproval;
}>;

Name	Type	Description
approval	NFTApproval	The approval information if it exists.

queryApprovals

Queries all the approvals a token has.

Contract query can be found here.

export async function queryApprovals(
  contractAddress: string,
  tokenId: string,
  includeExpired: boolean = false
): Promise<QueryCW721ApprovalsResponse["cw721"]["approvals"]> {
  const resp = await query<QueryCW721Approvals, QueryCW721ApprovalsResponse>(
    QUERY_CW721_APPROVALS,
    { contractAddress, tokenId, includeExpired }
  );

  return resp.cw721.approvals;
}

Name	Type	Description
contractAddress	string	The contract address of the cw721 contract to query.
tokenId	string	The id of the token/NFT.
includeExpired	boolean	Whether to include expired approvals. Set to false.

QueryCW721Approvals

export interface QueryCW721Approvals extends ContractAddressQuery {
  includeExpired: boolean;
  tokenId: string;
}

QueryCW721ApprovalsResponse

export type QueryCW721ApprovalsResponse = CW721Response<{
  approvals: NFTApproval[];
}>;

Name	Type	Description
approvals	NFTApproval[]	A vector of NFTApproval containing all the approvals for the specified token.

queyContractInfo

Queries a CW721 contract for its contract info.

Contract query can be found here.

This query also provides the number of tokens which is the NumTokens query.

export async function queryContractInfo(
  contractAddress: string
): Promise<QueryCW721ContractInfoResponse["cw721"]["contractInfo"]> {
  const resp = await query<
    QueryCW721ContractInfo,
    QueryCW721ContractInfoResponse
  >(QUERY_CW721_CONTRACT_INFO, { contractAddress });

  return resp.cw721.contractInfo;
}

Name	Type	Description
contractAddress	string	The contract address of the cw721 contract to query info on.

QueryCW721ContractInfo

export interface QueryCW721ContractInfo extends ContractAddressQuery {}

QueryCW721ContractInfoResponse

export type QueryCW721ContractInfoResponse = CW721Response<{
  contractInfo: NFTContractInfo;
  minter: string;
  numTokens: number;
}>;

Name	Type	Description
contractInfo	NFTContractInfo	Information on the contract.
minter	string	The address of the minter.
numTokens	string	The number of tokens minted by the contract.

NFTContractInfo

export interface NFTContractInfo {
  name: string;
  symbol: string;
}

Name	Type	Description
name	string	The name of the NFT collection.
symbol	string	The symbol of the NFT collection.

queryIsArchived

Queries a CW721 contract whether a given token ID is archived.

Contract query can be found here.

export async function queryIsArchived(
  contractAddress: string,
  tokenId: string
): Promise<boolean> {
  const resp = await query<QueryCW721IsArchived, QueryCW721IsArchivedResponse>(
    QUERY_CW721_IS_ARCHIVED,
    { contractAddress, tokenId }
  );

  return resp.cw721.isArchived;
}

Name	Type	Description
contractAddress	string	The contract address of the cw721 contract that has minted the token to query.
tokenId	string	The Id of the token/NFT.

QueryCW721IsArchived

export interface QueryCW721IsArchived extends ContractAddressQuery {
  tokenId: string;
}

QueryCW721IsArchivedResponse

export type QueryCW721IsArchivedResponse = CW721Response<{
  isArchived: boolean;
}>;

Name	Type	Description
isArchived	boolean	Whether the token is achived or not.

queryNFTInfo

Queries a CW721 contract for a given token IDs NFT info.

Contract query can be found here.

export async function queryNFTInfo(
  contractAddress: string,
  tokenId: string
): Promise<QueryCW721NftInfoResponse["cw721"]["nftInfo"]> {
  const resp = await query<QueryCW721NFTInfo, QueryCW721NftInfoResponse>(
    QUERY_CW721_NFT_INFO,
    { contractAddress, tokenId }
  );

  return resp.cw721.nftInfo;
}

Name	Type	Description
contractAddress	string	The contract address of the cw721 contract that has minted the token to query.
tokenId	string	The Id of the token/NFT.

QueryCW721NFTInfo

export interface QueryCW721NFTInfo extends ContractAddressQuery {
  tokenId: string;
}

QueryCW721NFTInfoResponse

export type QueryCW721NftInfoResponse = CW721Response<{
  nftInfo: NFTInfo;
}>;

Name	Type	Description
nftInfo	NFTInfo	Information on the specified token/NFT.

queryOwnerOf

Queries a CW721 contract for the owner of a given token ID.

Contract query can be found here.

export async function queryOwnerOf(
  contractAddress: string,
  tokenId: string
): Promise<string> {
  const resp = await query<QueryCW721OwnerOf, QueryCW721OwnerOfResponse>(
    QUERY_CW721_OWNER_OF,
    { contractAddress, tokenId }
  );

  return resp.cw721.ownerOf.owner;
}

Name	Type	Description
contractAddress	string	The contract address of the cw721 contract that has minted the token to query.
tokenId	string	The Id of the token/NFT.

QueryCW721OwnerOf

export interface QueryCW721OwnerOf extends ContractAddressQuery {
  tokenId: string;
}

QueryCW721OwnerOfResponse

export type QueryCW721OwnerOfResponse = CW721Response<{
  ownerOf: { owner: string };
}>;

Name	Type	Description
owner	string	The address of the token/NFT owner.

queryTokens

Queries a CW721 contract for all tokens owned by a given address.

Contract query can be found here.

export async function queryTokens(
  contractAddress: string,
  owner: string,
  options?: AndrSearchOptions
): Promise<QueryCW721TokensResponse["cw721"]["tokens"]> {
  const resp = await query<QueryCW721Tokens, QueryCW721TokensResponse>(
    QUERY_CW721_TOKENS,
    { contractAddress, owner, options }
  );

  return resp.cw721.tokens;
}

Name	Type	Description
contractAddress	string	The contract address of the cw721 contract to query.
owner	string	The address to query the tokens for.
options?	AndrSearchOptions	Optional additional options for the query. Mostly used for pagination.

QueryCW721Tokens

export interface QueryCW721Tokens extends ContractAddressQuery, PaginatedQuery {
  owner: string;
}

QueryCW721TokensResponse

export type QueryCW721TokensResponse = CW721Response<{
  tokens: string[];
}>;

Name	Type	Description
tokens	string[]	A vector of string containing the token Ids that the specified owner owns.

queryTransferAgreement

Queries a CW721 contract for the transfer agreement for a given token ID.

Contract query can be found here.

export async function queryTransferAgreement(
  contractAddress: string,
  tokenId: string
): Promise<TransferAgreement> {
  const resp = await query<
    QueryCW721TransferAgreement,
    QueryCW721TransferAgreementResponse
  >(QUERY_CW721_TRANSFER_AGREEMENT, { contractAddress, tokenId });

  return resp.transferAgreement;
}

Name	Type	Description
contractAddress	string	The contract address of the cw721 contract to query.
tokenId	string	The Id of the token/NFT.

QueryCW721TransferAgreement

export interface QueryCW721TransferAgreement extends ContractAddressQuery {
  tokenId: string;
}

QueryCW721TransferAgreementResponse

export type QueryCW721TransferAgreementResponse = CW721Response<{
  transferAgreement: TransferAgreement;
}>;

Returns a TransferAgreement if found.

TransferAgreement

export interface TransferAgreement {
  tokenId: string;
  agreement: Agreement;
}

Name	Type	Description
tokenId	string	The Id of the token/NFT.
agreement	Agreement	Information on the transfer agreement.

Agreement

export interface Agreement {
  amount: { raw: Coin };
  purchaser: string;
}

Name	Type	Description
raw	Coin	The amount required for the purchaser to transfer ownership of the token.
purchaser	string	The address of the token purchaser in the agreement.