Skip to content
This repository has been archived by the owner on Dec 11, 2019. It is now read-only.

Bitcoin exchange extravaganza #3824

Closed
wants to merge 7 commits into from
Closed

Bitcoin exchange extravaganza #3824

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3fd4388
Merge branch 'master' into bitcoin-exchange-extravaganza
mrose17 Sep 8, 2016
9a82279
Merge branch 'master' into bitcoin-exchange-extravaganza
mrose17 Sep 8, 2016
a96825d
Merge branch 'master' into bitcoin-exchange-extravaganza
mrose17 Sep 8, 2016
5d9255b
add geoIP & BTC exchange information
mrose17 Sep 8, 2016
2b99cf4
Merge branch 'master' into bitcoin-exchange-extravaganza
mrose17 Sep 8, 2016
59e4385
update docs/state.md
mrose17 Sep 8, 2016
eb5bdd8
fixes based on review
mrose17 Sep 8, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 52 additions & 23 deletions app/ledger.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ const session = electron.session
const acorn = require('acorn')
const ledgerBalance = require('ledger-balance')
const ledgerClient = require('ledger-client')
const ledgerGeoIP = require('ledger-geoip')
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please remove all providers in https://github.com/brave/ledger-geoip/blob/master/index.js that do not offer HTTPS

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

const ledgerPublisher = require('ledger-publisher')
const qr = require('qr-image')
const random = require('random-lib')
Expand Down Expand Up @@ -117,10 +118,11 @@ var init = () => {
try {
ledgerInfo._internal.debugP = ledgerClient.prototype.boolion(process.env.LEDGER_CLIENT_DEBUG)
publisherInfo._internal.debugP = ledgerClient.prototype.boolion(process.env.LEDGER_PUBLISHER_DEBUG)
publisherInfo._internal.verboseP = ledgerClient.prototype.boolion(process.env.LEDGER_PUBLISHER_VERBOSE)

appDispatcher.register(doAction)
initialize(getSetting(settings.PAYMENTS_ENABLED))
} catch (ex) { console.log('initialization failed: ' + ex.toString() + '\n' + ex.stack) }
} catch (ex) { console.log('ledger.js initialization failed: ' + ex.toString() + '\n' + ex.stack) }
}

