@opcat-labs/opcat 1.0.0

package/index.js

@@ -0,0 +1,74 @@
+'use strict';
+
+var opcat = {};
+
+// module information
+opcat.version = 'v' + require('./package.json').version;
+opcat.versionGuard = function (version) {
+  if (version !== undefined) {
+    var message = `
+      More than one instance of opcat found. other version: ${version}
+      Please make sure to require opcat and check that submodules do
+      not also include their own opcat dependency.`;
+    console.warn(message);
+  }
+};
+opcat.versionGuard(global.opcat);
+global.opcat = opcat.version;
+
+// crypto
+opcat.crypto = {};
+opcat.crypto.BN = require('./lib/crypto/bn.js');
+opcat.crypto.ECDSA = require('./lib/crypto/ecdsa.js');
+opcat.crypto.Hash = require('./lib/crypto/hash.js');
+opcat.crypto.Random = require('./lib/crypto/random.js');
+opcat.crypto.Point = require('./lib/crypto/point.js');
+opcat.crypto.Signature = require('./lib/crypto/signature.js');
+
+// encoding
+opcat.encoding = {};
+opcat.encoding.Base58 = require('./lib/encoding/base58.js');
+opcat.encoding.Base58Check = require('./lib/encoding/base58check.js');
+opcat.encoding.BufferReader = require('./lib/encoding/bufferreader.js');
+opcat.encoding.BufferWriter = require('./lib/encoding/bufferwriter.js');
+opcat.encoding.Varint = require('./lib/encoding/varint.js');
+
+// utilities
+opcat.util = {};
+opcat.util.js = require('./lib/util/js.js');
+opcat.util.preconditions = require('./lib/util/preconditions.js');
+
+// errors thrown by the library
+opcat.errors = require('./lib/errors/index.js');
+
+// main bitcoin library
+opcat.Address = require('./lib/address.js');
+opcat.Block = require('./lib/block/index.js');
+opcat.MerkleBlock = require('./lib/block/merkleblock.js');
+opcat.BlockHeader = require('./lib/block/blockheader.js');
+opcat.HDPrivateKey = require('./lib/hdprivatekey.js');
+opcat.HDPublicKey = require('./lib/hdpublickey.js');
+opcat.Networks = require('./lib/networks.js');
+opcat.Opcode = require('./lib/opcode.js');
+opcat.PrivateKey = require('./lib/privatekey.js');
+opcat.PublicKey = require('./lib/publickey.js');
+opcat.Script = require('./lib/script/index.js');
+opcat.Interpreter = require('./lib/script/interpreter.js');
+opcat.Transaction = require('./lib/transaction/index.js');
+opcat.HashCache = require('./lib/hash-cache.js');
+
+// dependencies, subject to change
+opcat.deps = {};
+opcat.deps.bs58 = require('bs58');
+opcat.deps.Buffer = Buffer;
+opcat.deps.elliptic = require('elliptic');
+opcat.deps._ = require('./lib/util/_.js');
+
+// Internal usage, exposed for testing/advanced tweaking
+opcat.Transaction.sighash = require('./lib/transaction/sighash.js');
+
+opcat.Message = require('./lib/message/message.js');
+opcat.Mnemonic = require('./lib/mnemonic/mnemonic.js');
+
+module.exports = opcat;
+// export default opcat

package/lib/address.js

