ShadeJS

Appearance

Snip20 Token Examples ​

This page demonstrates how to query Snip20 token contracts

Token Info ​

input

ts
async function querySnip20TokenInfo({
  snip20ContractAddress,
  snip20CodeHash,
  lcdEndpoint,
  chainId,
}:{
  snip20ContractAddress: string,
  snip20CodeHash?: string,
  lcdEndpoint?: string,
  chainId?: string,
}): Promise<TokenInfo>
async function querySnip20TokenInfo({
  snip20ContractAddress,
  snip20CodeHash,
  lcdEndpoint,
  chainId,
}:{
  snip20ContractAddress: string,
  snip20CodeHash?: string,
  lcdEndpoint?: string,
  chainId?: string,
}): Promise<TokenInfo>

output

ts
type TokenInfo = {
  name: string,
  symbol: string,
  decimals: number,
  totalSupply: string,
}
type TokenInfo = {
  name: string,
  symbol: string,
  decimals: number,
  totalSupply: string,
}

example use

ts
const output = await querySnip20TokenInfo = ({
  contractAddress: 'secret1fl449muk5yq8dlad7a22nje4p5d2pnsgymhjfd',
  codeHash: '638a3e1d50175fbcb8373cf801565283e3eb23d88a9b7b7f99fcc5eb1e6b561e' 
})
console.log(output)
const output = await querySnip20TokenInfo = ({
  contractAddress: 'secret1fl449muk5yq8dlad7a22nje4p5d2pnsgymhjfd',
  codeHash: '638a3e1d50175fbcb8373cf801565283e3eb23d88a9b7b7f99fcc5eb1e6b561e' 
})
console.log(output)

console

md
{
  name: 'Silk',
  symbol: 'SILK',
  decimals: 6,
  totalSupply: '2247680264140',
};
{
  name: 'Silk',
  symbol: 'SILK',
  decimals: 6,
  totalSupply: '2247680264140',
};

Batch Tokens Info ​

input

ts
function batchQuerySnip20TokensInfo({
  queryRouterContractAddress,
  queryRouterCodeHash,
  lcdEndpoint,
  chainId,
  tokenContracts,
}:{
  queryRouterContractAddress: string,
  queryRouterCodeHash?: string,
  lcdEndpoint?: string,
  chainId?: string,
  tokenContracts: Contract[]
})
function batchQuerySnip20TokensInfo({
  queryRouterContractAddress,
  queryRouterCodeHash,
  lcdEndpoint,
  chainId,
  tokenContracts,
}:{
  queryRouterContractAddress: string,
  queryRouterCodeHash?: string,
  lcdEndpoint?: string,
  chainId?: string,
  tokenContracts: Contract[]
})

output

ts
type BatchTokensInfo = BatchTokensInfoItem[]

type TokenInfo = {
  name: string,
  symbol: string,
  decimals: number,
  totalSupply: string,
}

type BatchTokensInfoItem = {
  tokenContractAddress: string,
  tokenInfo: TokenInfo,
}
type BatchTokensInfo = BatchTokensInfoItem[]

type TokenInfo = {
  name: string,
  symbol: string,
  decimals: number,
  totalSupply: string,
}

type BatchTokensInfoItem = {
  tokenContractAddress: string,
  tokenInfo: TokenInfo,
}

example use

ts
const output = await batchQuerySnip20TokensInfo = ({
  queryRouterContractAddress: '[QUERY_ROUTER_CONTRACT_ADDRESS]',
  queryRouterCodeHash: '[QUERY_ROUTER_CODE_HASH]',
  tokenContracts: [{
    address: '[TOKEN_1_ADDRESS]',
    codeHash: '[TOKEN_1_CODE_HASH]',
  },
  {
    address: '[TOKEN_2_ADDRESS]',
    codeHash: '[TOKEN_2_CODE_HASH]',
  }]
})
console.log(output)
const output = await batchQuerySnip20TokensInfo = ({
  queryRouterContractAddress: '[QUERY_ROUTER_CONTRACT_ADDRESS]',
  queryRouterCodeHash: '[QUERY_ROUTER_CODE_HASH]',
  tokenContracts: [{
    address: '[TOKEN_1_ADDRESS]',
    codeHash: '[TOKEN_1_CODE_HASH]',
  },
  {
    address: '[TOKEN_2_ADDRESS]',
    codeHash: '[TOKEN_2_CODE_HASH]',
  }]
})
console.log(output)

console

md
[
  {
    tokenContractAddress: 'secret153wu605vvp934xhd4k9dtd640zsep5jkesstdm',
    tokenInfo: {
      name: 'Shade',
      symbol: 'SHD',
      decimals: 8,
      totalSupply: '248115955993665',
    },
  },
  {
    tokenContractAddress: 'secret1fl449muk5yq8dlad7a22nje4p5d2pnsgymhjfd',
    tokenInfo: {
      name: 'Silk',
      symbol: 'SILK',
      decimals: 6,
      totalSupply: '3688426236358',
    },
  },
];
[
  {
    tokenContractAddress: 'secret153wu605vvp934xhd4k9dtd640zsep5jkesstdm',
    tokenInfo: {
      name: 'Shade',
      symbol: 'SHD',
      decimals: 8,
      totalSupply: '248115955993665',
    },
  },
  {
    tokenContractAddress: 'secret1fl449muk5yq8dlad7a22nje4p5d2pnsgymhjfd',
    tokenInfo: {
      name: 'Silk',
      symbol: 'SILK',
      decimals: 6,
      totalSupply: '3688426236358',
    },
  },
];

