brave-intl / bat-client Goto Github PK

View Code? Open in Web Editor NEW

7.0 7.0 9.0 3.68 MB

An example of client code for the BAT.

License: Mozilla Public License 2.0

JavaScript 100.00%

bat-client's People

Contributors

Stargazers

Watchers

Forkers

nejczdovc rue-foundation monadicus ryanml fardog tmfrook isabella232 sathishvjd 0xt4req

bat-client's Issues

npm install fails if you don't have an ssh key

The root cause appears to be fixed in bitgojs
BitGo/BitGoJS@6b2296f
we should update when a new release is available

support POST /v1/batch/surveyor/voting in the ledger

requires brave-intl/bat-ledger#240 to be merged into master for staging & production; until then, run the https://github.com/brave-intl/bat-ledger/tree/support-batched-votes branch locally

Buffer to/from hex conversion code needs tests

also:

bat-client/index.js

Line 1261 in 2ed3fc7

Client.prototype.uint8tohex = function (uint8) {

can be simplified to just Buffer.from(uint8).toString('hex') i think?

bat-client requires seed type of Uint8Array if provided via state on init

Currently storage and (de)serialization of bat-client state, is handled by browser-laptop. Unfortunately this means we are exposing some internal concerns to browser-laptop.

One such concern is that the cryptographic seed is internally stored as a Uint8Array. Standard JSON serialization via JSON.stringify/JSON.parse is not invertible on Uint8Array objects. Since browser-laptop uses JSON.stringify for storing the seed, it needs to perform conditional fixup to ensure that it passes a Uint8Array to bat-client on init. https://github.com/brave/browser-laptop/blob/f6992aadba9c681302fe1cec3d0e28e222b3f62c/app/browser/api/ledger.js#L1590

That fixup is not currently being performed during restore of newClient which is used for continuing transition from BTC->BAT, causing brave/browser-laptop#11673

security checks are failing

npm run test shows a security error:

> nsp check

(+) 1 vulnerabilities found
┌───────────────┬─────────────────────────────────────────────────────────────┐
│               │ Large gzip Denial of Service                                │
├───────────────┼─────────────────────────────────────────────────────────────┤
│ Name          │ superagent                                                  │
├───────────────┼─────────────────────────────────────────────────────────────┤
│ CVSS          │ 3.7 (Low)                                                   │
├───────────────┼─────────────────────────────────────────────────────────────┤
│ Installed     │ 3.5.2                                                       │
├───────────────┼─────────────────────────────────────────────────────────────┤
│ Vulnerable    │ <3.7.0                                                      │
├───────────────┼─────────────────────────────────────────────────────────────┤
│ Patched       │ >=3.7.0                                                     │
├───────────────┼─────────────────────────────────────────────────────────────┤
│ Path          │ [email protected] > [email protected] > [email protected]          │
├───────────────┼─────────────────────────────────────────────────────────────┤
│ More Info     │ https://nodesecurity.io/advisories/479                      │
└───────────────┴─────────────────────────────────────────────────────────────┘

Be less strict about the version of node and npm

See:

add sanity check on the returned unsigned transaction

currently the bat-client blindly signs the transaction that is returned from the ledger server. better to be defensive and check that the amount matches expectations (<= self.state.properties.fee.amount)

integration tests are failing

found by @evq

#53 (comment)

the niceware backup phrase length can be reduced by half

Right now it is 64 bytes. It could safely be reduced to 32 bytes if you save only the seed which is used to derive the signing keypair. See https://github.com/brave/sync/blob/staging/lib/crypto.js#L119-L121 for an example.

IMO this is a worthwhile change to make for usability's sake. Users would only have to write down 16 words to backup/recover the keypair instead of 32 words.

shared bat-* methods should be split into a bat-common library

there's some methods duplicated among the bat-* repos (retryTrip for instance). these should be split into a shared library so that if there's a bug in one of these methods, it doesn't need to be fixed and reviewed multiple times.

public key recovery may be unsafe (depends on buffer allocation method)

bat-client/index.js

Line 464 in 2ed3fc7

    
           publicKey: self.uint8tohex(new Uint8Array(Buffer.from(octets.buffer, octets.length / 2)))

the correctness of this code depends on how Niceware does buffer allocation. for instance, this works the way we want it to:

var n = Buffer.alloc(4)
new Uint8Array(Buffer.from(n.buffer, n.length / 2)) // returns Uint8Array [ 0, 0 ] as expected

however, this code gives completely different results:

 n = new Buffer([0,0,0,0])
new Uint8Array(Buffer.from(n.buffer, n.length / 2)) // returns a 8190 length Uint8Array!

this is because the .buffer property refers to the ArrayBuffer property referenced by the Buffer at construction time. In the latter case, .buffer is the internal memory pool of the Buffer, which has default size 8192 bytes in node.

since Niceware's buffer allocation may change at any time, this code should not depend on it working the way it does right now.

BAT-Client is still trying to fetch rulesets

BAT-Client is still trying to fetch rulesets from
/v1/publisher/ruleset?consequential=true resulting in #goaway's

don't gitignore package-lock.json

This file is used to generate reproducible builds and it is recommended to check it into git: https://docs.npmjs.com/files/package-lock.json

is there any reason it's gitignored in this repo?

Promotion testing is disabled

Promotion test is being skipped due to #69 with fix required from #70. Reenable that test when staging promotion becomes available.

if contribution fails, further attempts will use the same surveyor until success

we should add a failout path such that we always try using the current surveyor, this allows for non-backwards compatible upgrades to surveyors

remove legacy bitcoin client code

Handle BAT-client recovery failure

Description

Handle BAT-client recovery failure

Steps to Reproduce

Install/upgrade to 0.19.39
Launch brave from console with LEDGER_VERBOSE=true
Ensure wallet is created
Click advanced setting, recover your wallet
Don't enter any values, click recover, ensure recovery failed message is showed, console logs the error

Actual result:

[ response for GET https://ledger.mercury.basicattentiontoken.org/v2/wallet/941ec251-3187-41fc-b10b-13bd62f6e2df?balance=true&refresh=true&amount=25&altcurrency=BAT ]
>>> HTTP/1.1 503
>>> cache-control: no-cache, no-store
>>> connection: keep-alive
>>> content-length: 506
>>> content-type: text/html; charset=utf-8
>>> date: Wed, 11 Oct 2017 07:33:19 GMT
>>> server: Cowboy
>>>
>>> <!DOCTYPE html>
>>>     <html>
>>>       <head>
>>>             <meta name="viewport" content="width=device-width, initial-scale=1">
>>>             <meta charset="utf-8">
>>>             <title>Application Error</title>
>>>             <style media="screen">
>>>               html,body,iframe {
>>>                     margin: 0;
>>>                     padding: 0;
>>>               }
>>>               html,body {
>>>                     height: 100%;
>>>                     overflow: hidden;
>>>               }
>>>               iframe {
>>>                     width: 100%;
>>>                     height: 100%;
>>>                     border: 0;
>>>               }
>>>             </style>
>>>       </head>
>>>       <body>
>>>             <iframe src="//www.herokucdn.com/error-pages/application-error.html"></iframe>
>>>       </body>
>>>     </html>
+++ busyP=true
<<< GET https://mercury-proxy.privateinternetaccess.com/v2/surveyor/voting/FSgBEh6UD%2Fw3Akir95Fz5h8n5Un6n%2FxudYsegnqkxAF/6a0af783a6240d18354e414b4e7beb9
<<< content-type: application/json; charset=utf-8
<<< accept-encoding:
<<<

Expected result:
Should handle the recovery scenario properly
Reproduces how often: [What percentage of the time does it reproduce?]
100%

Brave Version

about:brave info:

Brave	0.19.39
rev	ebcd280
Muon	4.4.27

Reproducible on current live release:

N/A

Additional Information

cc : @evq @NejcZdovc @mrose17

cc @diracdeltas @NejcZdovc @evq

metascraper appears to be an older (probably indirect) bat-publisher dependency

422 - persona credential exists

Per brave/browser-laptop#11495 (comment)
Ran into an issue while testing that PR... Here's what I did:

created branch new v1 wallet using Brave 0.18.x
switch to the PR branch / rm node_modules / npm install / etc and pointed it at the 0.18.x session
wallet upgrade shows as in progress 👍
I quit and relaunched a few times- I verified that ledger-newstate.json gets persisted before and after after sync 👍
I seem to be getting an error now, HTTP code 422

<<< POST https://ledger.mercury.basicattentiontoken.org/v2/registrar/persona/1ed2a2b0748089c8ccd81e7dac8c893
<<< content-type: application/json; charset=utf-8
<<< accept-encoding:
<<<
<<< {
<<<   "requestType": "httpSignature",
<<<   "request": {
<<<     "headers": {
<<<       "digest": "SHA-256=oe2fifEDcfI96boPcKaUUhe/HKWiuzyoBs10Gm+S4bg=",
<<<       "signature": "keyId=\"primary\",algorithm=\"ed25519\",headers=\"digest\",signature=\"vglrshpOIBjtoW6OBmW70pH7/RFK7vwzY+a3a9rDdwGxIU9VTBgj0Snm2AEHrqQUuR3mA+EX817oh/z/607FCg==\""
<<<     },
<<<     "body": {
<<<       "label": "4123099f-47e4-48ad-bc9f-6cdffebd81ed",
<<<       "currency": "BAT",
<<<       "publicKey": "429fb47298b7b058030c3d1bca1ca587585a81b1e47f0ecc9436e04306210043"
<<<     },
<<<     "octets": "{\"currency\":\"BAT\",\"label\":\"4123099f-47e4-48ad-bc9f-6cdffebd81ed\",\"publicKey\":\"429fb47298b7b058030c3d1bca1ca587585a81b1e47f0ecc9436e04306210043\"}"
<<<   },
<<<   "proof": "1ed2a2b0748089c8ccd81e7dac8c893\n7FxI5Yngr+RGK1uVGD9rWf/RMzpzMz2irqOoj6t9DOH 5xbHQ55+WSAbb5PjpJhKRGY/1u65rlE2BEXkt/HSBMe 1\n13D36D8a7pG56RdRGmI0NoNPY7AjP4YaYh+fTjIjFTv 8gwqQ7TkDtR9rJ6XNhQ6j5RpWY6CEbFKtCMPks4UmkM 1\n2YOcc2YrRugyGZOJrgDOGhBWwO/6+OsMCaJ0RbbjOx9\n5j3+EjAim1nxwiO7UbO8Gc17maim1QxYP5pMWTgUh2b 4WdiDvvTxgXwZc2xueVmFhnvAJ0CawmUaCDZ6Bsr5G5\n\n6PDzgyvawQBE+Ndu7yAV3XiGyV4gcnRKV74Q5QqQYvS 7i16apf3Fk4v3bdROu1fm9DEVrFRCFx0qhzY1woyJcB 1\nF5KSCVbKPt+9RXeAPt7WCaAwVjAeEf1UhxvsjhEYMTg\nBETV/Mnj5p0TjkQO6/MEbQrUPXdoRCXBfAH/fPDF+Ai 3UqevUsbtwxqNn9hVwaZeh13SlCYYDuaP9brmW9wz9n\n\n5wSFmTSkk3rgWr90uyHne1ZQ3c4xfsCuGMAPw0bHw56 4yIpZvGfdV+6pi0WMSZ55knoA1WJ0RK+dZdS2qXd01n 1\nEyxwGIpFJnew4/ltJlP9bmKSHIl/YOGai0VgBSxKVmm\n9cD1As+2yjj4+bgD56OlhDiRnihOvU4dgOtGskhfx8w 8RF3dVpPL0hSBfV1DM+VmDqNBBJw0qu0mDx2NvTFOcC\n\n3GdmB6jP/KLU/zk9ya2f0GO+O1rjkv/yiSKxDZm57XD 4P/fkCg3ka+pw0o+aByXOnx+CM9dkTNLi/nVVG6SHek 1\n3AmjLTzsgwrq7yy4VvobP6XC0YCINMGpdX+uEMEYcJ\nAjfAU8PaYhcZHNhBJtGUsnk1khsH1I9WS3mbYHmc3RK B1lMaDXW+LwBT7z4hK7QXarvMVO/7G4/uF482IAd0zA\n\n\n"
<<< }
[ response for POST https://ledger.mercury.basicattentiontoken.org/v2/registrar/persona/1ed2a2b0748089c8ccd81e7dac8c893 ]
>>> HTTP/1.1 422
>>> cache-control: no-cache
>>> connection: keep-alive
>>> content-length: 120
>>> content-type: application/json; charset=utf-8
>>> date: Fri, 13 Oct 2017 06:02:22 GMT
>>> server: Cowboy
>>> vary: accept-encoding
>>> via: 1.1 vegur
>>> x-rate-limit-limit: 60
>>> x-rate-limit-remaining: 59
>>> x-rate-limit-reset: 1507874601
>>>
>>> {"statusCode":422,"error":"Unprocessable Entity","message":"persona credential exists: 1ed2a2b0748089c8ccd81e7dac8c893"}
ledger client error(3): {}
Error: HTTP response 422 for POST /v2/registrar/persona/1ed2a2b0748089c8ccd81e7dac8c893
    at request.request (/Users/clifton/Documents/browser-laptop/app/browser/api/ledger.js:1491:9)
    at Function.defaultSession.webRequest.fetch (/Users/clifton/Documents/browser-laptop/js/lib/request.js:55:5)

look for HTTP code 410 in response to PUT /v2/wallet/{paymentId}

if the PUT call to /v2/wallet/{paymentId} sees HTTP code 410 immediately prior to https://github.com/brave-intl/bat-client/blob/master/index.js#L936 this indicates that the earlier call at https://github.com/brave-intl/bat-client/blob/master/index.js#L936 to get the current surveyor information is no longer valid.

instead of invoking the callback with an error, the client should fetch the new current surveyor and try again. however, to avoid looping, it should do this at most once.