Skip to main content

Getting Prices

getLatestPrices​

A function to fetch the latest price messages for one or more pairs.

Usage​

info

getLatestPrices requires that you authenticate with a valid auth token first

import { getLatestPrices } from '@chronicleprotocol/pull-oracle';

const prices = await getLatestPrices([
  { wat: "MKR/USD" },
  { wat: "ETH/USD" }
]);

Returns​

Returns a promise that provides an array of objects.

[
  {
    wat: string,
    scheme: string,
    bar: number,
    messages: [
      {
        wat: string,
        val: string,
        age: number,
        r: string,
        s: string,
        v: string,
        validator: Address
      }
    ],
    callData: Hex
  }
]

Errors​

In the event of an error, the return object will be provided with error: true and an error code.

{
  "error": true,
  "message": "Invalid authorization token: EXPIRED",
  "data": {
    "wat": "ETH/USD",
    "scheme": "ECDSA"
  },
  "code": "EXPIRED"
}

Parameters​

wats​

  • Type: array

The list of pairs to fetch.

[{ wat: "ETH/USD" }, ...]

wat​

  • Type: string

A valid pair.

scheme​

  • Optional
  • Default: ECDSA
  • Type: Scheme

getPairs​

Provides a list of valid pairs that prices are available for.

import { getPairs } from '@chronicleprotocol/pull-oracle';

const pairs = await getPairs({ scheme: 'ECDSA' });

Parameters​

options​

  • Type: object

The object of options to fetch pairs.

{ scheme: "ECDSA" }

scheme​

Returns​

The keys of the pairs field are valid wat values.

{
  "data": {
    "scheme": "ECDSA",
    "pairs": {
      "ETHX/ETH": {
        "bar": 13,
        "validators": [
          "0x130431b4560Cd1d74A990AE86C337a33171FF3c6",
          "0x15e6e59F95000e5039CBFF5f23FDa9c03d971F66",
          ...
        ]
      },
      ...
    }
  }
}