var quit = () => {
Expand Down Expand Up @@ -178,7 +180,7 @@ if (ipc) {
ctx = url.parse(location, true)
ctx.TLD = tldjs.getPublicSuffix(ctx.host)
if (!ctx.TLD) {
console.log('\nno TLD for:' + ctx.host)
if (publisherInfo._internal.verboseP) console.log('\nno TLD for:' + ctx.host)
event.returnValue = {}
return
}
Expand Down Expand Up @@ -269,11 +271,11 @@ eventStore.addChangeListener(() => {
request.request({ url: url, responseType: 'blob' }, (err, response, blob) => {
var matchP, prefix, tail

/*
console.log('\nresponse: ' + url +
' errP=' + (!!err) + ' blob=' + (blob || '').substr(0, 80) + '\nresponse=' +
JSON.stringify(response, null, 2))
*/
if (publisherInfo._internal.debugP) {
console.log('\nresponse: ' + url +
' errP=' + (!!err) + ' blob=' + (blob || '').substr(0, 80) + '\nresponse=' +
JSON.stringify(response, null, 2))
}

if (err) return console.log('response error: ' + err.toString() + '\n' + err.stack)

Expand Down Expand Up @@ -303,20 +305,18 @@ eventStore.addChangeListener(() => {

entry.faviconURL = blob
updatePublisherInfo()
/*
console.log('\n' + publisher + ' synopsis=' +
JSON.stringify(underscore.extend(underscore.omit(entry, [ 'faviconURL', 'window' ]),
{ faviconURL: entry.faviconURL && '... ' }), null, 2))
*/
if (publisherInfo._internal.debugP) {
console.log('\n' + publisher + ' synopsis=' +
JSON.stringify(underscore.extend(underscore.omit(entry, [ 'faviconURL', 'window' ]),
{ faviconURL: entry.faviconURL && '... ' }), null, 2))
}
})
}

faviconURL = page.faviconURL || entry.protocol + '//' + url.parse(location).host + '/favicon.ico'
entry.faviconURL = null

/*
console.log('request: ' + faviconURL)
*/
if (publisherInfo._internal.debugP) console.log('request: ' + faviconURL)
fetch(faviconURL)
}
})
Expand Down Expand Up @@ -390,14 +390,14 @@ var enable = (onoff) => {

synopsis = new (ledgerPublisher.Synopsis)()
fs.readFile(pathName(synopsisPath), (err, data) => {
if (clientOptions.verboseP) console.log('\nstarting up ledger publisher integration')
if (publisherInfo._internal.verboseP) console.log('\nstarting up ledger publisher integration')

if (err) {
if (err.code !== 'ENOENT') console.log('synopsisPath read error: ' + err.toString())
return updatePublisherInfo()
}

if (clientOptions.verboseP) console.log('\nfound ' + pathName(synopsisPath))
if (publisherInfo._internal.verboseP) console.log('\nfound ' + pathName(synopsisPath))
try {
synopsis = new (ledgerPublisher.Synopsis)(data)
} catch (ex) {
Expand All @@ -418,7 +418,7 @@ var enable = (onoff) => {
return
}

if (clientOptions.verboseP) console.log('\nfound ' + pathName(publisherPath))
if (publisherInfo._internal.verboseP) console.log('\nfound ' + pathName(publisherPath))
try {
data = JSON.parse(data)
underscore.keys(data).sort().forEach((publisher) => {
Expand Down Expand Up @@ -585,7 +585,7 @@ var visit = (location, timestamp) => {

if (!synopsis) return

if (publisherInfo._internal.debugP) {
if (publisherInfo._internal.verboseP) {
console.log('locations[' + currentLocation + ']=' + JSON.stringify(locations[currentLocation], null, 2) +
' duration=' + (timestamp - currentTimestamp) + ' msec')
}
Expand All @@ -598,7 +598,7 @@ var visit = (location, timestamp) => {
publishers[publisher][currentLocation] = timestamp

duration = timestamp - currentTimestamp
if (publisherInfo._internal.debugP) console.log('\nadd publisher ' + publisher + ': ' + duration + ' msec')
if (publisherInfo._internal.verboseP) console.log('\nadd publisher ' + publisher + ': ' + duration + ' msec')
synopsis.addPublisher(publisher, duration)
updatePublisherInfo()
}
Expand Down Expand Up @@ -675,7 +675,7 @@ var cacheRuleSet = (ruleset) => {
if ((rule.consequent !== null) || (rule.dom)) return
if (!rulesolver.resolve(rule.condition, ctx)) return

if (clientOptions.verboseP) console.log('\npurging ' + publisher)
if (publisherInfo._internal.verboseP) console.log('\npurging ' + publisher)
delete synopsis.publishers[publisher]
syncP = true
})
Expand Down Expand Up @@ -729,7 +729,7 @@ var ledgerInfo = {
*/
],

// set from ledger client's state.paymentInfo OR client's getWalletProperties
// set from ledger client's state.paymentInfo OR client's getWalletProperties
// Bitcoin wallet address
address: undefined,

Expand All @@ -749,7 +749,15 @@ var ledgerInfo = {

hasBitcoinHandler: false,

_internal: {},
// geoIP/exchange information
countryCode: undefined,
exchangeInfo: undefined,

_internal: {
exchangeExpiry: 0,
exchanges: {},
geoipExpiry: 0
},
error: null
}

Expand All @@ -764,6 +772,27 @@ var updateLedgerInfo = () => {
underscore.extend(ledgerInfo, ledgerInfo._internal.cache || {})
}

if ((client) && (now > ledgerInfo._internal.geoipExpiry)) {
ledgerInfo._internal.geoipExpiry = now + (5 * msecs.minute)
return ledgerGeoIP.getGeoIP(client.options, (err, provider, result) => {
if (err) console.log('ledger geoip warning: ' + JSON.stringify(err, null, 2))
if (result) ledgerInfo.countryCode = result

ledgerInfo.exchangeInfo = ledgerInfo._internal.exchanges[ledgerInfo.countryCode]

if (now <= ledgerInfo._internal.exchangeExpiry) return updateLedgerInfo()

ledgerInfo._internal.exchangeExpiry = now + msecs.day
roundtrip({ path: '/v1/exchange/providers' }, client.options, (err, response, body) => {
if (err) console.log('ledger exchange error: ' + JSON.stringify(err, null, 2))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this return if there's an error? or is this just a warning?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it is actually, just a warning!


ledgerInfo._internal.exchanges = body || {}
ledgerInfo.exchangeInfo = ledgerInfo._internal.exchanges[ledgerInfo.countryCode]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make sure ledgerInfo._internal.exchanges is not null/undefined

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

updateLedgerInfo()
})
})
}

if (ledgerInfo._internal.debugP) {
console.log('\nupdateLedgerInfo: ' + JSON.stringify(underscore.omit(ledgerInfo, [ '_internal' ]), null, 2))
}
Expand Down
10 changes: 8 additions & 2 deletions docs/state.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -435,8 +435,14 @@ WindowStore
}
},
hasBitcoinHandler: boolean, // brave browser has a `bitcoin:` URI handler
paymentIMG: string, // the QR code equivalent of `paymentURL` expressed as "data:image/...;base64,..."
error: { // non-null if the last updateLedgerInfo happened concurrently with an error
countryCode: string, // ISO3166 2-letter code for country of browser's location
exchangeInfo: { // information about corresponding "friendliest" BTC exchange (suggestions welcome!)
titleText: string, // e.g., 'Create an account on ...'
buttonText: string, // e.g., 'Create'
buttonURL: string, // where the button should take the browser
Copy link
Member

@diracdeltas diracdeltas Sep 8, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will the title text and button text be localized? if not, better to just return some sort of key for the exchange, not the text itself so that the front-end can localize it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks like https://ledger.brave.com/v1/exchange/providers is not localized, so take out 'buttonText' and 'titleText' and just add a property for the name of the exchange.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i suspect that localization has to occur in the browser in the ui subsystem.

is there really a better key than just a text string? both buttonText and titleText can be used as the key values. am i missing something?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just send the name of the exchange, the front-end takes care of localization

}
paymentIMG: string, // the QR code equivalent of `paymentURL` expressed as "data:image/...;base64,..."
error: { // non-null if the last updateLedgerInfo happened concurrently with an error
caller: string // function in which error was handled
error: object // error object returned
}
Expand Down
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@
"l20n": "^3.5.1",
"ledger-balance": "^0.8.46",
"ledger-client": "^0.8.59",
"ledger-geoip": "https://github.com/brave/ledger-geoip.git",
"ledger-publisher": "^0.8.58",
"lru_cache": "^1.0.0",
"qr-image": "^3.1.0",
Expand Down