Get Balance ​

input

ts
async function querySnip20Balance({
  snip20ContractAddress,
  snip20CodeHash,
  userAddress,
  viewingKey,
  lcdEndpoint,
  chainId,
}:{
  snip20ContractAddress: string,
  snip20CodeHash?: string,
  userAddress: string,
  viewingKey: string,
  lcdEndpoint?: string,
  chainId?: string,
}): Promise<string>
async function querySnip20Balance({
  snip20ContractAddress,
  snip20CodeHash,
  userAddress,
  viewingKey,
  lcdEndpoint,
  chainId,
}:{
  snip20ContractAddress: string,
  snip20CodeHash?: string,
  userAddress: string,
  viewingKey: string,
  lcdEndpoint?: string,
  chainId?: string,
}): Promise<string>

output

ts
type string // returned as a uDenom
type string // returned as a uDenom

example use

ts
const output = await querySnip20Balance = ({
  contractAddress: 'secret153wu605vvp934xhd4k9dtd640zsep5jkesstdm',
  userAddress: '[USER_SECRET_NETWORK_ADDRESS]',
  viewingKey: 'VIEWING_KEY'
})
console.log(output)
const output = await querySnip20Balance = ({
  contractAddress: 'secret153wu605vvp934xhd4k9dtd640zsep5jkesstdm',
  userAddress: '[USER_SECRET_NETWORK_ADDRESS]',
  viewingKey: 'VIEWING_KEY'
})
console.log(output)

console

md
'123'
'123'

Get Transaction History ​

input

ts
async function querySnip20TransactionHistory({
  queryRouterContractAddress,
  queryRouterCodeHash,
  lcdEndpoint,
  chainId,
  snip20ContractAddress,
  snip20CodeHash,
  ownerAddress,
  viewingKey,
  page,
  pageSize,
  shouldFilterDecoys,
  minBlockHeightValidationOptions,
}:{
  queryRouterContractAddress: string,
  queryRouterCodeHash?: string,
  lcdEndpoint?: string,
  chainId?: string,
  snip20ContractAddress: string,
  snip20CodeHash: string,
  ownerAddress: string,
  viewingKey: string,
  page: number,
  pageSize: number,
  shouldFilterDecoys?: boolean,
  minBlockHeightValidationOptions?: MinBlockHeightValidationOptions,
}): Promise<TransactionHistory>
async function querySnip20TransactionHistory({
  queryRouterContractAddress,
  queryRouterCodeHash,
  lcdEndpoint,
  chainId,
  snip20ContractAddress,
  snip20CodeHash,
  ownerAddress,
  viewingKey,
  page,
  pageSize,
  shouldFilterDecoys,
  minBlockHeightValidationOptions,
}:{
  queryRouterContractAddress: string,
  queryRouterCodeHash?: string,
  lcdEndpoint?: string,
  chainId?: string,
  snip20ContractAddress: string,
  snip20CodeHash: string,
  ownerAddress: string,
  viewingKey: string,
  page: number,
  pageSize: number,
  shouldFilterDecoys?: boolean,
  minBlockHeightValidationOptions?: MinBlockHeightValidationOptions,
}): Promise<TransactionHistory>

output

ts
type Snip20Tx = {
  id: number;
  action: TxAction; // see secretJS types
  denom: string,
  amount: string,
  memo?: string;
  blockTime?: number;
  blockHeight?: number;
}

type TransactionHistory = {
  txs: Snip20Tx[],
  tokenAddress: string,
  totalTransactions?: number,
  blockHeight: number,
}
type Snip20Tx = {
  id: number;
  action: TxAction; // see secretJS types
  denom: string,
  amount: string,
  memo?: string;
  blockTime?: number;
  blockHeight?: number;
}

type TransactionHistory = {
  txs: Snip20Tx[],
  tokenAddress: string,
  totalTransactions?: number,
  blockHeight: number,
}

Get Transfer History ​

This query is used for legacy snip20s that do not support the newer transaction history query.

input

ts
async function querySnip20TransferHistory({
  queryRouterContractAddress,
  queryRouterCodeHash,
  lcdEndpoint,
  chainId,
  snip20ContractAddress,
  snip20CodeHash,
  ownerAddress,
  viewingKey,
  page,
  pageSize,
  minBlockHeightValidationOptions,
}:{
  queryRouterContractAddress: string,
  queryRouterCodeHash?: string,
  lcdEndpoint?: string,
  chainId?: string,
  snip20ContractAddress: string,
  snip20CodeHash: string,
  ownerAddress: string,
  viewingKey: string,
  page: number,
  pageSize: number,
  minBlockHeightValidationOptions?: MinBlockHeightValidationOptions,
}): Promise<TransactionHistory>
async function querySnip20TransferHistory({
  queryRouterContractAddress,
  queryRouterCodeHash,
  lcdEndpoint,
  chainId,
  snip20ContractAddress,
  snip20CodeHash,
  ownerAddress,
  viewingKey,
  page,
  pageSize,
  minBlockHeightValidationOptions,
}:{
  queryRouterContractAddress: string,
  queryRouterCodeHash?: string,
  lcdEndpoint?: string,
  chainId?: string,
  snip20ContractAddress: string,
  snip20CodeHash: string,
  ownerAddress: string,
  viewingKey: string,
  page: number,
  pageSize: number,
  minBlockHeightValidationOptions?: MinBlockHeightValidationOptions,
}): Promise<TransactionHistory>

output

ts
see querySnip20TransactionHistory for output type
see querySnip20TransactionHistory for output type