npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@open-oracle-origami/origami-js-mill-coinbase

v1.0.3

Published

Open Oracle Origami Node JS Coinbase Mill

Downloads

7

Readme

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.


npm package Build Status Downloads Issues Code Coverage Commitizen Friendly Semantic Release

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

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