dash-platform-sdk 1.3.0-dev.1 → 1.3.0-dev.10

package/src/keyPair/index.js

@@ -1,323 +1,89 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
+import { HDKey } from '@scure/bip32';
+import mnemonicToSeed from './mnemonicToSeed.js';
+import deriveChild from './deriveChild.js';
+import derivePath from './derivePath.js';
+import { p2pkh } from '@scure/btc-signer';
+const DASH_VERSIONS = {
+    mainnet: { pubKeyHash: 0x4c, scriptHash: 0x10, bech32: 'dc', wif: 0xcc, private: 0x0488ade4, public: 0x0488b21e },
+    testnet: { pubKeyHash: 0x8c, scriptHash: 0x13, bech32: 'dc', wif: 0xef, private: 0x04358394, public: 0x043587cf }
 };
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
-    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.KeyPairController = void 0;
-var deriveChild_1 = require("./deriveChild");
-var derivePath_1 = require("./derivePath");
-var keyToXPublicKey_1 = require("./keyToXPublicKey");
-var keyToWalletId_1 = require("./keyToWalletId");
-var keyToXPrivateKey_1 = require("./keyToXPrivateKey");
-var mnemonicToIdentityKey_1 = require("./mnemonicToIdentityKey");
-var mnemonicToSeed_1 = require("./mnemonicToSeed");
-var mnemonicToWallet_1 = require("./mnemonicToWallet");
-var privateKeyToWif_1 = require("./privateKeyToWif");
-var publicKeyToAddress_1 = require("./publicKeyToAddress");
-var seedToWallet_1 = require("./seedToWallet");
-var walletToIdentityKey_1 = require("./walletToIdentityKey");
-var xkeyToHDXKey_1 = require("./xkeyToHDXKey");
 /**
  * Collection of functions to work with private keys and seed phrases
  *
  * @hideconstructor
  */
