origami-js-mill-coingecko

This repository contains an Open Oracle Origami JS Mill for CoinGecko.

For best results, use in conjunction with the Open Oracle Origami JS SDK.

When used with the SDK, this mill provides price feed data from the CoinGecko Simple Price endpoint while bringing you one step closer to launching your very own custom Open Oracle Origami Curator Node.

Any form, any shape. Web3’s modular open oracle.

Quick Start

Install SDK

npm install @open-oracle-origami/origami-js-sdk --save

Install Mill

npm install @open-oracle-origami/origami-js-mill-coingecko --save

Code

The code below demonstrates how to attach a mill to a curator. This is a partial implementation of a curator. To be fully functional, a curator must also plan at least one workshop and one museum.

For more information on how to use a curator, please see the Open Oracle Origami JS SDK.

import { Curator } from '@open-oracle-origami/origami-js-sdk'
import CoinGeckoMill from '@open-oracle-origami/origami-js-mill-coingecko'

const curator = Curator.create({ id: 'my-curator' })

const mill = CoinGeckoMill({
  simplePriceParams: {
    ids: ['bitcoin'],
    vs_currencies: ['usd'],
  },
})

curator.plan(mill).start()

This is an example of how to test the mill output.

import CoinGeckoMill from '@open-oracle-origami/origami-js-mill-coingecko'

const mill = CoinGeckoMill({
  simplePriceParams: {
    ids: ['bitcoin'],
    vs_currencies: ['usd'],
  },
})

mill.start((id, data) => {
  console.log(data)
})

Documentation

Mill currently supports the Simple Price endpoint from CoinGecko.

Config

id (string): optional

• The id of the mill. Defaults to mill.coingecko.

simplePriceParams (object): required

• An object that contains the following parameters for the CoinGecko Simple Price endpoint.
  • ids (string or array): required
    • Ids of the tokens or coins to query. Id List
  • vs_currencies (string or array): required
    • Currencies of each token or coin to fetch. Currency List
  • include_market_cap (boolean): optional
    • Include market cap in the response. Defaults to false.
  • include_24hr_vol (boolean): optional
    • Include 24hr volume in the response. Defaults to false.
  • include_24hr_change (boolean): optional
    • Include 24hr change in the response. Defaults to false.
  • include_last_updated_at (boolean): optional
    • Include last updated at timestamp in the response. Defaults to false.

interval (number): optional

• Polling interval in milliseconds. Defaults to 5000 (5 Seconds).

timeout (number): optional

• Mill timeout in milliseconds. Defaults to 10000 (10 Seconds).

autoRetry (boolean): optional

• Auto retry if the http response code is 429 (too many requests). Defaults to true.

apiKey (string): optional

• Api key for CoinGecko paid versions with higher rate limits. More Info

Example Config

const coinGeckoMillConfig = {
  id: 'mill.coingecko', // "mill." will always be prepended regardless of what you pass.
  simplePriceParams: {
    ids: ['bitcoin'],
    vs_currencies: ['usd'],
    include_market_cap: false,
    include_24hr_vol: false,
    include_24hr_change: false,
    include_last_updated_at: false, 
  },
  interval: 5000,
  timeout: 10000,
  autoRetry: true,
  apiKey: 'my-api-key',
}

Contributing

Contributions are always welcome! Our source code is licensed under the MIT License, and contributions are welcome.

See contributing for ways to get started.

Please adhere to our code of conduct.

License

MIT

折 お り 紙 がみ (origami), from 折 お り (ori, “to fold”) + 紙 かみ (kami, “paper“)