origami-js-mill-coinbase

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

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

When used with the SDK, this mill provides ticker data from the Coinbase Exchange WebSocket 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-coinbase --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 CoinbaseMill from '@open-oracle-origami/origami-js-mill-coinbase'

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

const mill = CoinbaseMill({
  productIds: ['BTC-USD']
})

curator.plan(mill).start()

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

import CoinbaseMill from '@open-oracle-origami/origami-js-mill-coinbase'

const mill = CoinbaseMill({
  productIds: ['BTC-USD']
})

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

Documentation

Mill currently supports the Exchange WebSocket channel from Coinbase.

Config

id (string): optional

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

productIds (array): required

• Product IDs to subscribe to. Product Id List

socketServerUrl (string): optional

• The Coinbase WebSocket server url. Defaults to wss://ws-feed.exchange.coinbase.com.

Example Config

const coinbaseMillConfig = {
  id: 'mill.coinbase', // "mill." will always be prepended regardless of what you pass.
  productIds: ['BTC-USD', 'ETH-USD'],
  socketServerUrl: 'wss://ws-feed.exchange.coinbase.com'
}

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“)