-var KeyPairController = /** @class */ (function () {
-    function KeyPairController() {
-    }
-    /**
-     * Allows to derive child HD Key
-     *
-     * @param parent {HDKey} - The HDKey parent instance
-     * @param index {number} - Index of child
-     * @param hardened {boolean} - hardened or no
-     *
-     * @return {Promise<HDKey>} A promise that resolves child key
-     */
-    KeyPairController.prototype.deriveChild = function (parent, index, hardened) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, (0, deriveChild_1.default)(parent, index, hardened)];
-                    case 1: return [2 /*return*/, _a.sent()];
-                }
-            });
-        });
-    };
-    /**
-     * Allows to derive HD key by path
-     *
-     * @param parent {HDKey} - The HDKey parent instance
-     * @param path {string} - Path of children
-     *
-     * @return {Promise<HDKey>} A promise that resolves key by path
-     */
-    KeyPairController.prototype.derivePath = function (parent, path) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, (0, derivePath_1.default)(parent, path)];
-                    case 1: return [2 /*return*/, _a.sent()];
-                }
-            });
-        });
-    };
-    /**
-     * Convert a HDKey to a public key
-     *
-     * @param hdKey {HDKey} - The HDKey to be converted into a public key
-     * @param opts {NetworkVersion=} - Network version
-     *
-     * @return {Promise<Uint8Array>} - converted public key
-     */
-    KeyPairController.prototype.keyToPublicKey = function (hdKey, opts) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, (0, keyToXPublicKey_1.default)(hdKey, opts)];
-                    case 1: return [2 /*return*/, _a.sent()];
-                }
-            });
-        });
-    };
-    /**
-     * Converts a HDKey to a wallet ID
-     *
-     * @param hdKey {HDKey} - The HDKey to be converted into a wallet id.
-     *
-     * @return {Promise<string>} Wallet id from used key
-     */
-    KeyPairController.prototype.keyToWalletId = function (hdKey) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, (0, keyToWalletId_1.default)(hdKey)];
-                    case 1: return [2 /*return*/, _a.sent()];
-                }
-            });
-        });
-    };
-    /**
-     * Converts an HDKey instance to an extended private key (xprv)
-     *
-     * @param hdKey {HDKey} - The HDKey instance to convert
-     * @param opts {NetworkVersion=} - Optional, containing the version
-     *
-     * @returns {Promise<string>} A promise that resolves to the xPrivateKey string
-     */
-    KeyPairController.prototype.keyToXPrivateKey = function (hdKey, opts) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, (0, keyToXPrivateKey_1.default)(hdKey, opts)];
-                    case 1: return [2 /*return*/, _a.sent()];
-                }
-            });
-        });
-    };
-    /**
-     * Convert a HDKey to a xPublicKey
-     * @param hdKey {HDKey} - The HDKey instance to convert
-     * @param opts {NetworkVersion=} - Optional, containing the version
-     *
-     * @return {Promise<Uint8Array>}
-     */
-    KeyPairController.prototype.keyToXPublicKey = function (hdKey, opts) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, (0, keyToXPublicKey_1.default)(hdKey, opts)];
-                    case 1: return [2 /*return*/, _a.sent()];
-                }
-            });
-        });
-    };
-    /**
-     * Derives an Identity HDKey from a mnemonic phrase.
-     *
-     * @param mnemonic {string} - The BIP39 mnemonic phrase.
-     * @param identityIndex {number} - The identity index (default: 0).
-     * @param keyIndex {number} - The key index within the identity (default: 0).
-     * @param salt {string=} - Optional salt for seed derivation.
-     * @param verify {boolean=} - Whether to verify the mnemonic during derivation.
-     * @param opts {(HDFromSeedOptions & WalletToIdentityKeyOpts)=} - Additional options for HD seed derivation and wallet-to-identity conversion.
-     *
-     * @returns {Promise<HDKey>} A promise that resolves to the derived identity HDKey.
-     */
-    KeyPairController.prototype.mnemonicToIdentityKey = function (mnemonic, identityIndex, keyIndex, salt, verify, opts) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, (0, mnemonicToIdentityKey_1.default)(mnemonic, identityIndex !== null && identityIndex !== void 0 ? identityIndex : 0, keyIndex !== null && keyIndex !== void 0 ? keyIndex : 0, salt, verify, opts)];
-                    case 1: return [2 /*return*/, _a.sent()];
-                }
-            });
-        });
-    };
+export class KeyPairController {
     /**
      * Returns seed from mnemonic phrase
      *
      * @param mnemonic {string} - The BIP39 mnemonic phrase.
      * @param salt {string=} -  Optional salt for seed derivation.
-     * @param verify {boolean=} - Whether to verify the mnemonic during derivation.
      *
-     * @return {Promise<Uint8Array>} Seed bytes
+     * @return {Uint8Array} Seed bytes
      */
-    KeyPairController.prototype.mnemonicToSeed = function (mnemonic, salt, verify) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, (0, mnemonicToSeed_1.default)(mnemonic, salt, verify)];
-                    case 1: return [2 /*return*/, _a.sent()];
-                }
-            });
-        });
-    };
+    mnemonicToSeed(mnemonic, salt) {
+        return mnemonicToSeed(mnemonic, salt);
+    }
     /**
-     * Returns wallet from mnemonic phrase
+     * Returns seed from mnemonic phrase
      *
-     * @param mnemonic {string} - The BIP39 mnemonic phrase.
-     * @param salt {string=} - Optional salt for seed derivation.
-     * @param verify {boolean=} - Whether to verify the mnemonic during derivation.
-     * @param opts {HDFromSeedOptions=} - Optional derivation settings
+     * @param seed {Uint8Array}
+     * @param network {Network} network
      *
-     * @return {Promise<HDWallet>} Wallet from mnemonic
+     * @return {HDKey} HDKey
      */
