|
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html lang="en">
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8">
|
|
|
|
|
<title>JSDoc: Source: bip70/paymentdetails.js</title>
|
|
|
|
|
|
|
|
|
|
<script src="scripts/prettify/prettify.js"> </script>
|
|
|
|
|
<script src="scripts/prettify/lang-css.js"> </script>
|
|
|
|
|
<!--[if lt IE 9]>
|
|
|
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
|
|
|
<![endif]-->
|
|
|
|
|
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
|
|
|
|
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
|
|
|
|
|
<div id="main">
|
|
|
|
|
|
|
|
|
|
<h1 class="page-title">Source: bip70/paymentdetails.js</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
|
|
|
<article>
|
|
|
|
|
<pre class="prettyprint source linenums"><code>/*!
|
|
|
|
|
* paymentdetails.js - bip70 paymentdetails for bcoin
|
|
|
|
|
* Copyright (c) 2016-2017, Christopher Jeffrey (MIT License).
|
|
|
|
|
* https://github.com/bcoin-org/bcoin
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
'use strict';
|
|
|
|
|
|
|
|
|
|
var assert = require('assert');
|
|
|
|
|
var util = require('../utils/util');
|
|
|
|
|
var Output = require('../primitives/output');
|
|
|
|
|
var protobuf = require('../utils/protobuf');
|
|
|
|
|
var ProtoReader = protobuf.ProtoReader;
|
|
|
|
|
var ProtoWriter = protobuf.ProtoWriter;
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Represents BIP70 payment details.
|
|
|
|
|
* @alias module:bip70.PaymentDetails
|
|
|
|
|
* @constructor
|
|
|
|
|
* @param {Object?} options
|
|
|
|
|
* @property {String|null} network
|
|
|
|
|
* @property {Output[]} outputs
|
|
|
|
|
* @property {Number} time
|
|
|
|
|
* @property {Number} expires
|
|
|
|
|
* @property {String|null} memo
|
|
|
|
|
* @property {String|null} paymentUrl
|
|
|
|
|
* @property {Buffer|null} merchantData
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
function PaymentDetails(options) {
|
|
|
|
|
if (!(this instanceof PaymentDetails))
|
|
|
|
|
return new PaymentDetails(options);
|
|
|
|
|
|
|
|
|
|
this.network = null;
|
|
|
|
|
this.outputs = [];
|
|
|
|
|
this.time = util.now();
|
|
|
|
|
this.expires = -1;
|
|
|
|
|
this.memo = null;
|
|
|
|
|
this.paymentUrl = null;
|
|
|
|
|
this.merchantData = null;
|
|
|
|
|
|
|
|
|
|
if (options)
|
|
|
|
|
this.fromOptions(options);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Inject properties from options.
|
|
|
|
|
* @private
|
|
|
|
|
* @param {Object} options
|
|
|
|
|
* @returns {PaymentDetails}
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
PaymentDetails.prototype.fromOptions = function fromOptions(options) {
|
|
|
|
|
var i, output;
|
|
|
|
|
|
|
|
|
|
if (options.network != null) {
|
|
|
|
|
assert(typeof options.network === 'string');
|
|
|
|
|
this.network = options.network;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (options.outputs) {
|
|
|
|
|
assert(Array.isArray(options.outputs));
|
|
|
|
|
for (i = 0; i < options.outputs.length; i++) {
|
|
|
|
|
output = new Output(options.outputs[i]);
|
|
|
|
|
this.outputs.push(output);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (options.time != null) {
|
|
|
|
|
assert(util.isNumber(options.time));
|
|
|
|
|
this.time = options.time;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (options.expires != null) {
|
|
|
|
|
assert(util.isNumber(options.expires));
|
|
|
|
|
this.expires = options.expires;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (options.memo != null) {
|
|
|
|
|
assert(typeof options.memo === 'string');
|
|
|
|
|
this.memo = options.memo;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (options.paymentUrl != null) {
|
|
|
|
|
assert(typeof options.paymentUrl === 'string');
|
|
|
|
|
this.paymentUrl = options.paymentUrl;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (options.merchantData)
|
|
|
|
|
this.setData(options.merchantData);
|
|
|
|
|
|
|
|
|
|
return this;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Instantiate payment details from options.
|
|
|
|
|
* @param {Object} options
|
|
|
|
|
* @returns {PaymentDetails}
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
PaymentDetails.fromOptions = function fromOptions(options) {
|
|
|
|
|
return new PaymentDetails().fromOptions(options);
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Test whether the payment is expired.
|
|
|
|
|
* @returns {Boolean}
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
PaymentDetails.prototype.isExpired = function isExpired() {
|
|
|
|
|
if (this.expires === -1)
|
|
|
|
|
return false;
|
|
|
|
|
return util.now() > this.expires;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Set payment details.
|
|
|
|
|
* @param {Object} data
|
|
|
|
|
* @param {String?} enc
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
PaymentDetails.prototype.setData = function setData(data, enc) {
|
|
|
|
|
if (data == null || Buffer.isBuffer(data)) {
|
|
|
|
|
this.merchantData = data;
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (typeof data !== 'string') {
|
|
|
|
|
assert(!enc || enc === 'json');
|
|
|
|
|
this.merchantData = new Buffer(JSON.stringify(data), 'utf8');
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
this.merchantData = new Buffer(data, enc);
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Get payment details.
|
|
|
|
|
* @param {String?} enc
|
|
|
|
|
* @returns {String|Object|null}
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
PaymentDetails.prototype.getData = function getData(enc) {
|
|
|
|
|
var data = this.merchantData;
|
|
|
|
|
|
|
|
|
|
if (!data)
|
|
|
|
|
return;
|
|
|
|
|
|
|
|
|
|
if (!enc)
|
|
|
|
|
return data;
|
|
|
|
|
|
|
|
|
|
if (enc === 'json') {
|
|
|
|
|
data = data.toString('utf8');
|
|
|
|
|
try {
|
|
|
|
|
data = JSON.parse(data);
|
|
|
|
|
} catch (e) {
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
return data;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return data.toString(enc);
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Inject properties from serialized data.
|
|
|
|
|
* @private
|
|
|
|
|
* @param {Buffer} data
|
|
|
|
|
* @returns {PaymentDetails}
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
PaymentDetails.prototype.fromRaw = function fromRaw(data) {
|
|
|
|
|
var br = new ProtoReader(data);
|
|
|
|
|
var op, output;
|
|
|
|
|
|
|
|
|
|
this.network = br.readFieldString(1, true);
|
|
|
|
|
|
|
|
|
|
while (br.nextTag() === 2) {
|
|
|
|
|
op = new ProtoReader(br.readFieldBytes(2));
|
|
|
|
|
output = new Output();
|
|
|
|
|
output.value = op.readFieldU64(1, true);
|
|
|
|
|
output.script.fromRaw(op.readFieldBytes(2, true));
|
|
|
|
|
this.outputs.push(output);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
this.time = br.readFieldU64(3);
|
|
|
|
|
this.expires = br.readFieldU64(4, true);
|
|
|
|
|
this.memo = br.readFieldString(5, true);
|
|
|
|
|
this.paymentUrl = br.readFieldString(6, true);
|
|
|
|
|
this.merchantData = br.readFieldBytes(7, true);
|
|
|
|
|
|
|
|
|
|
return this;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Instantiate payment details from serialized data.
|
|
|
|
|
* @param {Buffer} data
|
|
|
|
|
* @returns {PaymentDetails}
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
PaymentDetails.fromRaw = function fromRaw(data, enc) {
|
|
|
|
|
if (typeof data === 'string')
|
|
|
|
|
data = new Buffer(data, enc);
|
|
|
|
|
return new PaymentDetails().fromRaw(data);
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Serialize the payment details (protobuf).
|
|
|
|
|
* @returns {Buffer}
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
PaymentDetails.prototype.toRaw = function toRaw() {
|
|
|
|
|
var bw = new ProtoWriter();
|
|
|
|
|
var i, op, output;
|
|
|
|
|
|
|
|
|
|
if (this.network != null)
|
|
|
|
|
bw.writeFieldString(1, this.network);
|
|
|
|
|
|
|
|
|
|
for (i = 0; i < this.outputs.length; i++) {
|
|
|
|
|
output = this.outputs[i];
|
|
|
|
|
op = new ProtoWriter();
|
|
|
|
|
op.writeFieldU64(1, output.value);
|
|
|
|
|
op.writeFieldBytes(2, output.script.toRaw());
|
|
|
|
|
bw.writeFieldBytes(2, op.render());
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
bw.writeFieldU64(3, this.time);
|
|
|
|
|
|
|
|
|
|
if (this.expires !== -1)
|
|
|
|
|
bw.writeFieldU64(4, this.expires);
|
|
|
|
|
|
|
|
|
|
if (this.memo != null)
|
|
|
|
|
bw.writeFieldString(5, this.memo);
|
|
|
|
|
|
|
|
|
|
if (this.paymentUrl != null)
|
|
|
|
|
bw.writeFieldString(6, this.paymentUrl);
|
|
|
|
|
|
|
|
|
|
if (this.merchantData)
|
|
|
|
|
bw.writeFieldString(7, this.merchantData);
|
|
|
|
|
|
|
|
|
|
return bw.render();
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Expose
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
module.exports = PaymentDetails;
|
|
|
|
|
</code></pre>
|
|
|
|
|
</article>
|
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<nav>
|
|
|
|
|
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-bcoin.html">bcoin</a></li><li><a href="module-bip70.html">bip70</a></li><li><a href="module-bip70_pk.html">bip70/pk</a></li><li><a href="module-bip70_x509.html">bip70/x509</a></li><li><a href="module-blockchain.html">blockchain</a></li><li><a href="module-blockchain_common.html">blockchain/common</a></li><li><a href="module-btc.html">btc</a></li><li><a href="module-coins.html">coins</a></li><li><a href="module-crypto.html">crypto</a></li><li><a href="module-crypto_chachapoly.html">crypto/chachapoly</a></li><li><a href="module-crypto_ec.html">crypto/ec</a></li><li><a href="module-crypto_pk.html">crypto/pk</a></li><li><a href="module-crypto_schnorr.html">crypto/schnorr</a></li><li><a href="module-crypto_siphash.html">crypto/siphash</a></li><li><a href="module-db.html">db</a></li><li><a href="module-hd.html">hd</a></li><li><a href="module-http.html">http</a></li><li><a href="module-mempool.html">mempool</a></li><li><a href="module-mining.html">mining</a></li><li><a href="module-net.html">net</a></li><li><a href="module-net_bip152.html">net/bip152</a></li><li><a href="module-net_common.html">net/common</a></li><li><a href="module-net_dns.html">net/dns</a></li><li><a href="module-net_packets.html">net/packets</a></li><li><a href="module-net_socks.html">net/socks</a></li><li><a href="module-net_tcp.html">net/tcp</a></li><li><a href="module-node.html">node</a></li><li><a href="module-node_config.html">node/config</a></li><li><a href="module-primitives.html">primitives</a></li><li><a href="module-protocol.html">protocol</a></li><li><a href="module-protocol_consensus.html">protocol/consensus</a></li><li><a href="module-protocol_errors.html">protocol/errors</a></li><li><a href="module-protocol_networks.html">protocol/networks</a></li><li><a href="module-protocol_policy.html">protocol/policy</a></li><li><a href="module-script.html">script</a></li><li><a href="module-script_common.html">script/common</a></li><li><a href="module-utils.html">utils</a></li><li><a href="module-utils_asn1.html">utils/asn1</a></li><li><a href="module-utils_base32.html">utils/base32</a></li><li><a href="module-utils_base58.html">utils/base58</a></li><li><a href="module-utils_co.html">utils/co</a></li><li><a href="module-utils_encoding.html">utils/encoding</a></li><li><a href="module-utils_ip.html">utils/ip</a></li><li><a href="module-utils_pem.html">utils/pem</a></li><li><a href="module-utils_protobuf.html">utils/protobuf</a></li><li><a href="module-utils_util.html">utils/util</a></li><li><a href="module-wallet.html">wallet</a></li><li><a href="module-wallet_common.html">wallet/common</a></li><li><a href="module-wallet_records.html">wallet/records</a></li><li><a href="module-workers.html">workers</a></li><li><a href="module-workers_jobs.html">workers/jobs</a></li><li><a href="module-workers_packets.html">workers/packets</a></li></ul><h3>Classes</h3><ul><li><a href="Environment.html">Environment</a></li><li><a href="module-bip70.Payment.html">Payment</a></li><li><a href="module-bip70.PaymentACK.html">PaymentACK</a></li><li><a href="module-bip70.PaymentDetails.html">PaymentDetails</a></li><li><a href="module-bip70.PaymentRequest.html">PaymentRequest</a></li><li><a href="module-blockchain.Chain.html">Chain</a></li><li><a href="module-blockchain.ChainDB.html">ChainDB</a></li><li><a href="module-blockchain.ChainEntry.html">ChainEntry</a></li><li><a href="module-blockchain.ChainFlags.html">ChainFlags</a></li><li><a href="module-blockchain.ChainOptions.html">ChainOptions</a></li><li><a href="module-blockchain.ChainState.html">ChainState</a></li><li><a href="module-blockchain.DeploymentState.html">DeploymentState</a></li><li><a href="module-blockchain.StateCache.html">StateCache</a></li><li><a href="module-btc.Amount.html">Amount</a></li><li><a href="module-btc.URI.html">URI</a></li><li><a href="module-coins.CoinEntry.html">CoinEntry</a></li><li><a href="module-coins.Coins.html">Coins</a></li><li><a href="module-coins.CoinView.html">CoinView</a></li><li><a href="module-coins.UndoCoi
|
|
|
|
|
</nav>
|
|
|
|
|
|
|
|
|
|
<br class="clear">
|
|
|
|
|
|
|
|
|
|
<footer>
|
|
|
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Fri Feb 10 2017 09:40:23 GMT-0800 (PST)
|
|
|
|
|
</footer>
|
|
|
|
|
|
|
|
|
|
<script> prettyPrint(); </script>
|
|
|
|
|
<script src="scripts/linenumber.js"> </script>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
