hd-key-ed25519/dist/index.js

BIP-0032 like derivation for ed25519 curve

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.derivePath = exports.isValidPath = exports.getPublicKey = exports.getMasterKeyFromSeed = void 0;
const createHmac = require("create-hmac");
const nacl = require("tweetnacl");
const bs58check = require("bs58check");
const crypto = require("crypto");
const utils_1 = require("./utils");
const assert = require('assert');
const ED25519_CURVE = 'ed25519 seed';
const HARDENED_OFFSET = 0x80000000;
const getMasterKeyFromSeed = (seed) => {
    const hmac = createHmac('sha512', ED25519_CURVE);
    const I = hmac.update(Buffer.from(seed, 'hex')).digest();
    const IL = I.slice(0, 32);
    const IR = I.slice(32);
    return {
        key: IL,
        chainCode: IR,
    };
};
exports.getMasterKeyFromSeed = getMasterKeyFromSeed;
const CKDPriv = ({ key, chainCode }, index) => {
    const indexBuffer = Buffer.allocUnsafe(4);
    indexBuffer.writeUInt32BE(index, 0);
    const data = Buffer.concat([Buffer.alloc(1, 0), key, indexBuffer]);
    const I = createHmac('sha512', chainCode)
        .update(data)
        .digest();
    const IL = I.slice(0, 32);
    const IR = I.slice(32);
    return {
        key: IL,
        chainCode: IR,
    };
};
const getPublicKey = (privateKey, withZeroByte = false) => {
    const keyPair = nacl.sign.keyPair.fromSeed(privateKey);
    const signPk = keyPair.secretKey.subarray(32);
    const zero = Buffer.alloc(1, 0);
    return withZeroByte ?
        Buffer.concat([zero, Buffer.from(signPk)]) :
        Buffer.from(signPk);
};
exports.getPublicKey = getPublicKey;
const isValidPath = (path) => {
    if (!utils_1.pathRegex.test(path)) {
        return false;
    }
    return !path
        .split('/')
        .slice(1)
        .map(utils_1.replaceDerive)
        .some(isNaN);
};
exports.isValidPath = isValidPath;
const derivePath = (path, seed, offset = HARDENED_OFFSET) => {
    if (!(0, exports.isValidPath)(path)) {
        throw new Error('Invalid derivation path');
    }
    const { key, chainCode } = (0, exports.getMasterKeyFromSeed)(seed);
    const segments = path
        .split('/')
        .slice(1)
        .map(utils_1.replaceDerive)
        .map(el => parseInt(el, 10));
    return segments.reduce((parentKeys, segment) => CKDPriv(parentKeys, segment + offset), { key, chainCode });
};
exports.derivePath = derivePath;
const BIP32_PRIVATE_VERSION = 0x0488ADE4;
const LEN = 78;
function serialize(hdkey, version, key) {
    const buffer = Buffer.allocUnsafe(LEN);
    buffer.writeUInt32BE(version, 0);
    buffer.writeUInt8(hdkey.depth, 4);
    const fingerprint = hdkey.depth ? hdkey.parentFingerprint : 0x00000000;
    buffer.writeUInt32BE(fingerprint, 5);
    buffer.writeUInt32BE(hdkey.index, 9);
    hdkey.chainCode.copy(buffer, 13);
    key.copy(buffer, 45);
    return buffer;
}
function hash160(buf) {
    const sha = crypto.createHash('sha256').update(buf).digest();
    return crypto.createHash('ripemd160').update(sha).digest();
}
class HDKey {
    constructor(version) {
        this.depth = 0;
        this.index = 0;
        this.chainCode = null;
        this.parentFingerprint = 0;
        this._privateKey = null;
        this._publicKey = null;
        this._identifier = null;
        this._fingerprint = 0;
        this.version = version || BIP32_PRIVATE_VERSION;
    }
    get privateKey() {
        return this._privateKey;
    }
    get publicKey() {
        return this._publicKey;
    }
    get publicKeyWithZeroByte() {
        return (0, exports.getPublicKey)(this._privateKey, true);
    }
    set prvKey(value) {
        assert.equal(value.length, 32, 'Private key must be 32 bytes.');
        this._privateKey = value;
        this._publicKey = (0, exports.getPublicKey)(this._privateKey);
        this._identifier = hash160(this._publicKey);
        this._fingerprint = this._identifier.slice(0, 4).readUInt32BE(0);
    }
    get privateExtendedKey() {
        if (this._privateKey) {
            return bs58check.encode(serialize(this, this.version, Buffer.concat([Buffer.alloc(1, 0), this.privateKey])));
        }
        return null;
    }
    static fromMasterSeed(seed, version = BIP32_PRIVATE_VERSION) {
        const { key, chainCode } = (0, exports.getMasterKeyFromSeed)(seed);
        const hdkey = new HDKey(version);
        hdkey.prvKey = key;
        hdkey.chainCode = chainCode;
        return hdkey;
    }
    static fromExtendedKey(base58key, version = BIP32_PRIVATE_VERSION) {
        const hdkey = new HDKey(version);
        const keyBuffer = bs58check.decode(base58key);
        const keyVersion = keyBuffer.readUInt32BE(0);
        assert(keyVersion === BIP32_PRIVATE_VERSION, 'version mismatch: does not match private');
        hdkey.depth = keyBuffer.readUInt8(4);
        hdkey.parentFingerprint = keyBuffer.readUInt32BE(5);
        hdkey.index = keyBuffer.readUInt32BE(9);
        hdkey.chainCode = keyBuffer.slice(13, 45);
        const key = keyBuffer.slice(45);
        hdkey.prvKey = key.slice(1);
        return hdkey;
    }
    derive(path) {
        if (path.toLowerCase() === 'm' || path.toLowerCase() === 'm\'') {
            return this;
        }
        const entries = path.split('/');
        let hdkey = this;
        entries.forEach(function (c, i) {
            if (i === 0) {
                assert(/^[mM]/.test(c), 'Path must start with "m" or "M"');
                return;
            }
            const childIndex = parseInt(c, 10);
            hdkey = hdkey.deriveChild(childIndex);
        });
        return hdkey;
    }
    deriveChild(index) {
        const hardenedIndex = (index >= HARDENED_OFFSET) ? index : (index + HARDENED_OFFSET);
        assert(this.privateKey, 'Could not derive hardened child key');
        const { key, chainCode } = CKDPriv({ key: this._privateKey, chainCode: this.chainCode }, hardenedIndex);
        const hd = new HDKey(this.version);
        hd.prvKey = key;
        hd.chainCode = chainCode;
        hd.depth = this.depth + 1;
        hd.parentFingerprint = this._fingerprint;
        hd.index = hardenedIndex;
        return hd;
    }
}
exports.default = HDKey;