-    KeyPairController.prototype.mnemonicToWallet = function (mnemonic, salt, verify, opts) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, (0, mnemonicToWallet_1.default)(mnemonic, salt, verify, opts)];
-                    case 1: return [2 /*return*/, _a.sent()];
-                }
-            });
-        });
-    };
+    seedToHdKey(seed, network = 'mainnet') {
+        return HDKey.fromMasterSeed(seed, DASH_VERSIONS[network]);
+    }
     /**
-     * Convert a private key to WIF
-     *
-     * @param privateKeyBytes {Uint8Array} - Private key bytes
-     * @param opts {NetworkVersion=} - Optional options with network version
-     *
-     * @return {Promise<string>} WIF
-     */
-    KeyPairController.prototype.privateKeyToWif = function (privateKeyBytes, opts) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, (0, privateKeyToWif_1.default)(privateKeyBytes, opts)];
-                    case 1: return [2 /*return*/, _a.sent()];
-                }
-            });
-        });
-    };
+       * Allows to derive child HD Key
+       *
+       * @param hdKey {HDKey} - The HDKey parent instance
+       * @param index {number} - Index of child
+       *
+       * @return {Promise<HDKey>} A promise that resolves child key
+       */
+    async deriveChild(hdKey, index) {
+        return deriveChild(hdKey, index);
+    }
     /**
-     * Convert public key to address
-     *
-     * @param publicKeyBytes {Uint8Array} - Bytes of public key
-     * @param opts {NetworkVersion=} - Optional options with network version
-     *
-     * @return {Promise<string>} address string
-     */
-    KeyPairController.prototype.publicKeyToAddress = function (publicKeyBytes, opts) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, (0, publicKeyToAddress_1.default)(publicKeyBytes, opts)];
-                    case 1: return [2 /*return*/, _a.sent()];
-                }
-            });
-        });
-    };
+       * Allows to derive HD key by path
+       *
+       * @param hdKey {HDKey} - The HDKey parent instance
+       * @param path {string} - Path of children
+       *
+       * @return {Promise<HDKey>} A promise that resolves key by path
+       */
+    async derivePath(hdKey, path) {
+        return derivePath(hdKey, path);
+    }
     /**
-     * Convert seed bytes to wallet
+     * Derives an {HDKey} child by identity index and key index from an {HDKey}
      *
-     * @param seed {Uint8Array} - seed bytes
-     * @param opts {HDFromSeedOptions?} - Optional options with network version
+     * Usually used to get a identity private key from seed
      *
-     * @return {Promise<HDWallet>}
-     */
-    KeyPairController.prototype.seedToWallet = function (seed, opts) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, (0, seedToWallet_1.default)(seed, opts)];
-                    case 1: return [2 /*return*/, _a.sent()];
-                }
-            });
-        });
-    };
-    /**
-     * Returns identity key from wallet
-     *
-     * @param wallet {HDWallet | HDKey} - wallet that will be used
-     * @param identityIndex {number} - index of identity for wallet
-     * @param keyIndex {number} - index of key for identity
-     * @param opts {WalletToIdentityKeyOpts=} - optional options
+     * @param hdKey {HDKey}
+     * @param identityIndex {number}
+     * @param keyIndex {number}
+     * @param network {Network}
      *
-     * @return {Promise<HDKey>}
+     * @returns {HDKey}
      */
-    KeyPairController.prototype.walletToIdentityKey = function (wallet_1, identityIndex_1, keyIndex_1) {
-        return __awaiter(this, arguments, void 0, function (wallet, identityIndex, keyIndex, opts) {
-            if (opts === void 0) { opts = { network: 'testnet' }; }
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, (0, walletToIdentityKey_1.default)(wallet, identityIndex, keyIndex, opts)];
-                    case 1: return [2 /*return*/, _a.sent()];
-                }
-            });
-        });
-    };
+    deriveIdentityPrivateKey(hdKey, identityIndex, keyIndex, network) {
+        const networkIndex = network === 'mainnet' ? 5 : 1;
+        const pathPostfix = `/5'/0'/0'/${identityIndex}'/${keyIndex}'`;
+        return derivePath(hdKey, `m/9'/${networkIndex}'${pathPostfix}`);
+    }
     /**
-     * Allows to convert xKey to HDXKey
+     * Converts {PublicKey} to a Dash network address (P2PKH)
+     *
+     * @param publicKey {Uint8Array}
+     * @param network {Network}
      *
-     * @param xKey {string} - String with xKey
-     * @param opts {HDFromXKeyOptions=} - Optional options
-     * @return {Promise<HDXKey>}
+     * @returns {string}
      */