@@ -0,0 +1,478 @@
+'use strict';
+
+var _ = require('./util/_');
+var $ = require('./util/preconditions');
+var errors = require('./errors');
+var Base58Check = require('./encoding/base58check');
+var Networks = require('./networks');
+var Hash = require('./crypto/hash');
+var JSUtil = require('./util/js');
+var PublicKey = require('./publickey');
+/**
+ * Instantiate an address from an address String or Buffer, a public key hash Buffer,
+ * or an instance of {@link PublicKey}.
+ *
+ * This is an immutable class, and if the first parameter provided to this constructor is an
+ * `Address` instance, the same argument will be returned.
+ *
+ * An address has two key properties: `network` and `type`. The type is either
+ * `Address.PayToPublicKeyHash` (value is the `'pubkeyhash'` string).
+ * The network is an instance of {@link Network}.
+ * You can quickly check whether an address is of a given kind by using the methods
+ * `isPayToPublicKeyHash`
+ *
+ * @example
+ * ```javascript
+ * // validate that an input field is valid
+ * var error = Address.getValidationError(input, 'testnet');
+ * if (!error) {
+ *   var address = Address(input, 'testnet');
+ * } else {
+ *   // invalid network or checksum (typo?)
+ *   var message = error.messsage;
+ * }
+ *
+ * // get an address from a public key
+ * var address = Address(publicKey, 'testnet').toString();
+ * ```
+ *
+ * @param {*} data - The encoded data in various formats
+ * @param {Network|String|number=} network - The network: 'livenet' or 'testnet'
+ * @param {string=} type - The type of address: 'pubkey'
+ * @returns {Address} A new valid and frozen instance of an Address
+ * @constructor
+ */
+function Address(data, network, type) {
+  if (!(this instanceof Address)) {
+    return new Address(data, network, type);
+  }
+
+  if (data instanceof Address) {
+    // Immutable instance
+    return data;
+  }
+
+  $.checkArgument(
+    data,
+    'First argument is required, please include address data.',
+    'guide/address.html',
+  );
+
+  if (network && !Networks.get(network)) {
+    throw new TypeError('Second argument must be "livenet", "testnet", or "regtest".');
+  }
+
+  if (type && type !== Address.PayToPublicKeyHash) {
+    throw new TypeError('Third argument must be "pubkeyhash".');
+  }
+
+  var info = this._classifyArguments(data, network, type);
+
+  // set defaults if not set
+  info.network = info.network || Networks.get(network) || Networks.defaultNetwork;
+  info.type = info.type || type || Address.PayToPublicKeyHash;
+
+  JSUtil.defineImmutable(this, {
+    hashBuffer: info.hashBuffer,
+    network: info.network,
+    type: info.type,
+  });
+
+  return this;
+}
+
+/**
+ * Internal function used to split different kinds of arguments of the constructor
+ * @param {*} data - The encoded data in various formats
+ * @param {Network|String|number=} network - The network: 'livenet' or 'testnet'
+ * @param {string=} type - The type of address: 'pubkey'
+ * @returns {Object} An "info" object with "type", "network", and "hashBuffer"
+ */
+Address.prototype._classifyArguments = function (data, network, type) {
+  var Script = require('./script');
+  // transform and validate input data
+  if ((data instanceof Buffer || data instanceof Uint8Array) && data.length === 20) {
+    return Address._transformHash(data);
+  } else if ((data instanceof Buffer || data instanceof Uint8Array) && data.length === 21) {
+    return Address._transformBuffer(data, network, type);
+  } else if (data instanceof PublicKey) {
+    return Address._transformPublicKey(data);
+  } else if (data instanceof Script) {
+    return Address._transformScript(data, network);
+  } else if (typeof data === 'string') {
+    return Address._transformString(data, network, type);
+  } else if (_.isObject(data)) {
+    return Address._transformObject(data);
+  } else {
+    throw new TypeError('First argument is an unrecognized data format.');
+  }
+};
+
+/** @static */
+Address.PayToPublicKeyHash = 'pubkeyhash';
+
+/**
+ * @param {Buffer} hash - An instance of a hash Buffer
+ * @returns {Object} An object with keys: hashBuffer
+ * @private
+ */
+Address._transformHash = function (hash) {
+  var info = {};
+  if (!(hash instanceof Buffer) && !(hash instanceof Uint8Array)) {
+    throw new TypeError('Address supplied is not a buffer.');
+  }
+  if (hash.length !== 20) {
+    throw new TypeError('Address hashbuffers must be exactly 20 bytes.');
+  }
+  info.hashBuffer = hash;
+  return info;
+};
+
+/**
+ * Deserializes an address serialized through `Address#toObject()`
+ * @param {Object} data
+ * @param {string} data.hash - the hash that this address encodes
+ * @param {string} data.type - either 'pubkeyhash' or 'scripthash'
+ * @param {Network=} data.network - the name of the network associated
+ * @return {Address}
+ */
+Address._transformObject = function (data) {
+  $.checkArgument(data.hash || data.hashBuffer, 'Must provide a `hash` or `hashBuffer` property');
+  $.checkArgument(data.type, 'Must provide a `type` property');
+  return {
+    hashBuffer: data.hash ? Buffer.from(data.hash, 'hex') : data.hashBuffer,
+    network: Networks.get(data.network) || Networks.defaultNetwork,
+    type: data.type,
+  };
+};
+
+/**
+ * Internal function to discover the network and type based on the first data byte
+ *
+ * @param {Buffer} buffer - An instance of a hex encoded address Buffer
+ * @returns {Object} An object with keys: network and type
+ * @private
+ */
+Address._classifyFromVersion = function (buffer) {
+  var version = {};
+
+  var pubkeyhashNetwork = Networks.get(buffer[0], 'pubkeyhash');
+
+  if (pubkeyhashNetwork) {
+    version.network = pubkeyhashNetwork;
+    version.type = Address.PayToPublicKeyHash;
+  } 
+
+  return version;
+};
+
+/**
+ * Internal function to transform a bitcoin address buffer
+ *
+ * @param {Buffer} buffer - An instance of a hex encoded address Buffer
+ * @param {string=} network - The network: 'livenet' or 'testnet'
+ * @param {string=} type - The type: 'pubkeyhash' or 'scripthash'
+ * @returns {Object} An object with keys: hashBuffer, network and type
+ * @private
+ */
+Address._transformBuffer = function (buffer, network, type) {
+  var info = {};
+  if (!(buffer instanceof Buffer) && !(buffer instanceof Uint8Array)) {
+    throw new TypeError('Address supplied is not a buffer.');
+  }
+  if (buffer.length !== 1 + 20) {
+    throw new TypeError('Address buffers must be exactly 21 bytes.');
+  }
+
+  var networkObj = Networks.get(network);
+  var bufferVersion = Address._classifyFromVersion(buffer);
+
+  if (network && !networkObj) {
+    throw new TypeError('Unknown network');
+  }
+
+  if (!bufferVersion.network || (networkObj && networkObj !== bufferVersion.network)) {
+    // console.log(bufferVersion)
+    throw new TypeError('Address has mismatched network type.');
+  }
+
+  if (!bufferVersion.type || (type && type !== bufferVersion.type)) {
+    throw new TypeError('Address has mismatched type.');
+  }
+
+  info.hashBuffer = buffer.slice(1);
+  info.network = bufferVersion.network;
+  info.type = bufferVersion.type;
+  return info;
+};
+
+/**
+ * Internal function to transform a {@link PublicKey}
+ *
+ * @param {PublicKey} pubkey - An instance of PublicKey
+ * @returns {Object} An object with keys: hashBuffer, type
+ * @private
+ */
+Address._transformPublicKey = function (pubkey) {
+  var info = {};
+  if (!(pubkey instanceof PublicKey)) {
+    throw new TypeError('Address must be an instance of PublicKey.');
+  }
+  info.hashBuffer = Hash.sha256ripemd160(pubkey.toBuffer());
+  info.type = Address.PayToPublicKeyHash;
+  return info;
+};
+
+/**
+ * Internal function to transform a {@link Script} into a `info` object.
+ *
+ * @param {Script} script - An instance of Script
+ * @returns {Object} An object with keys: hashBuffer, type
+ * @private
+ */
+Address._transformScript = function (script, network) {
+  var Script = require('./script');
+  $.checkArgument(script instanceof Script, 'script must be a Script instance');
+  var info = script.getAddressInfo(network);
+  if (!info) {
+    throw new errors.Script.CantDeriveAddress(script);
+  }
+  return info;
+};
+
+/**
+ * Internal function to transform a bitcoin cash address string
+ *
+ * @param {string} data
+ * @param {String|Network=} network - either a Network instance, 'livenet', or 'testnet'
+ * @param {string=} type - The type: 'pubkeyhash'
+ * @returns {Object} An object with keys: hashBuffer, network and type
+ * @private
+ */
+Address._transformString = function (data, network, type) {
+  if (typeof data !== 'string') {
+    throw new TypeError('data parameter supplied is not a string.');
+  }
+  if (data.length < 27) {
+    throw new Error('Invalid Address string provided');
+  }
+  data = data.trim();
+  var networkObj = Networks.get(network);
+
+  if (network && !networkObj) {
+    throw new TypeError('Unknown network');
+  }
+
+  var addressBuffer = Base58Check.decode(data);
+  return Address._transformBuffer(addressBuffer, network, type);
+};
+
+/**
+ * Instantiate an address from a PublicKey instance
+ *
+ * @param {PublicKey} data
+ * @param {String|Network} network - either a Network instance, 'livenet', or 'testnet'
+ * @returns {Address} A new valid and frozen instance of an Address
+ */
+Address.fromPublicKey = function (data, network) {
+  var info = Address._transformPublicKey(data);
+  network = network || Networks.defaultNetwork;
+  return new Address(info.hashBuffer, network, info.type);
+};
+
+/**
+ * Instantiate an address from a PrivateKey instance
+ *
+ * @param {PrivateKey} privateKey
+ * @param {String|Network} network - either a Network instance, 'livenet', or 'testnet'
+ * @returns {Address} A new valid and frozen instance of an Address
+ */
+Address.fromPrivateKey = function (privateKey, network) {
+  let publicKey = PublicKey.fromPrivateKey(privateKey);
+  network = network || privateKey.network || Networks.defaultNetwork;
+  return Address.fromPublicKey(publicKey, network);
+};
+
+/**
+ * Instantiate an address from a ripemd160 public key hash
+ *
+ * @param {Buffer} hash - An instance of buffer of the hash
+ * @param {String|Network} network - either a Network instance, 'livenet', or 'testnet'
+ * @returns {Address} A new valid and frozen instance of an Address
+ */
+Address.fromPublicKeyHash = function (hash, network) {
+  var info = Address._transformHash(hash);
+  return new Address(info.hashBuffer, network, Address.PayToPublicKeyHash);
+};
+/**
+ * Extract address from a Script. The script must be of one
+ * of the following types: p2pkh input, p2pkh output, p2sh input
+ * or p2sh output.
+ * This will analyze the script and extract address information from it.
+ * If you want to transform any script to a p2sh Address paying
+ * to that script's hash instead, use {{Address#payingTo}}
+ *
+ * @param {Script} script - An instance of Script
+ * @param {String|Network} network - either a Network instance, 'livenet', or 'testnet'
+ * @returns {Address} A new valid and frozen instance of an Address
+ */
+Address.fromScript = function (script, network) {
+  var Script = require('./script');
+  $.checkArgument(script instanceof Script, 'script must be a Script instance');
+  var info = Address._transformScript(script, network);
+  return new Address(info.hashBuffer, network, info.type);
+};
+
+/**
+ * Instantiate an address from a buffer of the address
+ *
+ * @param {Buffer} buffer - An instance of buffer of the address
+ * @param {String|Network=} network - either a Network instance, 'livenet', or 'testnet'
+ * @param {string=} type - The type of address: 'pubkey'
+ * @returns {Address} A new valid and frozen instance of an Address
+ */
+Address.fromBuffer = function (buffer, network, type) {
+  var info = Address._transformBuffer(buffer, network, type);
+  return new Address(info.hashBuffer, info.network, info.type);
+};
+
+Address.fromHex = function (hex, network, type) {
+  return Address.fromBuffer(Buffer.from(hex, 'hex'), network, type);
+};
+
+/**
+ * Instantiate an address from an address string
+ *
+ * @param {string} str - An string of the bitcoin address
+ * @param {String|Network=} network - either a Network instance, 'livenet', or 'testnet'
+ * @param {string=} type - The type of address: 'pubkey'
+ * @returns {Address} A new valid and frozen instance of an Address
+ */
+Address.fromString = function (str, network, type) {
+  var info = Address._transformString(str, network, type);
+  return new Address(info.hashBuffer, info.network, info.type);
+};
+
+/**
+ * Instantiate an address from an Object
+ *
+ * @param {string} json - An JSON string or Object with keys: hash, network and type
+ * @returns {Address} A new valid instance of an Address
+ */
+Address.fromObject = function fromObject(obj) {
+  $.checkState(
+    JSUtil.isHexa(obj.hash),
+    'Unexpected hash property, "' + obj.hash + '", expected to be hex.',
+  );
+  var hashBuffer = Buffer.from(obj.hash, 'hex');
+  return new Address(hashBuffer, obj.network, obj.type);
+};
+
+/**
+ * Will return a validation error if exists
+ *
+ * @example
+ * ```javascript
+ * // a network mismatch error
+ * var error = Address.getValidationError('15vkcKf7gB23wLAnZLmbVuMiiVDc1Nm4a2', 'testnet');
+ * ```
+ *
+ * @param {string} data - The encoded data
+ * @param {String|Network} network - either a Network instance, 'livenet', or 'testnet'
+ * @param {string} type - The type of address: 'pubkey'
+ * @returns {null|Error} The corresponding error message
+ */
+Address.getValidationError = function (data, network, type) {
+  var error;
+  try {
+    new Address(data, network, type);
+  } catch (e) {
+    error = e;
+  }
+  return error;
+};
+
+/**
+ * Will return a boolean if an address is valid
+ *
+ * @example
+ * ```javascript
+ * assert(Address.isValid('15vkcKf7gB23wLAnZLmbVuMiiVDc1Nm4a2', 'livenet'));
+ * ```
+ *
+ * @param {string} data - The encoded data
+ * @param {String|Network} network - either a Network instance, 'livenet', or 'testnet'
+ * @param {string} type - The type of address: 'pubkey'
+ * @returns {boolean} The corresponding error message
+ */
+Address.isValid = function (data, network, type) {
+  return !Address.getValidationError(data, network, type);
+};
+
+/**
+ * Returns true if an address is of pay to public key hash type
+ * @return boolean
+ */
+Address.prototype.isPayToPublicKeyHash = function () {
+  return this.type === Address.PayToPublicKeyHash;
+};
+
+/**
+ * Will return a buffer representation of the address
+ *
+ * @returns {Buffer} Bitcoin address buffer
+ */
+Address.prototype.toBuffer = function () {
+  var version = Buffer.from([this.network[this.type]]);
+  var buf = Buffer.concat([version, this.hashBuffer]);
+  return buf;
+};
+
+/**
+ * Converts the address to a hexadecimal string representation.
+ * @returns {string} The hexadecimal string representation of the address.
+ */
+Address.prototype.toHex = function () {
+  return this.toBuffer().toString('hex');
+};
+
+/**
+ * Converts the address to a publickey hash string representation.
+ * @returns {string} The hexadecimal string of the publickey hash buffer.
+ */
+Address.prototype.toPublickeyHash = function () {
+  return this.hashBuffer.toString('hex');
+};
+
+/**
+ * @returns {Object} A plain object with the address information
+ */
+Address.prototype.toObject = Address.prototype.toJSON = function toObject() {
+  return {
+    hash: this.hashBuffer.toString('hex'),
+    type: this.type,
+    network: this.network.toString(),
+  };
+};
+
+/**
+ * Will return a string formatted for the console
+ *
+ * @returns {string} Bitcoin address
+ */
+Address.prototype.inspect = function () {
+  return (
+    '<Address: ' + this.toString() + ', type: ' + this.type + ', network: ' + this.network + '>'
+  );
+};
+
+/**
+ * Will return a the base58 string representation of the address
+ *
+ * @returns {string} Bitcoin address
+ */
+Address.prototype.toString = function () {
+  return Base58Check.encode(this.toBuffer());
+};
+
+module.exports = Address;