@bitgo-beta/sdk-coin-algo 1.1.0

package/dist/src/seedValidator.js

@@ -0,0 +1,89 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SeedValidator = void 0;
+const stellar = __importStar(require("stellar-sdk"));
+const _ = __importStar(require("lodash"));
+const statics_1 = require("@bitgo-beta/statics");
+const lib_1 = require("./lib");
+const cryptography_1 = require("@hashgraph/cryptography");
+/**
+ * This classes intention is to guess/verify what seeds come from where.
+ */
+class SeedValidator {
+    /**
+     * Try to guess what kind of seed this could be
+     * @param seed
+     * @returns {string} - returns undefined if the coin type is undetectable. returns
+     * the coin family otherwise.
+     */
+    static getCoinFamilyFromSeed(seed) {
+        let coin = undefined;
+        // if this can be implemented in more than one competing seed format, that could be an issue
+        if (!SeedValidator.hasCompetingSeedFormats(seed)) {
+            // ordering generally matters here - hbar is the least permissive for seed checking, algo and
+            // stellar have checksums. coin is guaranteed to be mutually exclusive by the
+            // competing seed format check
+            if (lib_1.algoUtils.isValidSeed(seed))
+                coin = statics_1.CoinFamily.ALGO;
+            if (stellar.StrKey.isValidEd25519SecretSeed(seed))
+                coin = statics_1.CoinFamily.XLM;
+            if (SeedValidator.isValidHbarSeedFormat(seed))
+                coin = statics_1.CoinFamily.HBAR;
+        }
+        return coin;
+    }
+    /**
+     * Checks whether this is a valid seed for this coin family type.
+     * @param seed - seed
+     * @param coinFamily - the coinFamily of the coin we're working with
+     */
+    static isValidEd25519SeedForCoin(seed, coinFamily) {
+        const guessedCoin = SeedValidator.getCoinFamilyFromSeed(seed);
+        return coinFamily === guessedCoin;
+    }
+    /**
+     * We need to ensure there is no overlap for any two seeds we put into this function. This functions
+     * intention is for gating whether this seed could possibly match two formats or is invalid itself.
+     * @param seed
+     */
+    static hasCompetingSeedFormats(seed) {
+        const isAlgoSeed = lib_1.algoUtils.isValidSeed(seed);
+        const isStellarSeed = stellar.StrKey.isValidEd25519SecretSeed(seed);
+        const isHbarSeed = SeedValidator.isValidHbarSeedFormat(seed);
+        return _.sum([isAlgoSeed, isStellarSeed, isHbarSeed]) !== 1;
+    }
+    /**
+     * Checks if this is a valid Hbar prv. These can be encoded differently.
+     * @param seed
+     */
+    static isValidHbarSeedFormat(seed) {
+        try {
+            cryptography_1.PrivateKey.fromString(seed);
+        }
+        catch {
+            return false;
+        }
+        return true;
+    }
+}
+exports.SeedValidator = SeedValidator;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2VlZFZhbGlkYXRvci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9zZWVkVmFsaWRhdG9yLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFBQSxxREFBdUM7QUFDdkMsMENBQTRCO0FBQzVCLGlEQUFpRDtBQUNqRCwrQkFBa0M7QUFDbEMsMERBQXFEO0FBQ3JEOztHQUVHO0FBQ0gsTUFBYSxhQUFhO0lBQ3hCOzs7OztPQUtHO0lBQ0gsTUFBTSxDQUFDLHFCQUFxQixDQUFDLElBQVk7UUFDdkMsSUFBSSxJQUFJLEdBQTJCLFNBQVMsQ0FBQztRQUU3Qyw0RkFBNEY7UUFDNUYsSUFBSSxDQUFDLGFBQWEsQ0FBQyx1QkFBdUIsQ0FBQyxJQUFJLENBQUMsRUFBRTtZQUNoRCw2RkFBNkY7WUFDN0YsNkVBQTZFO1lBQzdFLDhCQUE4QjtZQUU5QixJQUFJLGVBQVMsQ0FBQyxXQUFXLENBQUMsSUFBSSxDQUFDO2dCQUFFLElBQUksR0FBRyxvQkFBVSxDQUFDLElBQUksQ0FBQztZQUN4RCxJQUFJLE9BQU8sQ0FBQyxNQUFNLENBQUMsd0JBQXdCLENBQUMsSUFBSSxDQUFDO2dCQUFFLElBQUksR0FBRyxvQkFBVSxDQUFDLEdBQUcsQ0FBQztZQUN6RSxJQUFJLGFBQWEsQ0FBQyxxQkFBcUIsQ0FBQyxJQUFJLENBQUM7Z0JBQUUsSUFBSSxHQUFHLG9CQUFVLENBQUMsSUFBSSxDQUFDO1NBQ3ZFO1FBRUQsT0FBTyxJQUFJLENBQUM7SUFDZCxDQUFDO0lBRUQ7Ozs7T0FJRztJQUNILE1BQU0sQ0FBQyx5QkFBeUIsQ0FBQyxJQUFZLEVBQUUsVUFBc0I7UUFDbkUsTUFBTSxXQUFXLEdBQUcsYUFBYSxDQUFDLHFCQUFxQixDQUFDLElBQUksQ0FBQyxDQUFDO1FBQzlELE9BQU8sVUFBVSxLQUFLLFdBQVcsQ0FBQztJQUNwQyxDQUFDO0lBRUQ7Ozs7T0FJRztJQUNILE1BQU0sQ0FBQyx1QkFBdUIsQ0FBQyxJQUFZO1FBQ3pDLE1BQU0sVUFBVSxHQUFHLGVBQVMsQ0FBQyxXQUFXLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDL0MsTUFBTSxhQUFhLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyx3QkFBd0IsQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUNwRSxNQUFNLFVBQVUsR0FBRyxhQUFhLENBQUMscUJBQXFCLENBQUMsSUFBSSxDQUFDLENBQUM7UUFFN0QsT0FBTyxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsVUFBVSxFQUFFLGFBQWEsRUFBRSxVQUFVLENBQUMsQ0FBQyxLQUFLLENBQUMsQ0FBQztJQUM5RCxDQUFDO0lBRUQ7OztPQUdHO0lBQ0gsTUFBTSxDQUFDLHFCQUFxQixDQUFDLElBQVk7UUFDdkMsSUFBSTtZQUNGLHlCQUFVLENBQUMsVUFBVSxDQUFDLElBQUksQ0FBQyxDQUFDO1NBQzdCO1FBQUMsTUFBTTtZQUNOLE9BQU8sS0FBSyxDQUFDO1NBQ2Q7UUFDRCxPQUFPLElBQUksQ0FBQztJQUNkLENBQUM7Q0FDRjtBQTNERCxzQ0EyREMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgKiBhcyBzdGVsbGFyIGZyb20gJ3N0ZWxsYXItc2RrJztcbmltcG9ydCAqIGFzIF8gZnJvbSAnbG9kYXNoJztcbmltcG9ydCB7IENvaW5GYW1pbHkgfSBmcm9tICdAYml0Z28tYmV0YS9zdGF0aWNzJztcbmltcG9ydCB7IGFsZ29VdGlscyB9IGZyb20gJy4vbGliJztcbmltcG9ydCB7IFByaXZhdGVLZXkgfSBmcm9tICdAaGFzaGdyYXBoL2NyeXB0b2dyYXBoeSc7XG4vKipcbiAqIFRoaXMgY2xhc3NlcyBpbnRlbnRpb24gaXMgdG8gZ3Vlc3MvdmVyaWZ5IHdoYXQgc2VlZHMgY29tZSBmcm9tIHdoZXJlLlxuICovXG5leHBvcnQgY2xhc3MgU2VlZFZhbGlkYXRvciB7XG4gIC8qKlxuICAgKiBUcnkgdG8gZ3Vlc3Mgd2hhdCBraW5kIG9mIHNlZWQgdGhpcyBjb3VsZCBiZVxuICAgKiBAcGFyYW0gc2VlZFxuICAgKiBAcmV0dXJucyB7c3RyaW5nfSAtIHJldHVybnMgdW5kZWZpbmVkIGlmIHRoZSBjb2luIHR5cGUgaXMgdW5kZXRlY3RhYmxlLiByZXR1cm5zXG4gICAqIHRoZSBjb2luIGZhbWlseSBvdGhlcndpc2UuXG4gICAqL1xuICBzdGF0aWMgZ2V0Q29pbkZhbWlseUZyb21TZWVkKHNlZWQ6IHN0cmluZyk6IENvaW5GYW1pbHkgfCB1bmRlZmluZWQge1xuICAgIGxldCBjb2luOiBDb2luRmFtaWx5IHwgdW5kZWZpbmVkID0gdW5kZWZpbmVkO1xuXG4gICAgLy8gaWYgdGhpcyBjYW4gYmUgaW1wbGVtZW50ZWQgaW4gbW9yZSB0aGFuIG9uZSBjb21wZXRpbmcgc2VlZCBmb3JtYXQsIHRoYXQgY291bGQgYmUgYW4gaXNzdWVcbiAgICBpZiAoIVNlZWRWYWxpZGF0b3IuaGFzQ29tcGV0aW5nU2VlZEZvcm1hdHMoc2VlZCkpIHtcbiAgICAgIC8vIG9yZGVyaW5nIGdlbmVyYWxseSBtYXR0ZXJzIGhlcmUgLSBoYmFyIGlzIHRoZSBsZWFzdCBwZXJtaXNzaXZlIGZvciBzZWVkIGNoZWNraW5nLCBhbGdvIGFuZFxuICAgICAgLy8gc3RlbGxhciBoYXZlIGNoZWNrc3Vtcy4gY29pbiBpcyBndWFyYW50ZWVkIHRvIGJlIG11dHVhbGx5IGV4Y2x1c2l2ZSBieSB0aGVcbiAgICAgIC8vIGNvbXBldGluZyBzZWVkIGZvcm1hdCBjaGVja1xuXG4gICAgICBpZiAoYWxnb1V0aWxzLmlzVmFsaWRTZWVkKHNlZWQpKSBjb2luID0gQ29pbkZhbWlseS5BTEdPO1xuICAgICAgaWYgKHN0ZWxsYXIuU3RyS2V5LmlzVmFsaWRFZDI1NTE5U2VjcmV0U2VlZChzZWVkKSkgY29pbiA9IENvaW5GYW1pbHkuWExNO1xuICAgICAgaWYgKFNlZWRWYWxpZGF0b3IuaXNWYWxpZEhiYXJTZWVkRm9ybWF0KHNlZWQpKSBjb2luID0gQ29pbkZhbWlseS5IQkFSO1xuICAgIH1cblxuICAgIHJldHVybiBjb2luO1xuICB9XG5cbiAgLyoqXG4gICAqIENoZWNrcyB3aGV0aGVyIHRoaXMgaXMgYSB2YWxpZCBzZWVkIGZvciB0aGlzIGNvaW4gZmFtaWx5IHR5cGUuXG4gICAqIEBwYXJhbSBzZWVkIC0gc2VlZFxuICAgKiBAcGFyYW0gY29pbkZhbWlseSAtIHRoZSBjb2luRmFtaWx5IG9mIHRoZSBjb2luIHdlJ3JlIHdvcmtpbmcgd2l0aFxuICAgKi9cbiAgc3RhdGljIGlzVmFsaWRFZDI1NTE5U2VlZEZvckNvaW4oc2VlZDogc3RyaW5nLCBjb2luRmFtaWx5OiBDb2luRmFtaWx5KTogYm9vbGVhbiB7XG4gICAgY29uc3QgZ3Vlc3NlZENvaW4gPSBTZWVkVmFsaWRhdG9yLmdldENvaW5GYW1pbHlGcm9tU2VlZChzZWVkKTtcbiAgICByZXR1cm4gY29pbkZhbWlseSA9PT0gZ3Vlc3NlZENvaW47XG4gIH1cblxuICAvKipcbiAgICogV2UgbmVlZCB0byBlbnN1cmUgdGhlcmUgaXMgbm8gb3ZlcmxhcCBmb3IgYW55IHR3byBzZWVkcyB3ZSBwdXQgaW50byB0aGlzIGZ1bmN0aW9uLiBUaGlzIGZ1bmN0aW9uc1xuICAgKiBpbnRlbnRpb24gaXMgZm9yIGdhdGluZyB3aGV0aGVyIHRoaXMgc2VlZCBjb3VsZCBwb3NzaWJseSBtYXRjaCB0d28gZm9ybWF0cyBvciBpcyBpbnZhbGlkIGl0c2VsZi5cbiAgICogQHBhcmFtIHNlZWRcbiAgICovXG4gIHN0YXRpYyBoYXNDb21wZXRpbmdTZWVkRm9ybWF0cyhzZWVkOiBzdHJpbmcpOiBib29sZWFuIHtcbiAgICBjb25zdCBpc0FsZ29TZWVkID0gYWxnb1V0aWxzLmlzVmFsaWRTZWVkKHNlZWQpO1xuICAgIGNvbnN0IGlzU3RlbGxhclNlZWQgPSBzdGVsbGFyLlN0cktleS5pc1ZhbGlkRWQyNTUxOVNlY3JldFNlZWQoc2VlZCk7XG4gICAgY29uc3QgaXNIYmFyU2VlZCA9IFNlZWRWYWxpZGF0b3IuaXNWYWxpZEhiYXJTZWVkRm9ybWF0KHNlZWQpO1xuXG4gICAgcmV0dXJuIF8uc3VtKFtpc0FsZ29TZWVkLCBpc1N0ZWxsYXJTZWVkLCBpc0hiYXJTZWVkXSkgIT09IDE7XG4gIH1cblxuICAvKipcbiAgICogQ2hlY2tzIGlmIHRoaXMgaXMgYSB2YWxpZCBIYmFyIHBydi4gVGhlc2UgY2FuIGJlIGVuY29kZWQgZGlmZmVyZW50bHkuXG4gICAqIEBwYXJhbSBzZWVkXG4gICAqL1xuICBzdGF0aWMgaXNWYWxpZEhiYXJTZWVkRm9ybWF0KHNlZWQ6IHN0cmluZyk6IGJvb2xlYW4ge1xuICAgIHRyeSB7XG4gICAgICBQcml2YXRlS2V5LmZyb21TdHJpbmcoc2VlZCk7XG4gICAgfSBjYXRjaCB7XG4gICAgICByZXR1cm4gZmFsc2U7XG4gICAgfVxuICAgIHJldHVybiB0cnVlO1xuICB9XG59XG4iXX0=

