Keypair.isValidPublicKey close stellar#62

lhtdeepaktomar · Feb 12, 2016 · af10f2a · af10f2a
1 parent 07f43fb
commit af10f2a
Show file tree

Hide file tree

Showing 6 changed files with 74 additions and 15 deletions.
diff --git a/src/account.js b/src/account.js
@@ -1,5 +1,6 @@
 import BigNumber from 'bignumber.js';
 import {isString} from 'lodash';
+import {Keypair} from './keypair';
 import {decodeCheck} from "./strkey";
 
 export class Account {
@@ -15,8 +16,8 @@ export class Account {
      * @param {string} sequence current sequence number of the account
      */
     constructor(accountId, sequence) {
-        if (!Account.isValidAccountId(accountId)) {
-            throw new Error('address is invalid');
+        if (!Keypair.isValidPublicKey(accountId)) {
+            throw new Error('accountId is invalid');
         }
         if (!isString(sequence)) {
             throw new Error('sequence must be of type string');
@@ -29,8 +30,10 @@ export class Account {
      * Returns true if the given accountId is a valid Stellar account ID.
      * @param {string} accountId account ID to check
      * @returns {boolean}
+     * @deprecated Use {@link Keypair.isValidPublicKey}
      */
     static isValidAccountId(accountId) {
+        console.warn('Account.isValidAccountId is deprecated. Use Keypair.isValidPublicKey.')
         try {
             let decoded = decodeCheck("accountId", accountId);
             if (decoded.length !== 32) {

diff --git a/src/asset.js b/src/asset.js
@@ -1,5 +1,4 @@
 import {default as xdr} from "./generated/stellar-xdr_generated";
-import {Account} from "./account";
 import {Keypair} from "./keypair";
 import {encodeCheck} from "./strkey";
 import {clone, padEnd, trimEnd} from 'lodash';
@@ -23,7 +22,7 @@ export class Asset {
       if (String(code).toLowerCase() !== "xlm" && !issuer) {
         throw new Error("Issuer cannot be null");
       }
-      if (issuer && !Account.isValidAccountId(issuer)) {
+      if (issuer && !Keypair.isValidPublicKey(issuer)) {
         throw new Error("Issuer is invalid");
       }
 

diff --git a/src/keypair.js b/src/keypair.js
@@ -95,6 +95,23 @@ export class Keypair {
     return this.fromRawSeed(seed);
   }
 
+  /**
+   * Returns true if the given Stellar public key is valid.
+   * @param {string} publicKey public key to check
+   * @returns {boolean}
+   */
+  static isValidPublicKey(publicKey) {
+    try {
+      let decoded = strkey.decodeCheck("accountId", publicKey);
+      if (decoded.length !== 32) {
+        return false;
+      }
+    } catch (err) {
+      return false;
+    }
+    return true;
+  }
+
   xdrAccountId() {
     return new xdr.AccountId.keyTypeEd25519(this._publicKey);
   }

diff --git a/src/operation.js b/src/operation.js
@@ -1,5 +1,4 @@
 import {default as xdr} from "./generated/stellar-xdr_generated";
-import {Account} from "./account";
 import {Keypair} from "./keypair";
 import {UnsignedHyper, Hyper} from "js-xdr";
 import {hash} from "./hashing";
@@ -40,7 +39,7 @@ export class Operation {
     * @returns {xdr.CreateAccountOp}
     */
     static createAccount(opts) {
-        if (!Account.isValidAccountId(opts.destination)) {
+        if (!Keypair.isValidPublicKey(opts.destination)) {
             throw new Error("destination is invalid");
         }
         if (!this.isValidAmount(opts.startingBalance)) {
@@ -68,7 +67,7 @@ export class Operation {
     * @returns {xdr.PaymentOp}
     */
     static payment(opts) {
-        if (!Account.isValidAccountId(opts.destination)) {
+        if (!Keypair.isValidPublicKey(opts.destination)) {
             throw new Error("destination is invalid");
         }
         if (!opts.asset) {
@@ -112,7 +111,7 @@ export class Operation {
         if (!this.isValidAmount(opts.sendMax)) {
             throw new TypeError('sendMax argument must be of type String and represent a positive number');
         }
-        if (!Account.isValidAccountId(opts.destination)) {
+        if (!Keypair.isValidPublicKey(opts.destination)) {
             throw new Error("destination is invalid");
         }
         if (!opts.destAsset) {
@@ -191,7 +190,7 @@ export class Operation {
     * @returns {xdr.AllowTrustOp}
     */
     static allowTrust(opts) {
-        if (!Account.isValidAccountId(opts.trustor)) {
+        if (!Keypair.isValidPublicKey(opts.trustor)) {
             throw new Error("trustor is invalid");
         }
         let attributes = {};
@@ -242,7 +241,7 @@ export class Operation {
         let attributes = {};
 
         if (opts.inflationDest) {
-            if (!Account.isValidAccountId(opts.inflationDest)) {
+            if (!Keypair.isValidPublicKey(opts.inflationDest)) {
                 throw new Error("inflationDest is invalid");
             }
             attributes.inflationDest = Keypair.fromAccountId(opts.inflationDest).xdrAccountId();
@@ -274,7 +273,7 @@ export class Operation {
                 opts.signer.pubKey = opts.signer.address;
             }
 
-            if (!Account.isValidAccountId(opts.signer.pubKey)) {
+            if (!Keypair.isValidPublicKey(opts.signer.pubKey)) {
                 throw new Error("signer.pubKey is invalid");
             }
 
@@ -384,7 +383,7 @@ export class Operation {
     */
     static accountMerge(opts) {
         let opAttributes = {};
-        if (!Account.isValidAccountId(opts.destination)) {
+        if (!Keypair.isValidPublicKey(opts.destination)) {
             throw new Error("destination is invalid");
         }
         opAttributes.body = xdr.OperationBody.accountMerge(
@@ -410,7 +409,7 @@ export class Operation {
 
     static setSourceAccount(opAttributes, opts) {
       if (opts.source) {
-          if (!Account.isValidAccountId(opts.source)) {
+          if (!Keypair.isValidPublicKey(opts.source)) {
               throw new Error("Source address is invalid");
           }
           opAttributes.sourceAccount = Keypair.fromAccountId(opts.source).xdrAccountId();

diff --git a/test/unit/account_test.js b/test/unit/account_test.js
@@ -1,7 +1,7 @@
 
 describe('Account.constructor', function() {
   it("fails to create Account object from an invalid address", function() {
-    expect(() => new StellarBase.Account('GBBB')).to.throw(/address is invalid/);
+    expect(() => new StellarBase.Account('GBBB')).to.throw(/accountId is invalid/);
   });
 
   it("fails to create Account object from an invalid sequence number", function() {
@@ -56,7 +56,7 @@ describe('Account.isValidAccountId', function() {
 
 });
 
-describe('Account.isValidAccountId', function() {
+describe('Account.incrementSequenceNumber', function() {
   it("correctly increments the sequence number", function() {
     let account = new StellarBase.Account('GBBM6BKZPEHWYO3E3YKREDPQXMS4VK35YLNU7NFBRI26RAN7GI5POFBB', '100');
     account.incrementSequenceNumber();

diff --git a/test/unit/keypair_test.js b/test/unit/keypair_test.js
@@ -127,3 +127,44 @@ describe('Keypair.random', function() {
   });
 
 });
+
+describe('Keypair.isValidPublicKey', function() {
+
+  it("returns true for valid public key", function() {
+    var keys = [
+      'GBBM6BKZPEHWYO3E3YKREDPQXMS4VK35YLNU7NFBRI26RAN7GI5POFBB',
+      'GB7KKHHVYLDIZEKYJPAJUOTBE5E3NJAXPSDZK7O6O44WR3EBRO5HRPVT',
+      'GD6WVYRVID442Y4JVWFWKWCZKB45UGHJAABBJRS22TUSTWGJYXIUR7N2',
+      'GBCG42WTVWPO4Q6OZCYI3D6ZSTFSJIXIS6INCIUF23L6VN3ADE4337AP',
+      'GDFX463YPLCO2EY7NGFMI7SXWWDQAMASGYZXCG2LATOF3PP5NQIUKBPT',
+      'GBXEODUMM3SJ3QSX2VYUWFU3NRP7BQRC2ERWS7E2LZXDJXL2N66ZQ5PT',
+      'GAJHORKJKDDEPYCD6URDFODV7CVLJ5AAOJKR6PG2VQOLWFQOF3X7XLOG',
+      'GACXQEAXYBEZLBMQ2XETOBRO4P66FZAJENDHOQRYPUIXZIIXLKMZEXBJ',
+      'GDD3XRXU3G4DXHVRUDH7LJM4CD4PDZTVP4QHOO4Q6DELKXUATR657OZV',
+      'GDTYVCTAUQVPKEDZIBWEJGKBQHB4UGGXI2SXXUEW7LXMD4B7MK37CWLJ'
+    ];
+
+    for (var i in keys) {
+      expect(StellarBase.Keypair.isValidPublicKey(keys[i])).to.be.true;
+    }
+  });
+
+  it("returns false for invalid public key", function() {
+    var keys = [
+      'GBPXX0A5N4JYPESHAADMQKBPWZWQDQ64ZV6ZL2S3LAGW4SY7NTCMWIVL',
+      'GCFZB6L25D26RQFDWSSBDEYQ32JHLRMTT44ZYE3DZQUTYOL7WY43PLBG++',
+      'GADE5QJ2TY7S5ZB65Q43DFGWYWCPHIYDJ2326KZGAGBN7AE5UY6JVDRRA',
+      'GB6OWYST45X57HCJY5XWOHDEBULB6XUROWPIKW77L5DSNANBEQGUPADT2',
+      'GB6OWYST45X57HCJY5XWOHDEBULB6XUROWPIKW77L5DSNANBEQGUPADT2T',
+      'GDXIIZTKTLVYCBHURXL2UPMTYXOVNI7BRAEFQCP6EZCY4JLKY4VKFNLT',
+      'gWRYUerEKuz53tstxEuR3NCkiQDcV4wzFHmvLnZmj7PUqxW2wt',
+      'test',
+      'g4VPBPrHZkfE8CsjuG2S4yBQNd455UWmk' // Old network key
+    ];
+
+    for (var i in keys) {
+      expect(StellarBase.Keypair.isValidPublicKey(keys[i])).to.be.false;
+    }
+  });
+
+});