Skip to content

Latest commit

 

History

History
172 lines (140 loc) · 4.49 KB

README.md

File metadata and controls

172 lines (140 loc) · 4.49 KB
Raw

yacar

Yet Another Cosmos Asset Registry

Files

account.json

Contains notable user addresses including native multisig and CW3 multisig accounts. This file is updated manually.

type Account = {
  // The address of the wallet or smart contract
  id: string;
  // The entity which created or controls `id`
  entity: string;
  // A short descriptive label of `id`
  label: string;
};

contract.json

Contains notable cosmwasm smart contracts excluding CW3 multisig accounts. This file is updated manually.

type Contract = {
  // The address of the smart contract
  id: string;
  // The entity which created or controls `id`
  entity: string;
  // A short descriptive label of `id`
  label: string;
};

binary.json

Contains notable cosmwasm binaries. This file is updated manually.

type Binary = {
  // The code_id of the cosmwasm binary
  id: string;
  // The entity which created or controls `id`
  entity: string;
  // A short descriptive label of `id`
  label: string;
};

asset.json

Contains all verified and unverified native / IBC / CW20 / CW721 assets. This file will update automatically if all required fields of an asset can be inferred. The optional fields must be updated manually.

type Asset = {
  // The contract address of the cw20 tokens or denom of the ibc/native coins
  id: string;
  // The entity which created or controls `id`
  // A nullish value means that the asset is "unverified"
  entity?: string | undefined;
  // The canonical name of the asset (eg. "Axelar Wrapped Bitcoin")
  name: string;
  // The ticker of the asset (eg. "axlWBTC")
  symbol: string;
  // The number of decimals of the asset
  decimals: string;
  // The type of this asset: "native" | "ibc" | "cw20" | "cw721" | "tokenfactory"
  type: string;

  // The following fields are all optional
  // The transaction hash that contains "Coinhall verification" memo
  verification_tx?: string | undefined;

  // Supply values, do not populate both static and dynamic amounts (see example below)
  // Set the static amount of assets (after dividing the chain amount by 10^`decimals`)
  circ_supply?: string | undefined;
  total_supply?: string | undefined;

  // Set the dynamic amount of assets through a URL link
  circ_supply_api?: string | undefined;
  total_supply_api?: string | undefined;

  // These fields are all URL links
  icon?: string | undefined;
  coinmarketcap?: string | undefined;
  coingecko?: string | undefined;
};

Example assets

With static total supply, and dynamic circulating supply.

{
  id: "ibc/example_asset_id",
  name: "Example Asset",
  symbol: "EA",
  decimals: "6",
  type: "ibc",
  circ_supply_api: "https://exampleasset.com/circulating_supply",
  total_supply: "1000000"
}

Invalid example, with both static and dynamic circ supply. Applies to total supply too

{
  id: "ibc/example_asset_id",
  name: "Example Asset",
  symbol: "EA",
  decimals: "6",
  type: "ibc",
  circ_supply: "1000000",
  circ_supply_api: "https://exampleasset.com/circulating_supply",
  total_supply: "1000000"
}

entity.json

Contains all social information of a project. This file is updated manually.

type Entity = {
  name: string;
  website?: string | undefined;
  telegram?: string | undefined;
  twitter?: string | undefined;
  discord?: string | undefined;
}

pool.json

Contains dexes' liquidity pools. This file will update automatically if all required fields of a pool can be inferred (specifically, dex and type). Otherwise, the missing fields must be updated manually.

type Pool = {
  // The contract address of the liquidity pool
  id: string;
  asset_ids: string[];
  dex: string;
  // The liquidity pool type: "xyk" | "stable" | "orderbook" | "balancerV1"
  type: string;
  // The contract address of the LP token (if it exists)
  lp_token_id?: string | undefined;
};

Contributing

  1. Fork this repo
  2. Push changes to your fork
  3. The files will be validated and formatted automatically
  4. If validation passes, create a pull request
  5. If necessary, seek for a review via Telegram