ox 0.0.1 → 0.1.0

package/_types/HdKey.d.ts

@@ -0,0 +1,146 @@
+import { type Versions } from '@scure/bip32';
+import * as Bytes from './Bytes.js';
+import type * as Errors from './Errors.js';
+import type * as Hex from './Hex.js';
+import type * as PublicKey from './PublicKey.js';
+import * as internal from './internal/hdKey.js';
+/** Root type for a Hierarchical Deterministic (HD) Key. */
+export type HdKey = {
+    derive: (path: string) => HdKey;
+    depth: number;
+    index: number;
+    identifier: Hex.Hex;
+    privateKey: Hex.Hex;
+    privateExtendedKey: string;
+    publicKey: PublicKey.PublicKey<false>;
+    publicExtendedKey: string;
+    versions: Versions;
+};
+/**
+ * Creates a HD Key from an extended private key.
+ *
+ * @example
+ * ```ts twoslash
+ * import { HdKey } from 'ox'
+ *
+ * const hdKey = HdKey.fromExtendedKey('...')
+ *
+ * console.log(hdKey.privateKey)
+ * // @log: '0x...'
+ * ```
+ *
+ * @param extendedKey - The extended private key.
+ * @returns The HD Key.
+ */
+export declare function fromExtendedKey(extendedKey: string): HdKey;
+export declare namespace fromExtendedKey {
+    var parseError: (error: unknown) => fromExtendedKey.ErrorType;
+}
+export declare namespace fromExtendedKey {
+    type ErrorType = internal.fromScure.ErrorType | Errors.GlobalErrorType;
+}
+/**
+ * Creates a HD Key from a JSON object containing an extended private key (`xpriv`).
+ *
+ * @example
+ * ```ts twoslash
+ * import { HdKey } from 'ox'
+ *
+ * const hdKey = HdKey.fromJson({ xpriv: '...' })
+ *
+ * console.log(hdKey.privateKey)
+ * // @log: '0x...'
+ * ```
+ *
+ * @param json - The JSON object containing an extended private key (`xpriv`).
+ * @returns The HD Key.
+ */
+export declare function fromJson(json: {
+    xpriv: string;
+}): HdKey;
+export declare namespace fromJson {
+    var parseError: (error: unknown) => fromJson.ErrorType;
+}
+export declare namespace fromJson {
+    type ErrorType = internal.fromScure.ErrorType | Errors.GlobalErrorType;
+}
+/**
+ * Creates a HD Key from a master seed.
+ *
+ * @example
+ * ```ts twoslash
+ * import { HdKey, Mnemonic } from 'ox'
+ *
+ * const seed = Mnemonic.toSeed('test test test test test test test test test test test junk')
+ * const hdKey = HdKey.fromSeed(seed)
+ * ```
+ *
+ * @example
+ * ### Path Derivation
+ *
+ * You can derive a HD Key at a specific path using `derive`.
+ *
+ * ```ts twoslash
+ * import { HdKey, Mnemonic } from 'ox'
+ *
+ * const mnemonic = Mnemonic.toSeed('test test test test test test test test test test test junk')
+ * const hdKey = HdKey.fromSeed(mnemonic).derive(HdKey.path())
+ *
+ * console.log(hdKey.privateKey)
+ * // @log: '0x...'
+ * ```
+ *
+ * @param seed - The master seed to create the HD Key from.
+ * @param options - Creation options.
+ * @returns The HD Key.
+ */
+export declare function fromSeed(seed: Hex.Hex | Bytes.Bytes, options?: fromSeed.Options): HdKey;
+export declare namespace fromSeed {
+    var parseError: (error: unknown) => fromSeed.ErrorType;
+}
+export declare namespace fromSeed {
+    type Options = {
+        /** The versions to use for the HD Key. */
+        versions?: Versions | undefined;
+    };
+    type ErrorType = Bytes.from.ErrorType | internal.fromScure.ErrorType | Errors.GlobalErrorType;
+}
+/**
+ * Creates an Ethereum-based BIP-44 HD path.
+ *
+ * @example
+ * ```ts twoslash
+ * import { HdKey } from 'ox'
+ *
+ * const path = HdKey.path({ account: 1, index: 2 })
+ * // @log: "m/44'/60'/1'/0/2"
+ * ```
+ *
+ * @param options - Path options.
+ * @returns The path.
+ */
+export declare function path(options?: path.Options): string;
+export declare namespace path {
+    var parseError: (error: unknown) => path.ErrorType;
+}
+export declare namespace path {
+    type Options = {
+        /**
+         * The account.
+         * @default 0
+         */
+        account?: number | undefined;
+        /**
+         * The change.
+         * @default 0
+         */
+        change?: number | undefined;
+        /**
+         * The address index.
+         * @default 0
+         */
+        index?: number | undefined;
+    };
+    type ErrorType = Errors.GlobalErrorType;
+}
+//# sourceMappingURL=HdKey.d.ts.map

package/_types/HdKey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HdKey.d.ts","sourceRoot":"","sources":["../HdKey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAS,KAAK,QAAQ,EAAE,MAAM,cAAc,CAAA;AACnD,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AACnC,OAAO,KAAK,KAAK,MAAM,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,KAAK,GAAG,MAAM,UAAU,CAAA;AACpC,OAAO,KAAK,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAChD,OAAO,KAAK,QAAQ,MAAM,qBAAqB,CAAA;AAE/C,2DAA2D;AAC3D,MAAM,MAAM,KAAK,GAAG;IAClB,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,KAAK,CAAA;IAC/B,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,UAAU,EAAE,GAAG,CAAC,GAAG,CAAA;IACnB,UAAU,EAAE,GAAG,CAAC,GAAG,CAAA;IACnB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,SAAS,EAAE,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;IACrC,iBAAiB,EAAE,MAAM,CAAA;IACzB,QAAQ,EAAE,QAAQ,CAAA;CACnB,CAAA;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,eAAe,CAAC,WAAW,EAAE,MAAM,GAAG,KAAK,CAG1D;yBAHe,eAAe;4BASM,OAAO,KAEjC,eAAe,CAAC,SAAS;;AANpC,MAAM,CAAC,OAAO,WAAW,eAAe,CAAC;IACvC,KAAK,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACvE;AAMD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAAG,KAAK,CAEvD;yBAFe,QAAQ;4BAQM,OAAO,KAE1B,QAAQ,CAAC,SAAS;;AAN7B,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,KAAK,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACvE;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,QAAQ,CACtB,IAAI,EAAE,GAAG,CAAC,GAAG,GAAG,KAAK,CAAC,KAAK,EAC3B,OAAO,GAAE,QAAQ,CAAC,OAAY,GAC7B,KAAK,CAIP;yBAPe,QAAQ;4BAqBM,OAAO,KAE1B,QAAQ,CAAC,SAAS;;AAd7B,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,KAAK,OAAO,GAAG;QACb,0CAA0C;QAC1C,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;KAChC,CAAA;IAED,KAAK,SAAS,GACV,KAAK,CAAC,IAAI,CAAC,SAAS,GACpB,QAAQ,CAAC,SAAS,CAAC,SAAS,GAC5B,MAAM,CAAC,eAAe,CAAA;CAC3B;AAMD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,IAAI,CAAC,OAAO,GAAE,IAAI,CAAC,OAAY,GAAG,MAAM,CAGvD;yBAHe,IAAI;4BA4BM,OAAO,KAAc,IAAI,CAAC,SAAS;;AAvB7D,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,KAAK,OAAO,GAAG;QACb;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QAC5B;;;WAGG;QACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;QAC3B;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAC3B,CAAA;IAED,KAAK,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACxC"}