yolodice-api v1.1.9

YOLOdice-api

An API wrapper for the YOLOdice API

Sample usage:

npm install yolodice-api --save

const YOLOdice = require('yolodice-api');
let client = new YOLOdice('YOUR_API_PRIVATE_KEY');

client.on('loggedIn', (user) => {
    console.log(`Logged in as (${user.id})${user.name}`);
});

client.on('error', (err) => {
    console.dir(err);
});

process.on('SIGINT', () => {
    client.quit();
});

>node app
Logged in as (12345)YourName

Nearly all the methods that take a callback (with the exception of getBalance()) return the entire server response as the first and only argument to the callback function. These objects follow the JSON-RPC 2.0 spec, which means they all have an id property and have a result property on success and an error property on failure. To access the info, you should in most cases check to see if the response has a result property and parse the data from there.

Unsupported methods (none at the time of this writing) can be called by using YOLOdice.send(obj, callback) where obj is the object to send and callback is the method to call with the response when the server responds. Example:

client.send({
    method: 'some_unsupported_method',
    params: {
        param_a: 1,
        param_b: 2
    }
}, aCallbackFunction(res) {
    if(res.result) {
        console.log('Got response');
    }
});

The class does most of the legwork for you here, it will automatically add an id property to the object before it sends it to the server and use it to track when the server responds, and it will then call the callback with the response.

Please note this is an early version of this library and many methods have not been tested extensively or at all. Please use at your own risk.

YOLOdice ⇐ EventEmitter

Kind: global class
Extends: EventEmitter

• YOLOdice ⇐ EventEmitter
  • new YOLOdice()
  • instance
    • .send(req, [callback])
    • .sign(msg) ⇒ string
    • .quit()
    • .readSiteData([callback])
    • .readUser(id, [callback])
    • .readUserData(id, [callback])
    • .getBalance([callback])
    • .readUserCoinData(id, [callback])
    • .listUserCoinDatas(id, [callback])
    • .resetSessionCounters([coin], [callback])
    • .createBet(attrs, [includeDatas], [callback])
    • .readBet(id, [callback])
    • .listBets([userId], [options], [callback])
    • .readSeed(id, [callback])
    • .readCurrentSeed(userId, [callback])
    • .listSeeds([options], [callback])
    • .createSeed(attrs, [callback])
    • .patchSeed(id, attrs, [callback])
    • .readConfig([callback])
    • .readDepositAddress(coin, [callback])
    • .listDepositAddresses(coin, callback)
    • .readDeposit(id, [callback])
    • .listDeposits([options], [callback])
    • .readWithdrawingConfig([callback])
    • .readWithdrawal(id, [callback])
    • .listWithdrawals([options], [callback])
    • .readWithdrawalConfig([callback])
    • .createWithdrawal(attrs, [callback])
    • .patchWithdrawal(id, attrs, [callback])
    • .cancelWithdrawal(id, [callback])
    • .readInvestment(id, [callback])
    • .listInvestments([status], [callback])
    • .createInvestment(attrs, coin, leverage, [callback])
    • .patchInvestment(id, attrs, [callback])
    • .ping([callback])
    • "error"
    • "sign"
    • "loggedIn"
  • static
    • .YOLOdice
      • new YOLOdice(key, privateKey, publicCert, [options])
  • inner
    • ~responseHandler : function

new YOLOdice()

A class that handles connections to the YOLOdice API.

YOLOdice.YOLOdice

Kind: static class of YOLOdice

new YOLOdice(key, options)

Creates an instance of YOLOdice.

YOLOdice.send(req, callback)

Records the request sent in this.requests and sends the data. Can also be used to send unsupported/new methods.

Kind: instance method of YOLOdice

YOLOdice.sign(msg) ⇒ string

Signs a message with the client's private key

Kind: instance method of YOLOdice
Returns: string - The signature
Emits: sign

YOLOdice.quit()

Gracefully closes the connection and terminates the process

Kind: instance method of YOLOdice

YOLOdice.readSiteData(callback)

Requests site data and calls callback with the data

Kind: instance method of YOLOdice

YOLOdice.readUser(id, callback)

Returns user data including id, name, date created and roles

Kind: instance method of YOLOdice

