dexbot 1.4.12 → 1.4.14

package/claw/node_modules/btsdex/README.md

@@ -0,0 +1,467 @@
+# btsdex
+
+Package for work with BitShares DEX.
+The main class in the package is `BitShares`. All you need is in it. There are a couple more helper classes, but they are not really designed for use outside of the `BitShares` class.
+
+The `BitShares` class consists of static methods intended for working with the BitShares public blockchain API. Using the BitShares class, you can create an object whose methods provide access to the private part of the BitShares blockchain API.
+
+## Setup
+
+### If you use `npm`
+This library can be obtained through npm:
+```
+$ npm install btsdex
+```
+If you want use [REPL-mode](#repl-mode):
+```
+$ npm install -g btsdex
+```
+
+### If you use `browser`
+Include [this](https://github.com/scientistnik/btsdex/releases) in html-file:
+```
+<script src="btsdex.min.js"></script>
+```
+After that in console available `BitShares` class.
+
+## Usage
+
+__btsdex__ package contain class `BitShares`: 
+```js
+const BitShares = require('btsdex')
+```
+To connect to the BitShares network, you must call `connect` method:
+```js
+await BitShares.connect();
+```
+By default, `BitShares` connected to `wss://dex.iobanker.com/ws`. If you want set another node to connect:
+```js
+await BitShares.connect("wss://dex.iobanker.com/ws")
+```
+
+You can also connect to the network using the [event system](#event-system).
+
+### Public API
+
+After the connection, you can use any public method from [official documentation](http://dev.bitshares.works/en/master/api/blockchain_api.html) (if the method is still relevant!).
+
+#### Database API
+
+To access the [Database API](http://dev.bitshares.works/en/master/api/blockchain_api/database.html), you can use the __BitShares.db__ object.
+
+An example of methods from the Database API:
+
+[__get_objects(const vector <object_id_type> & ids) const__](http://dev.bitshares.works/en/master/api/blockchain_api/database.html#_CPPv3NK8graphene3app12database_api11get_objectsERK6vectorI14object_id_typeE)
+
+[__list_assets(const string & lower_bound_symbol, uint32_t limit) const__](http://dev.bitshares.works/en/master/api/blockchain_api/database.html#_CPPv3NK8graphene3app12database_api11list_assetsERK6string8uint32_t)
+
+
+To use them:
+```js
+let obj = await BitShares.db.get_objects(["1.3.0"])
+let bts = await BitShares.db.list_assets("BTS", 100)
+```
+
+#### History API
+
+To access the [Account History API](http://dev.bitshares.works/en/master/api/blockchain_api/history.html), you can use the __BitShares.history__ object.
+
+Example of a method from the Account History API:
+
+[__get_account_history (account_id_type account, operation_history_id_type stop = operation_history_id_type (), unsigned limit = 100, operation_history_id_type start = operation_history_id_type ()) const__](http://dev.bitshares.works/en/master/api/blockchain_api/history.html#_CPPv3NK8graphene3app11history_api19get_account_historyEKNSt6stringE25operation_history_id_typej25operation_history_id_type)
+
+To use it:
+```js
+let ops = await BitShares.history.get_account_history("1.2.849826", "1.11.0", 10, "1.11.0")
+```
+
+### Private API
+
+If you want to have access to account operations, you need to create a BitShares object. 
+
+If you know `privateActiveKey`:
+```js
+let acc = new BitShares(<accountName>, <privateActiveKey>)
+```
+or if you know `password`:
+```js
+let acc = BitShares.login(<accountName>, <password>)
+```
+or if you have `bin`-file:
+```js
+let buffer = fs.readFileSync(<bin-file path>);
+let acc = BitShares.loginFromFile(buffer, <wallet-password>, <accountName>)
+```
+
+While this object can not much: buy, sell, transfer, cancel order, asset reserve, asset issue and more.
+
+Signatures of methods:
+```js
+acc.buy(buySymbol, baseSymbol, amount, price, fill_or_kill = false, expire = "2020-02-02T02: 02: 02")
+acc.sell(sellSymbol, baseSymbol, amount, price, fill_or_kill = false, expire = "2020-02-02T02: 02: 02")
+acc.cancelOrder(id)
+acc.transfer(toName, assetSymbol, amount, memo)
+acc.assetIssue(toName, assetSymbol, amount, memo)
+acc.assetReserve(assetSymbol, amount)
+```
+
+Examples of using:
+```js
+await acc.buy("HONEST.BTC", "BTS", 0.002, 140000)
+await acc.sell("BTS", "HONEST.USD", 187, 0.24)
+await acc.transfer("scientistnik", "BTS", 10)
+await acc.assetIssue("scientistnik", "ABC", 10)
+await acc.assetReserve("ABC", 12)
+```
+
+If you want to send tokens with memo and get `acc` from `constructor` (use `new BitShares()`), then before that you need to set a private memo-key:
+```js
+bot.setMemoKey(<privateMemoKey>)
+await bot.transfer("scientistnik", "HONEST.USD", 10, "Thank you for BTSDEX!")
+```
+### Transaction Builder
+
+Each private transaction is considered accepted after being included in the block. Blocks are created every 3 seconds. If we need to perform several operations, their sequential execution can take considerable time. Fortunately, several operations can be included in a single transaction. For this you need to use transaction builder.
+
+For create new transaction:
+```js
+let tx = BitShares.newTx([<activePrivateKey>,...])
+```
+or if you have account object `acc`:
+```js
+let tx = acc.newTx()
+```
+
+For get operation objects:
+```js
+let operation1 = await acc.transferOperation("scientistnik", "BTS", 10)
+let operation2 = await acc.assetIssueOperation("scientistnik", "ABC", 10)
+...
+```
+Added operation to transaction:
+```js
+tx.add(operation1)
+tx.add(operation2)
+...
+```
+If you want to know the cost of the transaction:
+```js
+let cost = await tx.cost()
+console.log(cost) // { BTS: 1.234 }
+```
+
+After broadcast transaction:
+```js
+await tx.broadcast()
+```
+or
+```js
+await acc.broadcast(tx)
+```
+
+If you know what fields the transaction you need consists of and the operation name, you can use the transaction builder for executing the transaction.
+
+The account property has a lot more operations available than an instance of the bitshares class.
+
+An example of using transaction builder for executing 'account_create' operation:
+```js
+let BitShares = require("btsdex")
+
+BitShares.subscribe("connected", start)
+
+async function start() {
+  let acc = await BitShares.login(<accountName>, <password>)
+
+  let params = {
+    fee: {amount: 0, asset_id: "1.3.0"},
+    name: "trade-bot3",
+    registrar: "1.2.21058",
+    referrer: "1.2.21058",
+    referrer_percent: 5000,
+    owner: {
+      weight_threshold: 1,
+      account_auths: [],
+      key_auths: [[<ownerPublicKey>, 1]],
+      address_auths: []
+    },
+    active: {
+      weight_threshold: 1,
+      account_auths: [],
+      key_auths: [[<activePublicKey>, 1]],
+      address_auths: []
+    },
+    options: {
+      memo_key: <memoPublicKey>,
+      voting_account: "1.2.5",
+      num_witness: 0,
+      num_committee: 0,
+      votes: []
+    },
+    extensions: []
+  };
+
+  let tx = acc.newTx()
+  tx.account_create(params) // 'account_create' is the operation name
+  await tx.broadcast()
+}
+```
+
+
+### Event system
+Very often we have to expect, when there will be some action in the blockchain, to which our software should respond. The idea of ​​reading each block and viewing all the operations in it, seemed to me ineffective. Therefore, this update adds an event system.
+
+#### Event types
+
+At the moment, __BTSDEX__ has three types of events:
+* `connected` - works once after connecting to the blockchain;
+* `block` - it works when a new block is created in the blockchain;
+* `account` - occurs when the specified account is changed (balance change).
+
+For example:
+```js
+const BitShares = require("btsdex");
+
+BitShares.subscribe('connected', startAfterConnected);
+BitShares.subscribe('block', callEachBlock);
+BitShares.subscribe('account', changeAccount, 'trade-bot');
+
+async function startAfterConnected() {/* is called once after connecting to the blockchain */}
+async function callEachBlock(obj) {/* is called with each block created */}
+async function changeAccount(array) {/* is called when you change the 'trade-bot' account */}
+```
+
+##### The `connected` event
+
+This event is triggered once, after connecting to the blockchain. Any number of functions can be subscribed to this event and all of them will be called after connection.
+
+```js
+BitShares.subscribe('connected', firstFunction);
+BitShares.subscribe('connected', secondFunction);
+```
+
+Another feature of the event is that when you first subscription call the method `BitShares.connect()`, i.e. will be an automatic connection. If by this time the connection to the blockchain has already been connected, then it will simply call the function.
+
+Now it's not necessary to explicitly call `BitShares.connect()`, it's enough to subscribe to the `connected` event.
+
+```js
+const BitShares = require("btsdex");
+
+BitShares.subscribe('connected', start);
+
+async function start() {
+  // something is happening here
+}
+```
+
+##### The `block` event
+
+The `block` event is triggered when a new block is created in the blockchain. The first event subscription automatically creates a subscription to the `connected` event, and if this is the first subscription, it will cause a connection to the blockchain.
+
+```js
+const BitShares = require("btsdex");
+
+BitShares.subscribe('block', newBlock);
+
+// need to wait ~ 10-15 seconds
+async function newBlock(obj) {
+  console.log(obj); // [{id: '2.1.0', head_block_number: 17171083, time: ...}]
+}
+```
+
+As you can see from the example, an object with block fields is passed to all the signed functions.
+
+##### The `account` event
+
+The `account` event is triggered when certain changes occur (balance changes). These include:
+* If the account sent someone one of their assets
+* If an asset has been sent to an account
+* If the account has created an order
+* If the account order was executed (partially or completely), or was canceled.
+
+The first subscriber to `account` will call a `block` subscription, which in the end will cause a connection to the blockchain.
+
+Example code:
+```js
+const BitShares = require("btsdex");
+
+BitShares.subscribe('account', changeAccount, 'scientistnik');
+
+async function changeAccount (array) {
+  console.log(array); // [{id: '1.11.37843675', block_num: 17171423, op: ...}, {...}]
+}
+```
+In all the signed functions, an array of account history objects is transferred, which occurred since the last event.
+
+### REPL-mode
+
+If you install `btsdex`-package in global storage, you may start `btsdex` exec script:
+```js
+$ btsdex
+>|
+```
+This command try autoconnect to mainnet BitShares. If you want to connect on testnet, try this:
+```js
+$ btsdex --testnet
+>|
+```
+or use `--node` key:
+```js
+$ btsdex --node wss://dex.iobanker.com/ws
+>|
+```
+
+It is nodejs REPL with several variables:
+- `BitShares`, main class `BitShares` package
+- `login`, function to create object of class `BitShares`
+- `generateKeys`, to generateKeys from login and password
+- `accounts`, is analog `BitShares.accounts`
+- `assets`, is analog `BitShares.assets`
+- `db`, is analog `BitShares.db`
+- `history`, is analog `BitShares.hostory`
+- `network`, is analog `BitShares.network`
+- `fees`, is analog `BitShares.fees`
+
+#### For example
+
+```js
+$ btsdex
+> assets["bts"].then(console.log)
+```
+
+#### Shot request
+
+If need call only one request, you may use `--account`, `--asset`, `--block`, `--object`, `--history` or `--transfer` keys in command-line:
+```js
+$ btsdex --account <'name' or 'id' or 'last number in id'>
+{
+  "id": "1.2.5992",
+  "membership_expiration_date": "1970-01-01T00:00:00",
+  "registrar": "1.2.37",
+  "referrer": "1.2.21",
+  ...
+}
+$ btsdex --asset <'symbol' or 'id' or 'last number in id'>
+{
+  "id": "1.3.0",
+  "symbol": "BTS",
+  "precision": 5,
+  ...
+}
+$ btsdex --block [<number>]
+block_num: 4636380
+{
+  "previous": "0046bedba1317d146dd6afbccff94412d76bf094",
+  "timestamp": "2018-10-01T13:09:40",
+  "witness": "1.6.41",
+  ...
+}
+$ btsdex --object 1.2.3
+{
+  "id": "1.2.3",
+  "membership_expiration_date": "1969-12-31T23:59:59",
+  "registrar": "1.2.3",
+  "referrer": "1.2.3",
+  ...
+}
+$ btsdex --history <account> [<limit>] [<start>] [<stop>]
+[
+  {
+    "id": "1.11.98179",
+    "op": [
+      0,
+  ...
+}]
+$ btsdex --transfer <from> <to> <amount> <asset> [--key]
+Transfered <amount> <asset> from '<from>' to '<to>' with memo '<memo>'
+```
+
+### Helper classes
+There are a couple more helper classes, such as __BitShares.assets__ and __BitShares.accounts__:
+```js
+let usd = await BitShares.assets.usd;
+let btc = await BitShares.assets["HONEST.BTC"];
+let bts = await BitShares.assets["bts"];
+
+let iam = await BitShares.accounts.scientistnik;
+let tradebot = await BitShares.accounts["trade-bot"];
+```
+The returned objects contain all the fields that blockchain returns when the given asset or account name is requested.
+
+### Some examples
+The below example can be used to broadcast any transaction to the BitShares Blockchain using API node hence you can use any BitShares Public API node, you will just need to replace parameters under **params** and the operation name **asset_update** in below example with your desired transaction parameters and its operation name. Use the below links to determine your desired operation name and needed parameters along with their required order. Below transaction example serialization can be found here [Serialization](https://github.com/bitshares/btsdex/blob/master/packages/serializer/src/operations.js) as you will need to honor the order of [Operation](https://github.com/bitshares/bitshares-core/blob/master/libraries/protocol/include/graphene/protocol/operations.hpp) parameters along with their sub parameters which are present in below example **new_options** note that some of parameters or sub parameters are optional:
+
+```js
+const BitShares = require("btsdex");
+BitShares.connect("wss://dex.iobanker.com/ws"); # replace wss://dex.iobanker.com/ws with API node if you want to use another BitShares API node
+BitShares.subscribe('connected', startAfterConnected);
+
+async function startAfterConnected() {
+let acc = await new BitShares("username", "password"); # replace with your username and password
+
+# Below are required parameters and structure for the example of operation *asset_update*; every different operation would required different parameters and structure
+
+# Finding what data to use in these parameters would require understanding of how BitShares Blockchain works, for example *issuer* is referred to the ID *1.2.1787259* of owner account of an Asset, use telegram [BitShares Development](https://t.me/BitSharesDEV) group to ask about required parameters.
+
+let params = {
+    fee: {amount: 0, asset_id: "1.3.0"},
+    "issuer":"1.2.1787259",
+    "asset_to_update":"1.3.5537", 
+    "new_options": {
+     "max_supply": "1000000000000000", 
+     "market_fee_percent": 0, 
+     "max_market_fee": "0", 
+     "min_market_fee": 0, 
+     "issuer_permissions": 79, 
+     "flags": 6, 
+     "core_exchange_rate": {
+      "base": {"amount": 500000, "asset_id": "1.3.0"}, 
+      "quote": {"amount": 10000, "asset_id": "1.3.5537"}
+      }, 
+    "whitelist_authorities": [], 
+    "blacklist_authorities": [], 
+    "whitelist_markets": [], 
+    "blacklist_markets": [],
+    "description": "{\"main\":\"Your Asset Info\",\"market\":\"Your Market info\"}", 
+    "extensions": {"taker_fee_percent": 10}
+    }
+}
+
+let tx = acc.newTx();
+tx.asset_update(params); # Replace asset_update with your desired operation name
+await tx.broadcast();
+console.log(tx);
+}
+```
+
+Another example for getting account orders information: 
+
+```js
+const BitShares = require('btsdex')
+KEY = 'privateActiveKey'
+
+BitShares.subscribe('connected', startAfterConnected)
+
+async function startAfterConnected() {
+  let bot = new BitShares('trade-bot', KEY)
+
+  let iam = await BitShares.accounts['trade-bot'];
+  let orders = await BitShares.db.get_full_accounts([iam.id], false);
+  
+  orders = orders[0][1].limit_orders;
+  let order = orders[0].sell_price;
+  console.log(order)
+}
+```
+
+## Documentation
+For more information, look [wiki](https://scientistnik.github.io/btsdex) or in `docs`-folder.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub. For communication, you can use the Telegram-channel [btdex](https://t.me/btsdex).
+
+`master`-branch use for new release. For new feature use `dev` branch. All pull requests are accepted in `dev` branch.
+
+## License
+
+The package is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

package/claw/node_modules/btsdex/cli.js

@@ -0,0 +1,165 @@
+#!/usr/bin/env node
+
+const repl = require("repl"),
+  BitShares = require("./lib"),
+  readline = require("readline"),
+  Writable = require("stream").Writable;
+
+var mutableStdout = new Writable({
+  write: function (chunk, encoding, callback) {
+    if (!this.muted) process.stdout.write(chunk, encoding);
+    else process.stdout.write(Buffer.from("*", "utf-8"), encoding);
+    callback();
+  },
+});
+
+function initializeContext(context) {
+  connect().then(() => {
+    context.accounts = BitShares.accounts;
+    context.assets = BitShares.assets;
+    context.db = BitShares.db;
+    context.history = BitShares.history;
+    context.network = BitShares.network;
+    context.fees = BitShares.fees;
+  });
+
+  context.BitShares = BitShares;
+  context.btsdex = BitShares;
+  context.login = BitShares.login.bind(BitShares);
+  context.generateKeys = BitShares.generateKeys;
+}
+
+function connect(autoreconnect = true) {
+  let node = process.argv.includes("--node")
+    ? process.argv[process.argv.indexOf("--node") + 1]
+    : process.argv.includes("--testnet")
+    ? "wss://node.testnet.bitshares.eu"
+    : BitShares.node;
+
+  return BitShares.connect(node, autoreconnect).then(() =>
+    console.log(`Connected to API node: ${node}`)
+  );
+}
+
+function showError(error) {
+  console.log(`Error: ${error.message}`);
+  BitShares.disconnect();
+}
+
+if (process.argv.includes("--account")) {
+  let index = process.argv.indexOf("--account");
+
+  connect(false).then(() => {
+    BitShares.accounts[process.argv[index + 1]].then(result => {
+      console.log(JSON.stringify(result, null, 2));
+      BitShares.disconnect();
+    }, showError);
+  });
+} else if (process.argv.includes("--asset")) {
+  let index = process.argv.indexOf("--asset");
+
+  connect(false).then(() => {
+    BitShares.assets[process.argv[index + 1]].then(result => {
+      console.log(JSON.stringify(result, null, 2));
+      BitShares.disconnect();
+    }, showError);
+  });
+} else if (process.argv.includes("--block")) {
+  let index = process.argv.indexOf("--block");
+
+  connect(false).then(async () => {
+    let block_num =
+      process.argv[index + 1] ||
+      (await BitShares.db.get_dynamic_global_properties()).head_block_number;
+    BitShares.db.get_block(block_num).then(result => {
+      console.log(`block_num: ${block_num}`);
+      console.log(JSON.stringify(result, null, 2));
+      BitShares.disconnect();
+    }, showError);
+  });
+} else if (process.argv.includes("--object")) {
+  let index = process.argv.indexOf("--object");
+
+  connect(false).then(() => {
+    BitShares.db.get_objects([process.argv[index + 1]]).then(result => {
+      console.log(JSON.stringify(result[0], null, 2));
+      BitShares.disconnect();
+    }, showError);
+  });
+} else if (process.argv.includes("--history")) {
+  let index = process.argv.indexOf("--history"),
+    account_name = process.argv[index + 1],
+    limit = process.argv[index + 2],
+    start = process.argv[index + 3],
+    stop = process.argv[index + 4];
+
+  connect(false).then(async () => {
+    try {
+      let account = await BitShares.accounts[account_name];
+      let history = await BitShares.history.get_account_history(
+        account.id,
+        /^1.11.\d+$/.test(start) ? start : "1.11.0",
+        isNaN(limit) ? 100 : limit,
+        /^1.11.\d+$/.test(stop) ? stop : "1.11.0"
+      );
+      console.log(JSON.stringify(history, null, 2));
+    } catch (error) {
+      console.log(`Error: ${error.message}`);
+    }
+
+    BitShares.disconnect();
+  }, showError);
+} else if (process.argv.includes("--transfer")) {
+  let index = process.argv.indexOf("--transfer"),
+    from = process.argv[index + 1],
+    to = process.argv[index + 2],
+    amount = process.argv[index + 3],
+    asset = process.argv[index + 4].toUpperCase(),
+    isKey = process.argv.includes("--key");
+
+  connect(false).then(() => {
+    rl = readline.createInterface({
+      input: process.stdin,
+      output: mutableStdout,
+      terminal: true,
+    });
+
+    mutableStdout.muted = false;
+    rl.question(
+      `Enter the ${isKey ? "private key" : "password"}: `,
+      async answer => {
+        mutableStdout.muted = false;
+
+        try {
+          let account = isKey
+            ? new BitShares(from, answer)
+            : await BitShares.login(from, answer);
+
+          rl.question("Write memo: ", async memo => {
+            try {
+              await account.transfer(to, asset, amount, memo);
+              console.log(
+                `Transfered ${amount} ${asset} from '${from}' to '${to}' with memo '${memo}'`
+              );
+            } catch (error) {
+              console.log(`Error: ${error.message}`);
+            }
+
+            rl.close();
+            BitShares.disconnect();
+          });
+        } catch (error) {
+          console.log(`Error: ${error.message}`);
+          rl.close();
+          BitShares.disconnect();
+        }
+      }
+    );
+    mutableStdout.muted = true;
+  }, showError);
+} else {
+  const r = repl.start({ prompt: "> " });
+  initializeContext(r.context);
+
+  r.on("reset", initializeContext);
+}

package/claw/node_modules/btsdex/lib/account.js

@@ -0,0 +1,60 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _btsdexApi = require("btsdex-api");
+
+class Account {
+  static async getAccout(_name) {
+    let name = _name.toLowerCase();
+
+    if (this.map[name]) return this.map[name];
+    let acc = await _btsdexApi.database.getAccountByName(name);
+    if (!acc || acc.name !== name) throw new Error(`Not found account ${name}! Blockchain return ${acc ? acc.name : acc}`);
+    this.map[name] = new this(acc);
+    return this.map[name];
+  }
+
+  static async id(id) {
+    if (!isNaN(id)) id = `1.2.${id}`;
+    let name = Object.keys(this.map).find(name => this.map[name].id == id);
+    if (name) return this.map[name];
+    let acc = (await _btsdexApi.database.getAccounts([id]))[0];
+    if (!acc) throw new Error(`Not found account by id ${id}!`);
+    this.map[acc.name] = new this(acc);
+    return this.map[acc.name];
+  }
+
+  static async update() {
+    let allData = await _btsdexApi.database.getAccounts(Object.keys(this.map).map(name => this.map[name].id));
+    allData.forEach(rpcData => Object.assign(this.map[rpcData.name], rpcData));
+  }
+
+  constructor(rpcObj) {
+    Object.assign(this, rpcObj);
+  }
+
+  async update() {
+    Object.assign(this, (await _btsdexApi.database.getAccounts([id]))[0]);
+  }
+
+}
+
+(0, _defineProperty2.default)(Account, "map", {});
+
+var _default = new Proxy(Account, {
+  get(obj, name) {
+    if (obj[name]) return obj[name];
+    return /^1\.2\.\d+$/.test(name) || !isNaN(name) ? obj.id(name) : obj.getAccout(name);
+  }
+
+});
+
+exports.default = _default;