-    KeyPairController.prototype.xKeyToHDXKey = function (xKey, opts) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, (0, xkeyToHDXKey_1.default)(xKey, opts)];
-                    case 1: return [2 /*return*/, _a.sent()];
-                }
-            });
-        });
-    };
-    return KeyPairController;
-}());
-exports.KeyPairController = KeyPairController;
+    p2pkhAddress(publicKey, network) {
+        const P2PKH = p2pkh(publicKey, DASH_VERSIONS[network]);
+        return P2PKH.address;
+    }
+}

package/src/keyPair/mnemonicToSeed.d.ts

@@ -1 +1 @@
-export default function mnemonicToSeed(mnemonic: string, salt?: string, verify?: boolean): Promise<Uint8Array>;
+export default function mnemonicToSeed(mnemonic: string, salt?: string): Uint8Array;

package/src/keyPair/mnemonicToSeed.js

@@ -1,47 +1,4 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
-    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = mnemonicToSeed;
-var DashPhrase = require("dashphrase");
-function mnemonicToSeed(mnemonic, salt, verify) {
-    return __awaiter(this, void 0, void 0, function () {
-        return __generator(this, function (_a) {
-            return [2 /*return*/, DashPhrase.toSeed(mnemonic, salt, { verify: verify })];
-        });
-    });
+import { mnemonicToSeedSync as func } from '@scure/bip39';
+export default function mnemonicToSeed(mnemonic, salt) {
+    return func(mnemonic, salt);
 }

package/src/names/index.d.ts

@@ -1,5 +1,6 @@
-import GRPCConnectionPool from '../grpcConnectionPool';
-import { DocumentWASM } from 'pshenmic-dpp';
+import GRPCConnectionPool from '../grpcConnectionPool.js';
+import { DocumentWASM, PrivateKeyWASM } from 'pshenmic-dpp';
+import { IdentifierLike } from '../types.js';
 /**
  * Functions related to DPNS names (usernames)
  *
@@ -23,5 +24,45 @@ export declare class NamesController {
      *
      * @return Promise<DocumentWASM | null>
      */
-    search(name: string): Promise<DocumentWASM | null>;
+    searchByName(name: string): Promise<DocumentWASM[]>;
+    /**
+     * Tests a given username against contested names rules.
+     * Contested names includes an additional fee of 0.2 Dash
+     * as a voting resolution fee
+     *
+     * This function return boolean whether given username (f.e pshenmic.dash)
+     * falls under contested names rules.
+     * @param name
+     */
+    testNameContested(name: string): boolean;
+    searchByIdentity(identifier: IdentifierLike): Promise<DocumentWASM[]>;
+    /**
+     * Performs a DPNS name registration sequence
+     * Contested names are include additional fee of 0.2 Dash
+     * Check your name is contested with .testNameContested(name) method to check if additional fee will be charged
+     *
+     * @param name {string} username (ex. pshenmic.dash)
+     * @param identityId {IdentifierLike} identity identifier
+     * @param privateKey {PrivateKeyWASM} Authentication / High private key from your identity
+     */
+    registerName(name: string, identityId: IdentifierLike, privateKey: PrivateKeyWASM): Promise<void>;
+    /**
+     * Converts DPNS name to normalized format (ex. alice.dash -> al1ce.dash)
+     *
+     * source: https://github.com/dashpay/platform/blob/master/packages/js-dash-sdk/src/utils/convertToHomographSafeChars.ts
+     *
+     *
+     * @param label {string}
+     *
+     * @return {string}
+     */
+    normalizeLabel(label: string): string;
+    /**
+     * Validates a DPNS name that you would like to register
+     *
+     * @param fullName {string} full DPNS name (ex. pshenmic.dash)
+     *
+     * @return {string} null if valid or string with a reason
+     */
+    validateName(fullName: string): null | string;
 }