YOLOdice.readUserData(id, callback)

Returns more extensive user data

Kind: instance method of YOLOdice

YOLOdice.getBalance(callback)

An abstraction for listUserCoinDatas on yourself

Kind: instance method of YOLOdice

YOLOdice.readUserCoinData(id, callback)

Returns some coin-specific user data

Kind: instance method of YOLOdice

YOLOdice.listUserCoinDatas(id, callback)

Returns an array of coin datas for the given user

Kind: instance method of YOLOdice

YOLOdice.resetSessionCounters(coin, callback)

Resets session counters, optionally only for a specific coin

Kind: instance method of YOLOdice

YOLOdice.createBet(attrs, includeDatas, callback)

Creates a bet. Requires the play permission

Kind: instance method of YOLOdice

YOLOdice.readBet(id, callback)

Reads the data from a single bet

Kind: instance method of YOLOdice

YOLOdice.listBets(userId, options, callback)

An array of hashes each containing a single bet

Kind: instance method of YOLOdice

YOLOdice.readSeed(id, callback)

Reads the attributes of a seed

Kind: instance method of YOLOdice

YOLOdice.readCurrentSeed(userId, callback)

Reads the current seed for the specified user

Kind: instance method of YOLOdice

YOLOdice.listSeeds(options, callback)

Lists the seeds that meet the given criteria

Kind: instance method of YOLOdice

YOLOdice.createSeed(attrs, callback)

Creates a new seed for the user

Kind: instance method of YOLOdice

YOLOdice.patchSeed(id, attrs, callback)

Updates and returns the current seed

Kind: instance method of YOLOdice

<a name="YOLOdice+readConfig>

YOLOdice.readConfig(callback)

Gets some data about the site, such as coins and withdraw fees

Kind: instance method of YOLOdice

YOLOdice.readDepositAddress(coin, callback)

Reads the current deposit address for the authenticated user and coin

Kind: instance method of YOLOdice

YOLOdice.listDepositAddresses(coin, callback)

Lists all user deposit addresses for the given coin

Kind: instance method of YOLOdice

YOLOdice.readDeposit(id, callback)

Returns the information for a single deposit

Kind: instance method of YOLOdice

YOLOdice.listDeposits(options, callback)

Lists deposits

Kind: instance method of YOLOdice

YOLOdice.readWithdrawingConfig(callback)

Contains info about withdrawing

Kind: instance method of YOLOdice

YOLOdice.readWithdrawal(id, callback)

Reads withdrawal specified by id

Kind: instance method of YOLOdice

YOLOdice.listWithdrawals(options, callback)

Lists withdrawals for the logged in user

Kind: instance method of YOLOdice

YOLOdice.readWithdrawalConfig(callback)

Contains info about withdrawing

Kind: instance method of YOLOdice

YOLOdice.createWithdrawal(attrs, callback)

Creates a withdrawal. Returns the withdrawal (identical format to readWithdrawal)

Kind: instance method of YOLOdice

YOLOdice.patchWithdrawal(id, attrs, callback)

Can only be used to cancel pending withdrawals

Kind: instance method of YOLOdice

YOLOdice.cancelWithdrawal(id, callback)

Wrapper method for patchWithdrawal to cancel withdrawals

Kind: instance method of YOLOdice

YOLOdice.readInvestment(id, callback)

Reads the investment for the given id

Kind: instance method of YOLOdice

YOLOdice.listInvestments(status, callback)

Lists investments for the logged in user

Kind: instance method of YOLOdice

YOLOdice.createInvestment(attrs, coin, leverage, callback)

Creates an investment

Kind: instance method of YOLOdice

YOLOdice.patchInvestment(id, attrs, callback)

Patches (closes) an investment

Kind: instance method of YOLOdice

YOLOdice.ping(callback)

Pings the server

Kind: instance method of YOLOdice

"error"

Error

Kind: event emitted by YOLOdice

"sign"

Fires when the instance signs a message with it's Bitcoin key

Kind: event emitted by YOLOdice

"loggedIn"

Fires when the user is successfully logged in

Kind: event emitted by YOLOdice

YOLOdice~responseHandler : function

Callback called when a response is received from the server

Kind: inner typedef of YOLOdice