sdk/node: use BigNumber for serializing amounts

Any numbers longer than 15 digits will be deserialized
into `BigNumber` objects (from BigNumber.js).

This represents a breaking change for anyone passing numbers
that large, but also numbers that larger were losing precision
under the current system.

Closes #3541

Author: Dominic Dagradi <ddagradi@gmail.com>
Date: Thu May 3 10:25:49 2018 -0700
upstream:22b59ddd385ab26623d55a1f2d4884cb92fd5390

Author: dominic

package-lock.json

@@ -24,6 +24,7 @@
     "ajv": "^6.4.0",
     "btoa": "^1.1.2",
     "fetch-ponyfill": "^3.0.2",
+    "json-bigint": "^0.2.3",
     "uuid": "~3.0.0"
   },
   "devDependencies": {

package.json

@@ -0,0 +1 @@
+declare module 'json-bigint'

src/@types/json-bigint/index.d.ts

@@ -1,3 +1,4 @@
+import { BigNumber } from 'bignumber.js'
 import { Client } from '../client'
 import { Page } from '../page'
 import { Query } from '../query'
@@ -49,15 +50,15 @@ export class TransactionBuilder {
    *
    * @param {Object} params - Action parameters.
    * @param {String} params.flavorId - ID of flavor to be issued.
-   * @param {String} params.amount - Amount of the flavor to be issued.
+   * @param {Number|BigNumber} params.amount - Amount of the flavor to be issued.
    * @param {String} params.destinationAccountId - Account ID specifying the
    *   account controlling the flavor.
    * @param {Object} params.tokenTags - Tags to add to the receiving tokens.
    * @param {Object} params.actionTags - Tags to add to the action.
    */
   public issue(params: {
     flavorId: string
-    amount: number
+    amount: number | BigNumber
     destinationAccountId: string
     tokenTags?: object
     actionTags?: object
@@ -73,15 +74,15 @@ export class TransactionBuilder {
    * @param {String} params.sourceAccountId - Account ID specifying the account
    *   controlling the flavor.
    * @param {String} params.flavorId - ID of flavor to be retired.
-   * @param {Number} params.amount - Amount of the flavor to be retired.
+   * @param {Number|BigNumber} params.amount - Amount of the flavor to be retired.
    * @param {String} params.filter - Token filter string, see {@link https://dashboard.seq.com/docs/filters}.
    * @param {Array<String|Number>} params.filterParams - Parameter values for filter string (if needed).
    * @param {Object} params.actionTags - Tags to add to the action.
    */
   public retire(params: {
     sourceAccountId: string
     flavorId: string
-    amount: number
+    amount: number | BigNumber
     filter?: string
     filterParams?: object
     actionTags?: object
@@ -98,7 +99,7 @@ export class TransactionBuilder {
    * @param {String} params.sourceAccountId - Account ID specifying the account
    *   controlling the flavor.
    * @param {String} params.flavorId - ID of flavor to be transferred.
-   * @param {Integer} params.amount - Amount of the flavor to be transferred.
+   * @param {Number|BigNumber} params.amount - Amount of the flavor to be transferred.
    * @param {String} params.destinationAccountId - Account ID specifying the
    *   account controlling the flavor.
    * @param {String} params.filter - Token filter string, see {@link https://dashboard.seq.com/docs/filters}.
@@ -109,7 +110,7 @@ export class TransactionBuilder {
   public transfer(params: {
     sourceAccountId: string
     flavorId: string
-    amount: number
+    amount: number | BigNumber
     destinationAccountId: string
     filter?: string
     filterParams?: object

src/api/transactions.ts

@@ -3,14 +3,15 @@
 // use the ponyfill for unsupported browsers.
 import * as uuid from 'uuid'
 
-// some ugly business to get the right types for fetch while still polyfilling
-const fetch: typeof window.fetch = require('fetch-ponyfill')().fetch
-const version: string = require('../package.json').version
 import { readFileSync } from 'fs'
 import { Agent } from 'https'
 import { errors } from './errors'
 
 const crypto = require('crypto')
+// some ugly business to get the right types for fetch while still polyfilling
+const fetch: typeof window.fetch = require('fetch-ponyfill')().fetch
+const JSONbig = require('json-bigint')
+const version: string = require('../package.json').version
 
 const userJsonAttributes = [
   'account_tags',
@@ -207,7 +208,7 @@ export class Connection {
     const req: any = {
       method: 'POST',
       headers,
-      body: JSON.stringify(snakeBody),
+      body: JSONbig.stringify(snakeBody),
     }
 
     if (this.agent) {
@@ -246,7 +247,8 @@ export class Connection {
 
     let body
     try {
-      body = await resp.json()
+      const text = await resp.text()
+      body = JSONbig.parse(text)
       body = filterLegacyData(body)
     } catch {
       throw new errors.JsonError(resp)

src/connection.ts

@@ -72,7 +72,9 @@ ajv.addSchema(
   {
     properties: {
       actionTags: { type: 'object' },
-      amount: { type: 'number' },
+      amount: {
+        anyOf: [{ type: 'number' }, { type: 'object' }],
+      },
       destinationAccountId: { type: 'string' },
       filter: { type: 'string' },
       filterParams: { type: 'array' },
@@ -89,7 +91,9 @@ ajv.addSchema(
   {
     properties: {
       actionTags: { type: 'object' },
-      amount: { type: 'number' },
+      amount: {
+        anyOf: [{ type: 'number' }, { type: 'object' }],
+      },
       destinationAccountId: { type: 'string' },
       flavorId: { type: 'string' },
       tokenTags: { type: 'object' },
@@ -103,7 +107,9 @@ ajv.addSchema(
   {
     properties: {
       actionTags: { type: 'object' },
-      amount: { type: 'number' },
+      amount: {
+        anyOf: [{ type: 'number' }, { type: 'object' }],
+      },
       filter: { type: 'string' },
       filterParams: { type: 'array' },
       flavorId: { type: 'string' },

src/validate.ts

@@ -9,6 +9,7 @@ import * as uuid from 'uuid'
 chai.use(chaiAsPromised)
 const expect = chai.expect
 
+import { BigNumber } from 'bignumber.js'
 import { testHelpers } from './testHelpers'
 
 const {
@@ -73,6 +74,38 @@ describe('Transaction', () => {
       assert.deepEqual(items[0].tags, actionTags)
       assert.deepEqual(items[0].type, 'issue')
     })
+
+    it('handles large numbers', async () => {
+      const gold = await createFlavor('gold')
+      const alice = await createAccount('alice')
+      const amount = '9223372036854775807'
+
+      const tx = await client.transactions.transact(builder => {
+        builder.issue({
+          flavorId: gold.id,
+          amount: new BigNumber(amount),
+          destinationAccountId: alice.id,
+        })
+      })
+
+      assert.equal(amount, tx.actions[0].amount.toString())
+    })
+
+    it('throws an error at the amount boundary', async () => {
+      const gold = await createFlavor('gold')
+      const alice = await createAccount('alice')
+      const amount = '9223372036854775808'
+
+      expect(
+        client.transactions.transact(builder => {
+          builder.issue({
+            flavorId: gold.id,
+            amount: new BigNumber(amount),
+            destinationAccountId: alice.id,
+          })
+        })
+      ).to.be.rejectedWith('SEQ706')
+    })
   })
 
   describe('Transfer', () => {