DOCS/GRAPHQL/CURRENCIES

Currencies

Query currency definitions, states, and multi-currency data on Verus.

Get Currency

query {
  currency(
    chainId: "iJhCezBExJHvtyH3fGhNnt2NhU4Ztkf2yq"
    currencyId: "iBridge..."
  ) {
    currencyId
    name
    fullyQualifiedName
    systemId
    launchSystemId
    options
    proofProtocol
    idRegistrationFees
    currencyRegistrationFee
  }
}

List Currencies

query {
  currencies(
    chainId: "iJhCezBExJHvtyH3fGhNnt2NhU4Ztkf2yq"
    limit: 20
  ) {
    currencies {
      currencyId
      name
      options
    }
    totalCount
    hasMore
  }
}

Currency State

Get current state for basket/liquidity currencies:

query {
  currencyState(
    chainId: "iJhCezBExJHvtyH3fGhNnt2NhU4Ztkf2yq"
    currencyId: "iBridge..."
  ) {
    supply
    reserves {
      currencyId
      amount
    }
    weights
    conversionPrices
    fees
    lastNotarization
  }
}

Currency History

Get historical state snapshots:

query {
  currencyHistory(
    chainId: "iJhCezBExJHvtyH3fGhNnt2NhU4Ztkf2yq"
    currencyId: "iBridge..."
    fromHeight: 680000
    toHeight: 689000
  ) {
    snapshots {
      blockHeight
      supply
      reserves
    }
  }
}

Currency Type

type Currency {
  chainId: String!
  currencyId: String!
  name: String!
  fullyQualifiedName: String!
  systemId: String!
  launchSystemId: String
  parent: String
  options: Int!
  proofProtocol: Int!
  idRegistrationFees: Decimal
  currencyRegistrationFee: Decimal
  definitionHeight: BigInt!
}

type CurrencyState {
  supply: Decimal!
  reserves: [Reserve!]
  weights: [Float!]
  conversionPrices: [Decimal!]
  fees: Decimal
  lastNotarization: BigInt
}

type Reserve {
  currencyId: String!
  amount: Decimal!
}

Currency Options

The options field is a bitmask indicating currency properties:

  • 0x01 — Token
  • 0x02 — Fractional basket
  • 0x04 — Prelaunch
  • 0x08 — Gateway
  • 0x20 — PBaaS chain
  • 0x100 — NFT