/*!
* keyring.js - keyring object for bcoin
* Copyright (c) 2014-2015, Fedor Indutny (MIT License)
* Copyright (c) 2014-2017, Christopher Jeffrey (MIT License).
* https://github.com/bcoin-org/bcoin
*/
'use strict';
const assert = require('bsert');
const base58 = require('bcrypto/lib/encoding/base58');
const bio = require('bufio');
const hash160 = require('bcrypto/lib/hash160');
const hash256 = require('bcrypto/lib/hash256');
const Network = require('../protocol/network');
const Script = require('../script/script');
const Address = require('./address');
const Output = require('./output');
const secp256k1 = require('bcrypto/lib/secp256k1');
const {encoding} = bio;
const {inspectSymbol} = require('../utils');
/*
* Constants
*/
const ZERO_KEY = Buffer.alloc(33, 0x00);
/**
* Key Ring
* Represents a key ring which amounts to an address.
* @alias module:primitives.KeyRing
*/
class KeyRing {
/**
* Create a key ring.
* @constructor
* @param {Object} options
*/
constructor(options) {
this.witness = false;
this.nested = false;
this.publicKey = ZERO_KEY;
this.privateKey = null;
this.script = null;
this._keyHash = null;
this._keyAddress = null;
this._program = null;
this._nestedHash = null;
this._nestedAddress = null;
this._scriptHash160 = null;
this._scriptHash256 = null;
this._scriptAddress = null;
if (options)
this.fromOptions(options);
}
/**
* Inject properties from options object.
* @private
* @param {Object} options
*/
fromOptions(options) {
let key = toKey(options);
if (options.witness != null) {
assert(typeof options.witness === 'boolean');
this.witness = options.witness;
}
if (options.nested != null) {
assert(typeof options.nested === 'boolean');
this.nested = options.nested;
}
if (Buffer.isBuffer(key))
return this.fromKey(key);
key = toKey(options.key);
if (options.publicKey)
key = toKey(options.publicKey);
if (options.privateKey)
key = toKey(options.privateKey);
const script = options.script;
const compress = options.compressed;
if (script)
return this.fromScript(key, script, compress);
return this.fromKey(key, compress);
}
/**
* Instantiate key ring from options.
* @param {Object} options
* @returns {KeyRing}
*/
static fromOptions(options) {
return new this().fromOptions(options);
}
/**
* Clear cached key/script hashes.
*/
refresh() {
this._keyHash = null;
this._keyAddress = null;
this._program = null;
this._nestedHash = null;
this._nestedAddress = null;
this._scriptHash160 = null;
this._scriptHash256 = null;
this._scriptAddress = null;
}
/**
* Inject data from private key.
* @private
* @param {Buffer} key
* @param {Boolean?} compress
*/
fromPrivate(key, compress) {
assert(Buffer.isBuffer(key), 'Private key must be a buffer.');
assert(secp256k1.privateKeyVerify(key), 'Not a valid private key.');
this.privateKey = key;
this.publicKey = secp256k1.publicKeyCreate(key, compress !== false);
return this;
}
/**
* Instantiate keyring from a private key.
* @param {Buffer} key
* @param {Boolean?} compress
* @returns {KeyRing}
*/
static fromPrivate(key, compress) {
return new this().fromPrivate(key, compress);
}
/**
* Inject data from public key.
* @private
* @param {Buffer} key
*/
fromPublic(key) {
assert(Buffer.isBuffer(key), 'Public key must be a buffer.');
assert(secp256k1.publicKeyVerify(key), 'Not a valid public key.');
this.publicKey = key;
return this;
}
/**
* Generate a keyring.
* @private
* @param {Boolean?} compress
* @returns {KeyRing}
*/
generate(compress) {
const key = secp256k1.privateKeyGenerate();
return this.fromKey(key, compress);
}
/**
* Generate a keyring.
* @param {Boolean?} compress
* @returns {KeyRing}
*/
static generate(compress) {
return new this().generate(compress);
}
/**
* Instantiate keyring from a public key.
* @param {Buffer} publicKey
* @returns {KeyRing}
*/
static fromPublic(key) {
return new this().fromPublic(key);
}
/**
* Inject data from public key.
* @private
* @param {Buffer} privateKey
* @param {Boolean?} compress
*/
fromKey(key, compress) {
assert(Buffer.isBuffer(key), 'Key must be a buffer.');
if (key.length === 32)
return this.fromPrivate(key, compress !== false);
return this.fromPublic(key);
}
/**
* Instantiate keyring from a public key.
* @param {Buffer} publicKey
* @param {Boolean?} compress
* @returns {KeyRing}
*/
static fromKey(key, compress) {
return new this().fromKey(key, compress);
}
/**
* Inject data from script.
* @private
* @param {Buffer} key
* @param {Script} script
* @param {Boolean?} compress
*/
fromScript(key, script, compress) {
assert(script instanceof Script, 'Non-script passed into KeyRing.');
this.fromKey(key, compress);
this.script = script;
return this;
}
/**
* Instantiate keyring from script.
* @param {Buffer} key
* @param {Script} script
* @param {Boolean?} compress
* @returns {KeyRing}
*/
static fromScript(key, script, compress) {
return new this().fromScript(key, script, compress);
}
/**
* Get ith public key from multisig script.
* @private
* @param {Script} script
* @param {Number} i
* @returns {KeyRing}
*/
fromMultisigScript(script, i) {
assert(script instanceof Script, 'Non-script passed.');
assert(script.isMultisig(), 'Script must be multisig');
const n = script.getSmall(-2);
assert(i >= 1 && i <= n, 'Requested `i`th key, `n` available');
this.fromKey(script.code[i].toData());
return this;
}
/**
* Instantiate keyring from ith key in multisig script.
* @param {Script} script
* @param {Number} i
* @returns {KeyRing}
*/
static fromMultisigScript(script, i) {
return new this().fromMultisigScript(script, i);
}
/**
* Calculate WIF serialization size.
* @returns {Number}
*/
getSecretSize() {
let size = 0;
size += 1;
size += this.privateKey.length;
if (this.publicKey.length === 33)
size += 1;
size += 4;
return size;
}
/**
* Convert key to a CBitcoinSecret.
* @param {(Network|NetworkType)?} network
* @returns {Base58String}
*/
toSecret(network) {
const size = this.getSecretSize();
const bw = bio.write(size);
assert(this.privateKey, 'Cannot serialize without private key.');
network = Network.get(network);
bw.writeU8(network.keyPrefix.privkey);
bw.writeBytes(this.privateKey);
if (this.publicKey.length === 33)
bw.writeU8(1);
bw.writeChecksum(hash256.digest);
return base58.encode(bw.render());
}
/**
* Inject properties from serialized CBitcoinSecret.
* @private
* @param {Base58String} secret
* @param {(Network|NetworkType)?} network
*/
fromSecret(data, network) {
const br = bio.read(base58.decode(data), true);
const version = br.readU8();
Network.fromWIF(version, network);
const key = br.readBytes(32);
let compress = false;
if (br.left() > 4) {
assert(br.readU8() === 1, 'Bad compression flag.');
compress = true;
}
br.verifyChecksum(hash256.digest);
return this.fromPrivate(key, compress);
}
/**
* Instantiate a keyring from a serialized CBitcoinSecret.
* @param {Base58String} secret
* @param {(Network|NetworkType)?} network
* @returns {KeyRing}
*/
static fromSecret(data, network) {
return new this().fromSecret(data, network);
}
/**
* Get private key.
* @param {String?} enc - Can be `"hex"`, `"base58"`, or `null`.
* @returns {Buffer} Private key.
*/
getPrivateKey(enc, network) {
if (!this.privateKey)
return null;
if (enc === 'base58')
return this.toSecret(network);
if (enc === 'hex')
return this.privateKey.toString('hex');
return this.privateKey;
}
/**
* Get public key.
* @param {String?} enc - `"hex"` or `null`.
* @returns {Buffer}
*/
getPublicKey(enc) {
if (enc === 'base58')
return base58.encode(this.publicKey);
if (enc === 'hex')
return this.publicKey.toString('hex');
return this.publicKey;
}
/**
* Get redeem script.
* @returns {Script}
*/
getScript() {
return this.script;
}
/**
* Get witness program.
* @returns {Buffer}
*/
getProgram() {
if (!this.witness)
return null;
if (!this._program) {
let program;
if (!this.script) {
const hash = hash160.digest(this.publicKey);
program = Script.fromProgram(0, hash);
} else {
const hash = this.script.sha256();
program = Script.fromProgram(0, hash);
}
this._program = program;
}
return this._program;
}
/**
* Get address' ripemd160 program scripthash
* (for witness programs behind a scripthash).
* @param {String?} enc - `"hex"` or `null`.
* @returns {Buffer}
*/
getNestedHash(enc) {
if (!this.witness)
return null;
if (!this._nestedHash)
this._nestedHash = this.getProgram().hash160();
return enc === 'hex'
? this._nestedHash.toString('hex')
: this._nestedHash;
}
/**
* Get address' scripthash address for witness program.
* @param {String?} enc - `"base58"` or `null`.
* @returns {Address|AddressString}
*/
getNestedAddress(enc, network) {
if (!this.witness)
return null;
if (!this._nestedAddress) {
const hash = this.getNestedHash();
const addr = Address.fromScripthash(hash);
this._nestedAddress = addr;
}
if (enc === 'base58')
return this._nestedAddress.toBase58(network);
if (enc === 'string')
return this._nestedAddress.toString(network);
return this._nestedAddress;
}
/**
* Get scripthash.
* @param {String?} enc - `"hex"` or `null`.
* @returns {Buffer}
*/
getScriptHash(enc) {
if (this.witness)
return this.getScriptHash256(enc);
return this.getScriptHash160(enc);
}
/**
* Get ripemd160 scripthash.
* @param {String?} enc - `"hex"` or `null`.
* @returns {Buffer}
*/
getScriptHash160(enc) {
if (!this.script)
return null;
if (!this._scriptHash160)
this._scriptHash160 = this.script.hash160();
return enc === 'hex'
? this._scriptHash160.toString('hex')
: this._scriptHash160;
}
/**
* Get sha256 scripthash.
* @param {String?} enc - `"hex"` or `null`.
* @returns {Buffer}
*/
getScriptHash256(enc) {
if (!this.script)
return null;
if (!this._scriptHash256)
this._scriptHash256 = this.script.sha256();
return enc === 'hex'
? this._scriptHash256.toString('hex')
: this._scriptHash256;
}
/**
* Get scripthash address.
* @param {String?} enc - `"base58"` or `null`.
* @returns {Address|AddressString}
*/
getScriptAddress(enc, network) {
if (!this.script)
return null;
if (!this._scriptAddress) {
let addr;
if (this.witness) {
const hash = this.getScriptHash256();
addr = Address.fromWitnessScripthash(hash);
} else {
const hash = this.getScriptHash160();
addr = Address.fromScripthash(hash);
}
this._scriptAddress = addr;
}
if (enc === 'base58')
return this._scriptAddress.toBase58(network);
if (enc === 'string')
return this._scriptAddress.toString(network);
return this._scriptAddress;
}
/**
* Get public key hash.
* @param {String?} enc - `"hex"` or `null`.
* @returns {Buffer}
*/
getKeyHash(enc) {
if (!this._keyHash)
this._keyHash = hash160.digest(this.publicKey);
return enc === 'hex'
? this._keyHash.toString('hex')
: this._keyHash;
}
/**
* Get pubkeyhash address.
* @param {String?} enc - `"base58"` or `null`.
* @returns {Address|AddressString}
*/
getKeyAddress(enc, network) {
if (!this._keyAddress) {
const hash = this.getKeyHash();
let addr;
if (this.witness)
addr = Address.fromWitnessPubkeyhash(hash);
else
addr = Address.fromPubkeyhash(hash);
this._keyAddress = addr;
}
if (enc === 'base58')
return this._keyAddress.toBase58(network);
if (enc === 'string')
return this._keyAddress.toString(network);
return this._keyAddress;
}
/**
* Get hash.
* @param {String?} enc - `"hex"` or `null`.
* @returns {Buffer}
*/
getHash(enc) {
if (this.nested)
return this.getNestedHash(enc);
if (this.script)
return this.getScriptHash(enc);
return this.getKeyHash(enc);
}
/**
* Get base58 address.
* @param {String?} enc - `"base58"` or `null`.
* @returns {Address|AddressString}
*/
getAddress(enc, network) {
if (this.nested)
return this.getNestedAddress(enc, network);
if (this.script)
return this.getScriptAddress(enc, network);
return this.getKeyAddress(enc, network);
}
/**
* Test an address hash against hash and program hash.
* @param {Buffer} hash
* @returns {Boolean}
*/
ownHash(hash) {
if (!hash)
return false;
if (hash.equals(this.getKeyHash()))
return true;
if (this.script) {
if (hash.equals(this.getScriptHash()))
return true;
}
if (this.witness) {
if (hash.equals(this.getNestedHash()))
return true;
}
return false;
}
/**
* Check whether transaction output belongs to this address.
* @param {TX|Output} tx - Transaction or Output.
* @param {Number?} index - Output index.
* @returns {Boolean}
*/
ownOutput(tx, index) {
let output;
if (tx instanceof Output) {
output = tx;
} else {
output = tx.outputs[index];
assert(output, 'Output does not exist.');
}
return this.ownHash(output.getHash());
}
/**
* Test a hash against script hashes to
* find the correct redeem script, if any.
* @param {Buffer} hash
* @returns {Script|null}
*/
getRedeem(hash) {
if (this.witness) {
if (hash.equals(this.getNestedHash()))
return this.getProgram();
}
if (this.script) {
if (hash.equals(this.getScriptHash160()))
return this.script;
if (hash.equals(this.getScriptHash256()))
return this.script;
}
return null;
}
/**
* Sign a message.
* @param {Buffer} msg
* @returns {Buffer} Signature in DER format.
*/
sign(msg) {
assert(this.privateKey, 'Cannot sign without private key.');
return secp256k1.signDER(msg, this.privateKey);
}
/**
* Verify a message.
* @param {Buffer} msg
* @param {Buffer} sig - Signature in DER format.
* @returns {Boolean}
*/
verify(msg, sig) {
return secp256k1.verifyDER(msg, sig, this.publicKey);
}
/**
* Get witness program version.
* @returns {Number}
*/
getVersion() {
if (!this.witness)
return -1;
if (this.nested)
return -1;
return 0;
}
/**
* Get address type.
* @returns {ScriptType}
*/
getType() {
if (this.nested)
return Address.types.SCRIPTHASH;
if (this.witness)
return Address.types.WITNESS;
if (this.script)
return Address.types.SCRIPTHASH;
return Address.types.PUBKEYHASH;
}
/**
* Inspect keyring.
* @returns {Object}
*/
[inspectSymbol]() {
return this.toJSON();
}
/**
* Convert an KeyRing to a more json-friendly object.
* @returns {Object}
*/
toJSON(network) {
return {
witness: this.witness,
nested: this.nested,
publicKey: this.publicKey.toString('hex'),
script: this.script ? this.script.toRaw().toString('hex') : null,
program: this.witness ? this.getProgram().toRaw().toString('hex') : null,
type: Address.typesByVal[this.getType()].toLowerCase(),
address: this.getAddress('string', network)
};
}
/**
* Inject properties from json object.
* @private
* @param {Object} json
*/
fromJSON(json) {
assert(json);
assert(typeof json.witness === 'boolean');
assert(typeof json.nested === 'boolean');
assert(typeof json.publicKey === 'string');
assert(!json.script || typeof json.script === 'string');
this.witness = json.witness;
this.nested = json.nested;
this.publicKey = Buffer.from(json.publicKey, 'hex');
if (json.script)
this.script = Buffer.from(json.script, 'hex');
return this;
}
/**
* Instantiate an KeyRing from a jsonified transaction object.
* @param {Object} json - The jsonified transaction object.
* @returns {KeyRing}
*/
static fromJSON(json) {
return new this().fromJSON(json);
}
/**
* Calculate serialization size.
* @returns {Number}
*/
getSize() {
let size = 0;
size += 1;
if (this.privateKey) {
size += encoding.sizeVarBytes(this.privateKey);
size += 1;
} else {
size += encoding.sizeVarBytes(this.publicKey);
}
size += this.script ? this.script.getVarSize() : 1;
return size;
}
/**
* Write the keyring to a buffer writer.
* @param {BufferWriter} bw
*/
toWriter(bw) {
let field = 0;
if (this.witness)
field |= 1;
if (this.nested)
field |= 2;
bw.writeU8(field);
if (this.privateKey) {
bw.writeVarBytes(this.privateKey);
bw.writeU8(this.publicKey.length === 33 ? 1 : 0);
} else {
bw.writeVarBytes(this.publicKey);
}
if (this.script)
bw.writeVarBytes(this.script.toRaw());
else
bw.writeVarint(0);
return bw;
}
/**
* Serialize the keyring.
* @returns {Buffer}
*/
toRaw() {
const size = this.getSize();
return this.toWriter(bio.write(size)).render();
}
/**
* Inject properties from buffer reader.
* @private
* @param {BufferReader} br
*/
fromReader(br) {
const field = br.readU8();
this.witness = (field & 1) !== 0;
this.nested = (field & 2) !== 0;
const key = br.readVarBytes();
if (key.length === 32) {
const compress = br.readU8() === 1;
this.privateKey = key;
this.publicKey = secp256k1.publicKeyCreate(key, compress);
} else {
this.publicKey = key;
assert(secp256k1.publicKeyVerify(key), 'Invalid public key.');
}
const script = br.readVarBytes();
if (script.length > 0)
this.script = Script.fromRaw(script);
return this;
}
/**
* Inject properties from serialized data.
* @private
* @param {Buffer} data
*/
fromRaw(data) {
return this.fromReader(bio.read(data));
}
/**
* Instantiate a keyring from buffer reader.
* @param {BufferReader} br
* @returns {KeyRing}
*/
static fromReader(br) {
return new this().fromReader(br);
}
/**
* Instantiate a keyring from serialized data.
* @param {Buffer} data
* @returns {KeyRing}
*/
static fromRaw(data) {
return new this().fromRaw(data);
}
/**
* Test whether an object is a KeyRing.
* @param {Object} obj
* @returns {Boolean}
*/
static isKeyRing(obj) {
return obj instanceof KeyRing;
}
}
/*
* Helpers
*/
function toKey(opt) {
if (!opt)
return opt;
if (opt.privateKey)
return opt.privateKey;
if (opt.publicKey)
return opt.publicKey;
return opt;
}
/*
* Expose
*/
module.exports = KeyRing;