package/dist/src/talgo.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @prettier
+ */
+import { BaseCoin, BitGoBase } from '@bitgo-beta/sdk-core';
+import { Algo } from './algo';
+export declare class Talgo extends Algo {
+    constructor(bitgo: BitGoBase);
+    static createInstance(bitgo: BitGoBase): BaseCoin;
+    getChain(): string;
+    getFullName(): string;
+}
+//# sourceMappingURL=talgo.d.ts.map

package/dist/src/talgo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"talgo.d.ts","sourceRoot":"","sources":["../../src/talgo.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,qBAAa,KAAM,SAAQ,IAAI;gBACjB,KAAK,EAAE,SAAS;IAI5B,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,SAAS,GAAG,QAAQ;IAIjD,QAAQ,IAAI,MAAM;IAIlB,WAAW,IAAI,MAAM;CAGtB"}

package/dist/src/talgo.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Talgo = void 0;
+const algo_1 = require("./algo");
+class Talgo extends algo_1.Algo {
+    constructor(bitgo) {
+        super(bitgo);
+    }
+    static createInstance(bitgo) {
+        return new Talgo(bitgo);
+    }
+    getChain() {
+        return 'talgo';
+    }
+    getFullName() {
+        return 'Testnet Algorand';
+    }
+}
+exports.Talgo = Talgo;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGFsZ28uanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdGFsZ28udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBSUEsaUNBQThCO0FBRTlCLE1BQWEsS0FBTSxTQUFRLFdBQUk7SUFDN0IsWUFBWSxLQUFnQjtRQUMxQixLQUFLLENBQUMsS0FBSyxDQUFDLENBQUM7SUFDZixDQUFDO0lBRUQsTUFBTSxDQUFDLGNBQWMsQ0FBQyxLQUFnQjtRQUNwQyxPQUFPLElBQUksS0FBSyxDQUFDLEtBQUssQ0FBQyxDQUFDO0lBQzFCLENBQUM7SUFFRCxRQUFRO1FBQ04sT0FBTyxPQUFPLENBQUM7SUFDakIsQ0FBQztJQUVELFdBQVc7UUFDVCxPQUFPLGtCQUFrQixDQUFDO0lBQzVCLENBQUM7Q0FDRjtBQWhCRCxzQkFnQkMiLCJzb3VyY2VzQ29udGVudCI6WyIvKipcbiAqIEBwcmV0dGllclxuICovXG5pbXBvcnQgeyBCYXNlQ29pbiwgQml0R29CYXNlIH0gZnJvbSAnQGJpdGdvLWJldGEvc2RrLWNvcmUnO1xuaW1wb3J0IHsgQWxnbyB9IGZyb20gJy4vYWxnbyc7XG5cbmV4cG9ydCBjbGFzcyBUYWxnbyBleHRlbmRzIEFsZ28ge1xuICBjb25zdHJ1Y3RvcihiaXRnbzogQml0R29CYXNlKSB7XG4gICAgc3VwZXIoYml0Z28pO1xuICB9XG5cbiAgc3RhdGljIGNyZWF0ZUluc3RhbmNlKGJpdGdvOiBCaXRHb0Jhc2UpOiBCYXNlQ29pbiB7XG4gICAgcmV0dXJuIG5ldyBUYWxnbyhiaXRnbyk7XG4gIH1cblxuICBnZXRDaGFpbigpOiBzdHJpbmcge1xuICAgIHJldHVybiAndGFsZ28nO1xuICB9XG5cbiAgZ2V0RnVsbE5hbWUoKTogc3RyaW5nIHtcbiAgICByZXR1cm4gJ1Rlc3RuZXQgQWxnb3JhbmQnO1xuICB9XG59XG4iXX0=

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@bitgo-beta/sdk-coin-algo",
+  "version": "1.1.0",
+  "description": "BitGo SDK coin library for Algorand",
+  "main": "./dist/src/index.js",
+  "types": "./dist/src/index.d.ts",
+  "scripts": {
+    "build": "yarn tsc --build --incremental --verbose .",
+    "fmt": "prettier --write .",
+    "check-fmt": "prettier --check .",
+    "clean": "rm -r ./dist",
+    "lint": "eslint --quiet .",
+    "prepare": "npm run build",
+    "test": "npm run coverage",
+    "coverage": "nyc -- npm run unit-test",
+    "unit-test": "mocha"
+  },
+  "author": "BitGo SDK Team <sdkteam@bitgo.com>",
+  "license": "MIT",
+  "engines": {
+    "node": ">=14 <17"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/BitGo/BitGoJS.git",
+    "directory": "modules/sdk-coin-algo"
+  },
+  "lint-staged": {
+    "*.{js,ts}": [
+      "yarn prettier --write",
+      "yarn eslint --fix"
+    ]
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "nyc": {
+    "extension": [
+      ".ts"
+    ]
+  },
+  "dependencies": {
+    "@bitgo-beta/sdk-core": "^1.1.0",
+    "@bitgo-beta/statics": "^7.0.0",
+    "@bitgo-beta/utxo-lib": "^2.4.1",
+    "@hashgraph/cryptography": "1.1.2",
+    "@stablelib/hex": "^1.0.0",
+    "algosdk": "^1.14.0",
+    "bignumber.js": "^9.0.0",
+    "hi-base32": "^0.5.1",
+    "joi": "^17.4.0",
+    "js-sha512": "0.8.0",
+    "lodash": "^4.17.14",
+    "stellar-sdk": "^10.0.1",
+    "tweetnacl": "^1.0.3"
+  },
+  "devDependencies": {
+    "@bitgo-beta/sdk-api": "^1.1.0",
+    "@bitgo-beta/sdk-test": "^1.0.1",
+    "should": "^13.1.3",
+    "sinon": "^7.5.0"
+  },
+  "gitHead": "3856d480cfc4866bdf8b3dae79804be4dbdb517a"
+}

