sunbeam v0.0.1

sunbeam

Examples

Node.js

Websocket client:

node example-ws.js

Managed State Helper:

node example-wallet.js
node example-orderbook.js

Websocket API

You can see all API calls in example-ws.js.

Setup your node

Start nodeos:

nodeos --access-control-allow-origin "*" --verbose-http-error --http-validate-host=false --enable-stale-production --producer-name eosio --plugin eosio::chain_api_plugin --plugin eosio::net_api_plugin

--contracts-console will output the logging from custom contracts

Browsers

Enable CORS for your EOS node, by enabling it via config:

cd ~/eosdata/

echo "access-control-allow-origin = *" >> config.ini

HTTP API demos (deprecated!)

Testpage in Browser

# delete cached eosjs
rm test/browser-test/eosjs-dist.js

# start
node test/browser-test/dev.js

Demo Exchange page

# delete cached eosjs
rm test/browser-exchange/eosjs-dist.js

# start
node test/browser-exchange/dev.js
nodemon test/browser-exchange/dev.js -w test/browser-exchange/jsx/*.jsx

HTTP API (deprecated!)

You can see all API calls in example-http.js.

There are also browser demos available at test/browser/.

new Sunbeam(eos, ?opts)

• eos (object)
• Eos (object) the eosjs module you want to use
• readNodeConf (object) config for read node
• writeNodeConf (object )config for write node
• opts (object)
• account (string) account name you want to use
• dev (boolean) don't check for seperate read/write node

Creates a new Sunbeam instance. Currently you have to pass the eosjs library and config for a read and write node.

Example:

const Sunbeam = require('sunbeam')
const Eos = require('eosjs')

const readNodeConf = {
  httpEndpoint: 'http://localhost:8888',
  keyProvider: [
    '5Kci5UR4h25CM4vCyQMTQy4pzMhqXZ8vnocYJJkm2eQb8cfHsWV'
  ]
}

const writeNodeConf = {
  httpEndpoint: 'http://writenode.example.com:8888',
  keyProvider: [
    '5Kci5UR4h25CM4vCyQMTQy4pzMhqXZ8vnocYJJkm2eQb8cfHsWV'
  ]
}
const eos = {
  Eos,
  readNodeConf,
  writeNodeConf
}

const opts = { account: 'testuser4321', dev: false }
const sb = new Sunbeam(eos, opts)

sunbeam.createOrder(order) => Order

• order (object)
• symbol (string) the symbol, e.g. BTC.USD
• price (string) the sell/buy price, omit for EXCHANGE_MARKET orders
• amount (string) the amount, set to negative value for selling
• type (string) the order type, supported are EXCHANGE_LIMIT and EXCHANGE_MARKET
• flags (number) optional: define order flags
• clientId (number) id to identify the id

Creates an Order object for the eosfinex contract. Mimics the Bitfinex Api v2.

For market orders, the price must be omitted.

Available flags:

post only                       1
ioc                             2
release on trade               64
sweep collateral              128

The summation of flags may result in multiple flags. The flag 3 means ioc post only.

sweep collateral will automatically transfer funds out of the exchange upon an order cancel. release on trade will automatically transfer funds out of the exchange upon an order fill.

Example:

const order = sb.createOrder({
  symbol: 'BTC.USD',
  price: '2100',
  amount: '-14.99',
  type: 'EXCHANGE_LIMIT',
  clientId: '123'
})

Example - post only + ioc flag set:

const order = sb.createOrder({
  symbol: 'BTC.USD',
  price: '2100',
  amount: '-14.99',
  type: 'EXCHANGE_LIMIT',
  clientId: '123',
  flags: '3'
})

sunbeam.place(order, cb) => err, tx

• order (object)

Takes a Sunbeam order object and sends it to the writing node. Returns tx details.

Example:

sb.place(order, (err, res) => {
  if (err) throw err

  console.log('placed "sell" order')
  console.log(JSON.stringify(res, null, '  '))
})

sunbeam.orderbook(symbol, opts, cb) => err, orderbook

• symbol (string) the symbol, e.g. BTC.USD
• opts (object)
  • transform (boolean) set true for an order book that is similar to the Bitfinex API v2

Retrieves the order book for a given symbol from the read node.

Example:

// orderbook: bfx api v2 style (keyed)
sb.orderbook('BTC.USD', { transform: true }, (err, res) => {
  if (err) throw err

  console.log('orderbook: bfx api v2 style (keyed)')
  console.log(JSON.stringify(res, null, '  '))
})

// orderbook: raw
sb.orderbook('BTC.USD', {}, (err, res) => {
  if (err) throw err

  console.log('orderbook: raw')
  console.log(JSON.stringify(res, null, '  '))
})

sunbeam.orders(symbol, opts, cb) => err, orderbook

• symbol (string) the symbol, e.g. BTC.USD
• opts (object)
  • account (boolean) optional: use different account than from initial new Sunbeam

Retrieves the placed orders for an account.

Example:

// orders, uses account passed when Sunbeam instance was created
sb.orders('BTC.USD', {}, (err, res) => {
  if (err) throw err

  console.log('orders, default account', opts.account)
  console.log(JSON.stringify(res, null, '  '))
})

// orders, testuser1234
sb.orders('BTC.USD', { user: 'testuser1234' }, (err, res) => {
  if (err) throw err

  console.log('orders, user testuser1234')
  console.log(JSON.stringify(res, null, '  '))
})

sunbeam.cancel(trade, opts, cb) => err, tx

• trade (object)

  • id: the id that was assigned by the contract
  • symbol (string) symbol, e.g. BTC.USD
  • side (string) possible values: bid|ask

• opts (object)

Cancels and order. Requires the id assigned by the contract, which can be retireved from reading the order book.

Example:

sb.cancel({
  id: '1',
  symbol: 'BTC.USD',
  side: 'ask'
}, {}, (err, res) => {
  if (err) throw err

  console.log(JSON.stringify(res, null, '  '))
})

sunbeam.withdraw(data, opts, cb) => err, tx

• data (object)

  • amount: the id that was assigned by the contract
  • symbol (string) symbol, e.g. BTC
  • to (string) optional: address to withdrawal to (defaults to current account)

• opts (object)

Withdraws tokens from the exchange.

Example:

$ cleos get currency balance efinexchange testuser4321
925.0500000000 BTC
99999.9400000000 USD

$ cleos get currency balance efinextether testuser4321
1000.0000000000 BTC

sb.withdraw({
  currency: 'BTC',
  amount: '0.678'
}, {}, (err, res) => {
  if (err) throw err

  console.log(JSON.stringify(res, null, '  '))
})

$ cleos get currency balance efinextether testuser4321
1000.0000000000 BTC
0.6780000000 USD

sunbeam.balance(cb) => err, balances

Returns the current wallet balance for the user.

Example:

sb.balance((err, res) => {
  if (err) throw err

  console.log(JSON.stringify(res, null, '  '))
})

sunbeam.sweep(data, opts, cb) => err, tx

• data (object)

  • symbol (string) symbol, e.g. BTC
  • to (string) optional: address to withdrawal to (defaults to current account)

• opts (object)

Sweeps the whole balance for a token from the exchange to an account.

Example:

sb.sweep({
  currency: 'USD'
}, {}, (err, res) => {
  if (err) throw err

  console.log(JSON.stringify(res, null, '  '))
})