/*! * input.js - input object for bcoin * Copyright (c) 2014-2015, Fedor Indutny (MIT License) * Copyright (c) 2014-2016, Christopher Jeffrey (MIT License). * https://github.com/bcoin-org/bcoin */ 'use strict'; var bcoin = require('./env'); var utils = require('./utils'); var assert = utils.assert; var constants = bcoin.protocol.constants; function Outpoint(hash, index) { if (!(this instanceof Outpoint)) return new Outpoint(hash, index); this.hash = hash || null; this.index = index != null ? index : null; } Outpoint.prototype.fromOptions = function fromOptions(data) { this.hash = data.hash; this.index = data.index; assert(typeof this.hash === 'string'); assert(typeof this.index === 'number'); return this; }; Outpoint.fromOptions = function fromOptions(data) { if (data instanceof Outpoint) return data; return new Outpoint().fromOptions(data); }; Outpoint.prototype.fromRaw = function fromRaw(data) { var p = bcoin.reader(data); this.hash = p.readHash('hex'); this.index = p.readU32(); return this; }; Outpoint.fromRaw = function fromRaw(data) { return new Outpoint().fromRaw(data); }; Outpoint.prototype.toRaw = function toRaw(writer) { var p = bcoin.writer(writer); p.writeHash(this.hash); p.writeU32(this.index); if (!writer) p = p.render(); return p; }; Outpoint.prototype.fromJSON = function fromJSON(json) { this.hash = utils.revHex(json.hash); this.index = json.index; return this; }; Outpoint.fromJSON = function fromJSON(json) { return new Outpoint().fromJSON(json); }; Outpoint.prototype.fromTX = function fromTX(tx, i) { this.hash = tx.hash('hex'); this.index = i; return this; }; Outpoint.fromTX = function fromTX(tx, i) { return new Outpoint().fromTX(tx, i); }; Outpoint.prototype.toJSON = function toJSON() { return { hash: utils.revHex(this.hash), index: this.index }; }; Outpoint.prototype.inspect = function inspect() { return ''; }; /** * Represents a transaction input. * @exports Input * @constructor * @param {NakedInput} options * @param {Boolean?} mutable * @property {Object} prevout - Outpoint. * @property {Hash} prevout.hash - Previous transaction hash. * @property {Number} prevout.index - Previous output index. * @property {Script} script - Input script / scriptSig. * @property {Number} sequence - nSequence. * @property {Witness} witness - Witness (empty if not present). * @property {Coin?} coin - Previous output. * @property {String} type - Script type. * @property {String?} address - Input address. * @property {Boolean} mutable */ function Input(options, mutable) { if (!(this instanceof Input)) return new Input(options, mutable); this.mutable = false; this.prevout = null; this.script = null; this.sequence = null; this.witness = null; this.coin = null; if (options) this.fromOptions(options, mutable); } Input.prototype.fromOptions = function fromOptions(options, mutable) { assert(options, 'Input data is required.'); this.mutable = !!mutable; this.prevout = Outpoint.fromOptions(options.prevout); this.script = bcoin.script(options.script); this.sequence = options.sequence == null ? 0xffffffff : options.sequence; this.witness = bcoin.witness(options.witness); this.coin = null; if (options.coin) this.coin = bcoin.coin(options.coin); assert(typeof this.prevout === 'object'); assert(typeof this.prevout.hash === 'string'); assert(typeof this.prevout.index === 'number'); assert(typeof this.sequence === 'number'); return this; }; Input.fromOptions = function fromOptions(options) { return new Input().fromOptions(options); }; /** * Get the previous output script type. Will "guess" * based on the input script and/or witness if coin * is not available. * @returns {String} type */ Input.prototype.getType = function getType() { var type; if (this.isCoinbase()) return 'coinbase'; if (this.coin) return this.coin.getType(); if (this._type) return this._type; if (this.witness.items.length > 0) type = this.witness.getInputType(); if (!type || type === 'unknown') type = this.script.getInputType(); if (!this.mutable) this._type = type; return type; }; /** * Get the redeem script. Will attempt to resolve nested * redeem scripts if witnessscripthash is behind a scripthash. * @returns {Script?} Redeem script. */ Input.prototype.getRedeem = function getRedeem() { var redeem, prev; if (this.isCoinbase()) return; if (!this.coin) { if (this.script.isScripthashInput()) { redeem = this.script.getRedeem(); if (redeem && redeem.isWitnessScripthash()) redeem = this.witness.getRedeem(); return redeem; } if (this.witness.isScripthashInput()) return this.witness.getRedeem(); return; } prev = this.coin.script; if (prev.isScripthash()) { prev = this.script.getRedeem(); redeem = prev; } if (prev && prev.isWitnessScripthash()) { prev = this.witness.getRedeem(); redeem = prev; } return redeem; }; /** * Get the redeem script type. * @returns {String} subtype */ Input.prototype.getSubtype = function getSubtype() { var redeem; if (this.isCoinbase()) return; redeem = this.getRedeem(); if (!redeem) return; return redeem.getType(); }; /** * Get the previous output script's address. Will "guess" * based on the input script and/or witness if coin * is not available. * @returns {Address?} address */ Input.prototype.getAddress = function getAddress() { var address; if (this.isCoinbase()) return; if (this.coin) return this.coin.getAddress(); if (this._address) return this._address; if (this.witness.items.length > 0) address = this.witness.getInputAddress(); if (!address) address = this.script.getInputAddress(); if (!this.mutable) this._address = address; return address; }; /** * Get the address hash. * @param {String?} enc * @returns {Hash} hash */ Input.prototype.getHash = function getHash(enc) { var address = this.getAddress(); if (!address) return; return address.getHash(enc); }; /** * Test to see if nSequence is equal to uint32max. * @returns {Boolean} */ Input.prototype.isFinal = function isFinal() { return this.sequence === 0xffffffff; }; /** * Test to see if outpoint hash is null. * @returns {Boolean} */ Input.prototype.isCoinbase = function isCoinbase() { return this.prevout.hash === constants.NULL_HASH; }; /** * Test the input against an address, an * array of addresses, or a map of hashes. * @param {Hash|Hash[]|AddressHashMap} addressMap * @returns {Boolean} Whether the input matched. */ Input.prototype.test = function test(addressMap) { var hash = this.getHash('hex'); if (!hash) return false; if (typeof addressMap === 'string') return hash === addressMap; if (Array.isArray(addressMap)) return addressMap.indexOf(hash) !== -1; if (addressMap[hash] != null) return true; return false; }; /** * Convert the input to a more user-friendly object. * @returns {Object} */ Input.prototype.inspect = function inspect() { var coin; if (this.coin) { coin = this.coin; } else { coin = { type: 'unknown', version: 1, height: -1, value: '0.0', script: '', coinbase: false, hash: this.prevout.hash, index: this.prevout.index, age: 0, address: null }; } return { type: this.getType(), subtype: this.getSubtype(), address: this.getAddress(), value: utils.btc(coin.value), script: this.script, witness: this.witness, redeem: this.getRedeem(), sequence: this.sequence, prevout: this.prevout, coin: coin }; }; /** * Convert the input to an object suitable * for JSON serialization. Note that the hashes * will be reversed to abide by bitcoind's legacy * of little-endian uint256s. * @returns {Object} */ Input.prototype.toJSON = function toJSON() { return { prevout: this.prevout.toJSON(), coin: this.coin ? this.coin.toJSON() : null, script: this.script.toJSON(), witness: this.witness.toJSON(), sequence: this.sequence }; }; Input.prototype.fromJSON = function fromJSON(json) { this.prevout = Outpoint.fromJSON(json.prevout); this.coin = json.coin ? bcoin.coin.fromJSON(json.coin) : null; this.script = bcoin.script.fromJSON(json.script); this.witness = bcoin.witness.fromJSON(json.witness); this.sequence = json.sequence; return this; }; /** * Instantiate an Input from a jsonified input object. * @param {Object} json - The jsonified input object. * @returns {Input} */ Input.fromJSON = function fromJSON(json) { return new Input().fromJSON(json); }; /** * Serialize the input. * @param {String?} enc - Encoding, can be `'hex'` or null. * @returns {Buffer|String} */ Input.prototype.toRaw = function toRaw(writer) { var p = bcoin.writer(writer); this.prevout.toRaw(p); p.writeVarBytes(this.script.toRaw()); p.writeU32(this.sequence); if (!writer) p = p.render(); return p; }; /** * Instantiate an input from a serialized Buffer. * @param {Buffer} data * @param {String?} enc - Encoding, can be `'hex'` or null. * @returns {Input} */ Input.prototype.fromRaw = function fromRaw(data) { var p = bcoin.reader(data); this.prevout = Outpoint.fromRaw(p); this.script = bcoin.script.fromRaw(p.readVarBytes()); this.sequence = p.readU32(); return this; }; Input.fromRaw = function fromRaw(data, enc) { if (typeof data === 'string') data = new Buffer(data, enc); return new Input().fromRaw(data); }; /** * Serialize the input to an "extended" format, * including both the input and the witness. * @param {String?} enc - Encoding, can be `'hex'` or null. * @returns {Buffer|String} */ Input.prototype.toExtended = function toExtended(writer) { var p = bcoin.writer(writer); this.toRaw(p); this.witness.toRaw(p); if (!writer) p = p.render(); return p; }; /** * Parse an input in "extended" serialization format. * @param {Buffer} data * @param {String?} enc - Encoding, can be `'hex'` or null. * @returns {NakedInput} - A "naked" input object. */ Input.prototype.fromExtended = function fromExtended(data) { var p = bcoin.reader(data); this.fromRaw(p); this.witness = bcoin.witness.fromRaw(p); return this; }; /** * Instantiate an input from a Buffer * in "extended" serialization format. * @param {Buffer} data * @param {String?} enc - Encoding, can be `'hex'` or null. * @returns {TX} */ Input.fromExtended = function fromExtended(data, enc) { if (typeof data === 'string') data = new Buffer(data, enc); return new Input().fromExtended(data); }; /** * Test an object to see if it is an Input. * @param {Object} obj * @returns {Boolean} */ Input.isInput = function isInput(obj) { return obj && obj.prevout !== undefined && obj.script !== undefined && obj.witness !== undefined && typeof obj.getAddress === 'function'; }; /* * Expose */ exports = Input; exports.Outpoint = Outpoint; module.exports = exports;