Merge pull request #743 from braydonf/feature/inspect-g5

Added inspect prototype G5

lib/hdprivatekey.js

@@ -387,6 +387,14 @@ HDPrivateKey.prototype.toString = function() {
   return this.xprivkey;
 };
 
+/**
+ * Returns the console representation of this extended private key.
+ * @return string
+ */
+HDPrivateKey.prototype.inspect = function() {
+  return '<HDPrivateKey: ' + this.xprivkey + '>';
+};
+
 /**
  * Returns a plain object with a representation of this private key.
  *

lib/hdpublickey.js

@@ -350,6 +350,14 @@ HDPublicKey.prototype.toString = function () {
   return this.xpubkey;
 };
 
+/**
+ * Returns the console representation of this extended public key.
+ * @return string
+ */
+HDPublicKey.prototype.inspect = function() {
+  return '<HDPublicKey: ' + this.xpubkey + '>';
+};
+
 /**
  * Returns a plain javascript object with information to reconstruct a key.
  *

lib/script.js

@@ -196,6 +196,10 @@ Script.prototype.toString = function() {
   return str.substr(1);
 };
 
+Script.prototype.inspect = function() {
+  return '<Script: ' + this.toString() + '>';
+};
+
 // script classification methods
 
 /**

lib/transaction/transaction.js

@@ -75,10 +75,14 @@ Transaction.prototype._getHash = function() {
   return Hash.sha256sha256(this.toBuffer());
 };
 
-Transaction.prototype.serialize = function() {
+Transaction.prototype.serialize = Transaction.prototype.toString = function() {
   return this.toBuffer().toString('hex');
 };
 
+Transaction.prototype.inspect = function () {
+  return '<Transaction: ' + this.toString() + '>';
+};
+
 Transaction.prototype.toBuffer = function() {
   var writer = new BufferWriter();
   return this.toBufferWriter(writer).toBuffer();

test/hdprivatekey.js

@@ -83,6 +83,10 @@ describe('HDPrivate key interface', function() {
     HDPrivateKey(xprivkey).toString().should.equal(xprivkey);
   });
 
+  it('inspect() displays correctly', function() {
+    HDPrivateKey(xprivkey).inspect().should.equal('<HDPrivateKey: ' + xprivkey + '>');
+  });
+
   it('allows the use of a copy constructor', function() {
     HDPrivateKey(HDPrivateKey(xprivkey))
       .xprivkey.should.equal(xprivkey);

test/hdpublickey.js

@@ -148,6 +148,11 @@ describe('HDPublicKey interface', function() {
     pubKey.toString().should.equal(pubKey.xpubkey);
   });
 
+  it('inspect() displays correctly', function() {
+    var pubKey = new HDPublicKey(xpubkey);
+    pubKey.inspect().should.equal('<HDPublicKey: ' + pubKey.xpubkey + '>');
+  });
+
   describe('derivation', function() {
     it('derivation is the same whether deriving with number or string', function() {
       var pubkey = new HDPublicKey(xpubkey);

test/transaction.js

@@ -16,6 +16,11 @@ describe('Transaction', function() {
     transaction.serialize().should.equal(tx_1_hex);
   });
 
+  it('should display correctly in console', function() {
+    var transaction = new Transaction(tx_1_hex);
+    transaction.inspect().should.equal('<Transaction: ' + tx_1_hex + '>');
+  });
+
   it('standard hash of transaction should be decoded correctly', function() {
     var transaction = new Transaction(tx_1_hex);
     transaction.id.should.equal(tx_1_id);