package/types/index.d.ts

@@ -0,0 +1,60 @@
+// TODO: Remove augmentation after algosdk fork is completely replaced by
+// account lib.
+declare module 'algosdk' {
+  interface Encoding {
+    decode(_: unknown): any;
+  }
+
+  interface Seed {
+    encode(secretKey: unknown): string;
+    decode(seed: unknown): {
+      checksum: Uint8Array;
+      seed: Uint8Array;
+    };
+  }
+
+  interface Address {
+    decode(address: unknown): {
+      publicKey: Uint8Array;
+      checksum: Uint8Array;
+    };
+    encode(address: unknown): string;
+  }
+
+  class MultiSigTransaction {
+    static from_obj_for_encoding(txnForEnc: unknown): any;
+  }
+
+  interface Multisig {
+    MultiSigTransaction: typeof MultiSigTransaction;
+  }
+
+  interface Nacl {
+    sign(msg: unknown, secretKey: unknown): Uint8Array;
+    verify(msg: unknown, sig: unknown, publicKey: unknown): boolean;
+  }
+
+  export function generateAccountFromSeed(seed: Uint8Array | string): {
+    sk: string;
+    addr: string;
+  };
+
+  export function isValidSeed(seed: string): boolean;
+
+  export function isValidAddress(address: string): boolean;
+
+  export interface Account {
+    addr: string;
+    sk: Uint8Array;
+  }
+
+  export function generateAccount(): Account;
+
+  export function mergeMultisigTransactions(multisigTxnBlobs: Uint8Array[]): Uint8Array;
+
+  export const Encoding: Encoding;
+  export const Seed: Seed;
+  export const Address: Address;
+  export const Multisig: Multisig;
+  export const NaclWrapper: Nacl;
+}