Crowdfund

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

Response Interface

export interface CrowdfundResponse<T> {
  crowdfund: T;
}

queryCrowdfundAvailableTokens

Queries all available token IDs to be sold from a crowdfund contract.

You can find the contract query here.

export async function queryCrowdfundAvailableTokens(
  contractAddress: string
): Promise<string[]> {
  const resp = await query<
    QueryCrowdfundAvailableTokens,
    QueryCrowdfundAvailableTokensResponse
  >(QUERY_CROWDFUND_AVAILABLE_TOKENS, { contractAddress });

  return resp.crowdfund.availableTokens;
}

Name	Type	Description
contractAddress	string	The contract address of the crowdfund ADO we want to get available tokens for.

QueryCrowdfundAvailableTokens

export interface QueryCrowdfundAvailableTokens extends ContractAddressQuery {}

QueryCrowdfundAvailableTokensResponse

export type QueryCrowdfundAvailableTokensResponse = CrowdfundResponse<{
  availableTokens: string[];
}>;

Name	Type	Description
availableTokens	string[]	A vector of string that contains the token Ids of the tokens/NFTs for sale.

queryCrowdfundConfig

Queries the config of the crowdfund contract.

The contract query can be found here.

export async function queryCrowdfundConfig(
  contractAddress: string
): Promise<CrowdfundConfig> {
  const resp = await query<QueryCrowdfundConfig, QueryCrowdfundConfigResponse>(
    QUERY_CROWDFUND_CONFIG,
    { contractAddress }
  );

  return resp.crowdfund.config;
}

Name	Type	Description
contractAddress	string	The contract address of the crowdfund ADO we want to get the config for.

QueryCrowdfundConfig

export interface QueryCrowdfundConfig extends ContractAddressQuery {}

QueryCrowdfundConfigResponse

export type QueryCrowdfundConfigResponse = CrowdfundResponse<{
  config: CrowdfundConfig;
}>;

CrowdfundConfig

export interface CrowdfundConfig {
  can_mint_after_sale: boolean;
  token_address: string;
}

Name	Type	Description
can_mint_after_sale	boolean	Whether the crowdfund is able to mint new NFTs after the sale has been concluded.
token_address	string	The contract address of the token/NFT contract.

queryCrowdfundTokenAvailable

Queries a crowdfund contract for the availability of a given token ID.

The contract query can be found here.

export async function queryCrowdfundTokenAvailable(
  contractAddress: string,
  tokenId: string
): Promise<boolean> {
  const resp = await query<
    QueryCrowdfundTokenAvailable,
    QueryCrowdfundTokenAvailableResponse
  >(QUERY_CROWDFUND_TOKEN_AVAILABLE, { contractAddress, tokenId });

  return resp.crowdfund.isTokenAvailable;
}

Name	Type	Description
contractAddress	string	The contact address of the crowdfund ADO we want to query.
tokenId	string	The Id of the token/NFT we want to check availability for.

QueryCrowdfundTokenAvailable

export interface QueryCrowdfundConfig extends ContractAddressQuery {}

QueryCrowdfundTokenAvailableResponse

export type QueryCrowdfundTokenAvailableResponse = CrowdfundResponse<{
  isTokenAvailable: boolean;
}>;

Name	Type	Description
isTokenAvailable	boolean	Whether the token is available or not.

queryCrowdfundState

Queries the state of the crowdfund.

The contract query can be found here.

export async function queryCrowdfundState(
  contractAddress: string
): Promise<CrowdfundState> {
  const resp = await query<QueryCrowdfundState, QueryCrowdfundStateResponse>(
    QUERY_CROWDFUND_STATE,
    { contractAddress }
  );

  return resp.crowdfund.state;
}

Name	Type	Description
contractAddress	string	The contract address of the crowfund ADO we want to get the state of.

QueryCrowdfundState

export interface QueryCrowdfundState extends ContractAddressQuery {}

QueryCrowdfundStateResponse

export type QueryCrowdfundStateResponse = CrowdfundResponse<{
  state: CrowdfundState;
}>;

CrowdfundState

export interface CrowdfundState {
  amount_sold: number;
  amount_to_send: number;
  amount_transferred: number;
  expiration: Expiry;
  max_amount_per_wallet: number;
  min_tokens_sold: number;
  price: Coin;
  recipient: Recipient;
}

Name	Type	Description
amount_sold	number	The amount of tokens/NFTs sold.
amount_to_send	number	The amount of funds to send to recipient if sale successful. This already takes into account the royalties and taxes.
amount_transferred	number	Number of tokens transferred to purchasers if sale was successful.
expiration	Expiry	The expiration denoting when the sale ends.
max_amount_per_wallet	number	The max number of tokens allowed per wallet.
min_tokens_sold	number	The minimum number of tokens sold for the sale to go through.
price	Coin	The price of each token.
recipient	Recipient	The recipient of the raised funds if the sale is successful.

Coin

export interface Coin {
    readonly denom: string;
    readonly amount: string;
}

Name	Type	Description
denom	string	The denomination of the coin.
amount	string	The amount of coins.