ox 0.0.1 → 0.1.0

package/_types/Authorization.d.ts

@@ -0,0 +1,461 @@
+import type * as Address from './Address.js';
+import type * as Errors from './Errors.js';
+import * as Hash from './Hash.js';
+import * as Hex from './Hex.js';
+import * as Rlp from './Rlp.js';
+import * as Signature from './Signature.js';
+import type { Compute, Undefined } from './internal/types.js';
+/** Root type for an EIP-7702 Authorization. */
+export type Authorization<signed extends boolean = boolean, bigintType = bigint, numberType = number> = Compute<{
+    /** Address of the contract to set as code for the Authority. */
+    address: Address.Address;
+    /** Chain ID to authorize. */
+    chainId: numberType;
+    /** Nonce of the Authority to authorize. */
+    nonce: bigintType;
+} & (signed extends true ? Signature.Signature<true, bigintType, numberType> : Undefined<Signature.Signature>)>;
+/** RPC representation of an {@link ox#Authorization.Authorization}. */
+export type Rpc = Authorization<true, Hex.Hex, Hex.Hex>;
+/** List of {@link ox#Authorization.Authorization}. */
+export type List<signed extends boolean = boolean, bigintType = bigint, numberType = number> = Compute<readonly Authorization<signed, bigintType, numberType>[]>;
+/** RPC representation of an {@link ox#Authorization.List}. */
+export type ListRpc = List<true, Hex.Hex, Hex.Hex>;
+/** Signed representation of a list of {@link ox#Authorization.Authorization}. */
+export type ListSigned<bigintType = bigint, numberType = number> = List<true, bigintType, numberType>;
+/** Signed representation of an {@link ox#Authorization.Authorization}. */
+export type Signed<bigintType = bigint, numberType = number> = Authorization<true, bigintType, numberType>;
+/** Tuple representation of an {@link ox#Authorization.Authorization}. */
+export type Tuple<signed extends boolean = boolean> = signed extends true ? readonly [
+    chainId: Hex.Hex,
+    address: Hex.Hex,
+    nonce: Hex.Hex,
+    yParity: Hex.Hex,
+    r: Hex.Hex,
+    s: Hex.Hex
+] : readonly [chainId: Hex.Hex, address: Hex.Hex, nonce: Hex.Hex];
+/** Tuple representation of a signed {@link ox#Authorization.Authorization}. */
+export type TupleSigned = Tuple<true>;
+/** Tuple representation of a list of {@link ox#Authorization.Authorization}. */
+export type TupleList<signed extends boolean = boolean> = readonly Tuple<signed>[];
+/** Tuple representation of a list of signed {@link ox#Authorization.Authorization}. */
+export type TupleListSigned = TupleList<true>;
+/**
+ * Converts an [EIP-7702](https://eips.ethereum.org/EIPS/eip-7702) Authorization object into a typed {@link ox#Authorization.Authorization}.
+ *
+ * @example
+ * An Authorization can be instantiated from an [EIP-7702](https://eips.ethereum.org/EIPS/eip-7702) Authorization tuple in object format.
+ *
+ * ```ts twoslash
+ * import { Authorization } from 'ox'
+ *
+ * const authorization = Authorization.from({
+ *   address: '0x1234567890abcdef1234567890abcdef12345678',
+ *   chainId: 1,
+ *   nonce: 69n,
+ * })
+ * ```
+ *
+ * @example
+ * ### Attaching Signatures
+ *
+ * A {@link ox#Signature.Signature} can be attached with the `signature` option. The example below demonstrates signing
+ * an Authorization with {@link ox#Secp256k1.(sign:function)}.
+ *
+ * ```ts twoslash
+ * import { Authorization, Secp256k1 } from 'ox'
+ *
+ * const authorization = Authorization.from({
+ *   address: '0xbe95c3f554e9fc85ec51be69a3d807a0d55bcf2c',
+ *   chainId: 1,
+ *   nonce: 40n,
+ * })
+ *
+ * const signature = Secp256k1.sign({
+ *   payload: Authorization.getSignPayload(authorization),
+ *   privateKey: '0x...',
+ * })
+ *
+ * const authorization_signed = Authorization.from(authorization, { signature }) // [!code focus]
+ * ```
+ *
+ * @param authorization - An [EIP-7702](https://eips.ethereum.org/EIPS/eip-7702) Authorization tuple in object format.
+ * @param options - Authorization options.
+ * @returns The {@link ox#Authorization.Authorization}.
+ */
+export declare function from<const authorization extends Authorization | Rpc, const signature extends Signature.Signature | undefined = undefined>(authorization: authorization | Authorization, options?: from.Options<signature>): from.ReturnType<authorization, signature>;
+export declare namespace from {
+    var parseError: (error: unknown) => from.ErrorType;
+}
+export declare namespace from {
+    type Options<signature extends Signature.Signature | undefined = Signature.Signature | undefined> = {
+        /** The {@link ox#Signature.Signature} to attach to the Authorization. */
+        signature?: signature | Signature.Signature | undefined;
+    };
+    type ReturnType<authorization extends Authorization | Rpc = Authorization, signature extends Signature.Signature | undefined = Signature.Signature | undefined> = Compute<authorization extends Rpc ? Signed : authorization & (signature extends Signature.Signature ? Readonly<signature> : {})>;
+    type ErrorType = Errors.GlobalErrorType;
+}
+/**
+ * Converts an {@link ox#Authorization.Rpc} to an {@link ox#Authorization.Authorization}.
+ *
+ * @example
+ * ```ts twoslash
+ * import { Authorization } from 'ox'
+ *
+ * const authorization = Authorization.fromRpc({
+ *   address: '0x0000000000000000000000000000000000000000',
+ *   chainId: '0x1',
+ *   nonce: '0x1',
+ *   r: '0x635dc2033e60185bb36709c29c75d64ea51dfbd91c32ef4be198e4ceb169fb4d',
+ *   s: '0x50c2667ac4c771072746acfdcf1f1483336dcca8bd2df47cd83175dbe60f0540',
+ *   yParity: '0x0',
+ * })
+ * ```
+ *
+ * @param authorization - The RPC-formatted Authorization.
+ * @returns A signed {@link ox#Authorization.Authorization}.
+ */
+export declare function fromRpc(authorization: Rpc): Signed;
+export declare namespace fromRpc {
+    var parseError: (error: unknown) => fromRpc.ErrorType;
+}
+export declare namespace fromRpc {
+    type ErrorType = Errors.GlobalErrorType;
+}
+/**
+ * Converts an {@link ox#Authorization.ListRpc} to an {@link ox#Authorization.List}.
+ *
+ * @example
+ * ```ts twoslash
+ * import { Authorization } from 'ox'
+ *
+ * const authorizationList = Authorization.fromRpcList([{
+ *   address: '0x0000000000000000000000000000000000000000',
+ *   chainId: '0x1',
+ *   nonce: '0x1',
+ *   r: '0x635dc2033e60185bb36709c29c75d64ea51dfbd91c32ef4be198e4ceb169fb4d',
+ *   s: '0x50c2667ac4c771072746acfdcf1f1483336dcca8bd2df47cd83175dbe60f0540',
+ *   yParity: '0x0',
+ * }])
+ * ```
+ *
+ * @param authorizationList - The RPC-formatted Authorization list.
+ * @returns A signed {@link ox#Authorization.List}.
+ */
+export declare function fromRpcList(authorizationList: ListRpc): ListSigned;
+export declare namespace fromRpcList {
+    var parseError: (error: unknown) => fromRpcList.ErrorType;
+}
+export declare namespace fromRpcList {
+    type ErrorType = Errors.GlobalErrorType;
+}
+/**
+ * Converts an {@link ox#Authorization.Tuple} to an {@link ox#Authorization.Authorization}.
+ *
+ * @example
+ * ```ts twoslash
+ * import { Authorization } from 'ox'
+ *
+ * const authorization = Authorization.fromTuple([
+ *   '0x1',
+ *   '0xbe95c3f554e9fc85ec51be69a3d807a0d55bcf2c',
+ *   '0x3'
+ * ])
+ * // @log: {
+ * // @log:   address: '0xbe95c3f554e9fc85ec51be69a3d807a0d55bcf2c',
+ * // @log:   chainId: 1,
+ * // @log:   nonce: 3n
+ * // @log: }
+ * ```
+ *
+ * @example
+ * It is also possible to append a Signature tuple to the end of an Authorization tuple.
+ *
+ * ```ts twoslash
+ * import { Authorization } from 'ox'
+ *
+ * const authorization = Authorization.fromTuple([
+ *   '0x1',
+ *   '0xbe95c3f554e9fc85ec51be69a3d807a0d55bcf2c',
+ *   '0x3',
+ *   '0x1',
+ *   '0x68a020a209d3d56c46f38cc50a33f704f4a9a10a59377f8dd762ac66910e9b90',
+ *   '0x7e865ad05c4035ab5792787d4a0297a43617ae897930a6fe4d822b8faea52064',
+ * ])
+ * // @log: {
+ * // @log:   address: '0xbe95c3f554e9fc85ec51be69a3d807a0d55bcf2c',
+ * // @log:   chainId: 1,
+ * // @log:   nonce: 3n
+ * // @log:   r: BigInt('0x68a020a209d3d56c46f38cc50a33f704f4a9a10a59377f8dd762ac66910e9b90'),
+ * // @log:   s: BigInt('0x7e865ad05c4035ab5792787d4a0297a43617ae897930a6fe4d822b8faea52064'),
+ * // @log:   yParity: 0,
+ * // @log: }
+ * ```
+ *
+ * @param tuple - The [EIP-7702](https://eips.ethereum.org/EIPS/eip-7702) Authorization tuple.
+ * @returns The {@link ox#Authorization.Authorization}.
+ */
+export declare function fromTuple<const tuple extends Tuple>(tuple: tuple): fromTuple.ReturnType<tuple>;
+export declare namespace fromTuple {
+    var parseError: (error: unknown) => fromTuple.ErrorType;
+}
+export declare namespace fromTuple {
+    type ReturnType<authorization extends Tuple = Tuple> = Compute<Authorization<authorization extends Tuple<true> ? true : false>>;
+    type ErrorType = Errors.GlobalErrorType;
+}
+/**
+ * Converts an {@link ox#Authorization.TupleList} to an {@link ox#Authorization.List}.
+ *
+ * @example
+ * ```ts twoslash
+ * import { Authorization } from 'ox'
+ *
+ * const authorizationList = Authorization.fromTupleList([
+ *   ['0x1', '0xbe95c3f554e9fc85ec51be69a3d807a0d55bcf2c', '0x3'],
+ *   ['0x3', '0xbe95c3f554e9fc85ec51be69a3d807a0d55bcf2c', '0x14'],
+ * ])
+ * // @log: [
+ * // @log:   {
+ * // @log:     address: '0xbe95c3f554e9fc85ec51be69a3d807a0d55bcf2c',
+ * // @log:     chainId: 1,
+ * // @log:     nonce: 3n,
+ * // @log:   },
+ * // @log:   {
+ * // @log:     address: '0xbe95c3f554e9fc85ec51be69a3d807a0d55bcf2c',
+ * // @log:     chainId: 3,
+ * // @log:     nonce: 20n,
+ * // @log:   },
+ * // @log: ]
+ * ```
+ *
+ * @example
+ * It is also possible to append a Signature tuple to the end of an Authorization tuple.
+ *
+ * ```ts twoslash
+ * import { Authorization } from 'ox'
+ *
+ * const authorizationList = Authorization.fromTupleList([
+ *   ['0x1', '0xbe95c3f554e9fc85ec51be69a3d807a0d55bcf2c', '0x3', '0x1', '0x68a020a209d3d56c46f38cc50a33f704f4a9a10a59377f8dd762ac66910e9b90', '0x7e865ad05c4035ab5792787d4a0297a43617ae897930a6fe4d822b8faea52064'],
+ *   ['0x3', '0xbe95c3f554e9fc85ec51be69a3d807a0d55bcf2c', '0x14', '0x1', '0x68a020a209d3d56c46f38cc50a33f704f4a9a10a59377f8dd762ac66910e9b90', '0x7e865ad05c4035ab5792787d4a0297a43617ae897930a6fe4d822b8faea52064'],
+ * ])
+ * // @log: [
+ * // @log:   {
+ * // @log:     address: '0xbe95c3f554e9fc85ec51be69a3d807a0d55bcf2c',
+ * // @log:     chainId: 1,
+ * // @log:     nonce: 3n,
+ * // @log:     r: BigInt('0x68a020a209d3d56c46f38cc50a33f704f4a9a10a59377f8dd762ac66910e9b90'),
+ * // @log:     s: BigInt('0x7e865ad05c4035ab5792787d4a0297a43617ae897930a6fe4d822b8faea52064'),
+ * // @log:     yParity: 0,
+ * // @log:   },
+ * // @log:   {
+ * // @log:     address: '0xbe95c3f554e9fc85ec51be69a3d807a0d55bcf2c',
+ * // @log:     chainId: 3,
+ * // @log:     nonce: 20n,
+ * // @log:     r: BigInt('0x68a020a209d3d56c46f38cc50a33f704f4a9a10a59377f8dd762ac66910e9b90'),
+ * // @log:     s: BigInt('0x7e865ad05c4035ab5792787d4a0297a43617ae897930a6fe4d822b8faea52064'),
+ * // @log:     yParity: 0,
+ * // @log:   },
+ * // @log: ]
+ * ```
+ *
+ * @param tupleList - The [EIP-7702](https://eips.ethereum.org/EIPS/eip-7702) Authorization tuple list.
+ * @returns An {@link ox#Authorization.List}.
+ */
+export declare function fromTupleList<const tupleList extends TupleList>(tupleList: tupleList): fromTupleList.ReturnType<tupleList>;
+export declare namespace fromTupleList {
+    var parseError: (error: unknown) => fromTupleList.ErrorType;
+}
+export declare namespace fromTupleList {
+    type ReturnType<tupleList extends TupleList> = Compute<TupleList<tupleList extends TupleList<true> ? true : false>>;
+    type ErrorType = Errors.GlobalErrorType;
+}
+/**
+ * Computes the sign payload for an {@link ox#Authorization.Authorization} in [EIP-7702 format](https://eips.ethereum.org/EIPS/eip-7702): `keccak256('0x05' || rlp([chain_id, address, nonce]))`.
+ *
+ * @example
+ * The example below demonstrates computing the sign payload for an {@link ox#Authorization.Authorization}. This payload
+ * can then be passed to signing functions like {@link ox#Secp256k1.(sign:function)}.
+ *
+ * ```ts twoslash
+ * import { Authorization, Secp256k1 } from 'ox'
+ *
+ * const authorization = Authorization.from({
+ *   address: '0x1234567890abcdef1234567890abcdef12345678',
+ *   chainId: 1,
+ *   nonce: 69n,
+ * })
+ *
+ * const payload = Authorization.getSignPayload(authorization) // [!code focus]
+ *
+ * const signature = Secp256k1.sign({
+ *   payload,
+ *   privateKey: '0x...',
+ * })
+ * ```
+ *
+ * @param authorization - The {@link ox#Authorization.Authorization}.
+ * @returns The sign payload.
+ */
+export declare function getSignPayload(authorization: Authorization): Hex.Hex;
+export declare namespace getSignPayload {
+    var parseError: (error: unknown) => getSignPayload.ErrorType;
+}
+export declare namespace getSignPayload {
+    type ErrorType = hash.ErrorType | Errors.GlobalErrorType;
+}
+/**
+ * Computes the hash for an {@link ox#Authorization.Authorization} in [EIP-7702 format](https://eips.ethereum.org/EIPS/eip-7702): `keccak256('0x05' || rlp([chain_id, address, nonce]))`.
+ *
+ * @example
+ * ```ts twoslash
+ * import { Authorization } from 'ox'
+ *
+ * const authorization = Authorization.from({
+ *   address: '0x1234567890abcdef1234567890abcdef12345678',
+ *   chainId: 1,
+ *   nonce: 69n,
+ * })
+ *
+ * const hash = Authorization.hash(authorization) // [!code focus]
+ * ```
+ *
+ * @param authorization - The {@link ox#Authorization.Authorization}.
+ * @returns The hash.
+ */
+export declare function hash(authorization: Authorization): Hex.Hex;
+export declare namespace hash {
+    var parseError: (error: unknown) => hash.ErrorType;
+}
+export declare namespace hash {
+    type ErrorType = toTuple.ErrorType | Hash.keccak256.ErrorType | Hex.concat.ErrorType | Rlp.fromHex.ErrorType | Errors.GlobalErrorType;
+}
+/**
+ * Converts an {@link ox#Authorization.Authorization} to an {@link ox#Authorization.Rpc}.
+ *
+ * @example
+ * ```ts twoslash
+ * import { Authorization } from 'ox'
+ *
+ * const authorization = Authorization.toRpc({
+ *   address: '0x0000000000000000000000000000000000000000',
+ *   chainId: 1,
+ *   nonce: 1n,
+ *   r: 44944627813007772897391531230081695102703289123332187696115181104739239197517n,
+ *   s: 36528503505192438307355164441104001310566505351980369085208178712678799181120n,
+ *   yParity: 0,
+ * })
+ * ```
+ *
+ * @param authorization - An Authorization.
+ * @returns An RPC-formatted Authorization.
+ */
+export declare function toRpc(authorization: Signed): Rpc;
+export declare namespace toRpc {
+    var parseError: (error: unknown) => toRpc.ErrorType;
+}
+export declare namespace toRpc {
+    type ErrorType = Errors.GlobalErrorType;
+}
+/**
+ * Converts an {@link ox#Authorization.List} to an {@link ox#Authorization.ListRpc}.
+ *
+ * @example
+ * ```ts twoslash
+ * import { Authorization } from 'ox'
+ *
+ * const authorization = Authorization.toRpcList([{
+ *   address: '0x0000000000000000000000000000000000000000',
+ *   chainId: 1,
+ *   nonce: 1n,
+ *   r: 44944627813007772897391531230081695102703289123332187696115181104739239197517n,
+ *   s: 36528503505192438307355164441104001310566505351980369085208178712678799181120n,
+ *   yParity: 0,
+ * }])
+ * ```
+ *
+ * @param authorizationList - An Authorization List.
+ * @returns An RPC-formatted Authorization List.
+ */
+export declare function toRpcList(authorizationList: ListSigned): ListRpc;
+export declare namespace toRpcList {
+    var parseError: (error: unknown) => toRpcList.ErrorType;
+}
+export declare namespace toRpcList {
+    type ErrorType = Errors.GlobalErrorType;
+}
+/**
+ * Converts an {@link ox#Authorization.Authorization} to an {@link ox#Authorization.Tuple}.
+ *
+ * @example
+ * ```ts twoslash
+ * import { Authorization } from 'ox'
+ *
+ * const authorization = Authorization.from({
+ *   address: '0x1234567890abcdef1234567890abcdef12345678',
+ *   chainId: 1,
+ *   nonce: 69n,
+ * })
+ *
+ * const tuple = Authorization.toTuple(authorization) // [!code focus]
+ * // @log: [
+ * // @log:   address: '0x1234567890abcdef1234567890abcdef12345678',
+ * // @log:   chainId: 1,
+ * // @log:   nonce: 69n,
+ * // @log: ]
+ * ```
+ *
+ * @param authorization - The {@link ox#Authorization.Authorization}.
+ * @returns An [EIP-7702](https://eips.ethereum.org/EIPS/eip-7702) Authorization tuple.
+ */
+export declare function toTuple<const authorization extends Authorization>(authorization: authorization): toTuple.ReturnType<authorization>;
+export declare namespace toTuple {
+    var parseError: (error: unknown) => toTuple.ErrorType;
+}
+export declare namespace toTuple {
+    type ReturnType<authorization extends Authorization = Authorization> = Compute<Tuple<authorization extends Signature.Signature ? true : false>>;
+    type ErrorType = Errors.GlobalErrorType;
+}
+/**
+ * Converts an {@link ox#Authorization.List} to an {@link ox#Authorization.TupleList}.
+ *
+ * @example
+ * ```ts twoslash
+ * import { Authorization } from 'ox'
+ *
+ * const authorization_1 = Authorization.from({
+ *   address: '0x1234567890abcdef1234567890abcdef12345678',
+ *   chainId: 1,
+ *   nonce: 69n,
+ * })
+ * const authorization_2 = Authorization.from({
+ *   address: '0x1234567890abcdef1234567890abcdef12345678',
+ *   chainId: 3,
+ *   nonce: 20n,
+ * })
+ *
+ * const tuple = Authorization.toTupleList([authorization_1, authorization_2]) // [!code focus]
+ * // @log: [
+ * // @log:   [
+ * // @log:     address: '0x1234567890abcdef1234567890abcdef12345678',
+ * // @log:     chainId: 1,
+ * // @log:     nonce: 69n,
+ * // @log:   ],
+ * // @log:   [
+ * // @log:     address: '0x1234567890abcdef1234567890abcdef12345678',
+ * // @log:     chainId: 3,
+ * // @log:     nonce: 20n,
+ * // @log:   ],
+ * // @log: ]
+ * ```
+ *
+ * @param list - An {@link ox#Authorization.List}.
+ * @returns An [EIP-7702](https://eips.ethereum.org/EIPS/eip-7702) Authorization tuple list.
+ */
+export declare function toTupleList<const list extends readonly Authorization<true>[] | readonly Authorization<false>[]>(list?: list | undefined): toTupleList.ReturnType<list>;
+export declare namespace toTupleList {
+    var parseError: (error: unknown) => toTupleList.ErrorType;
+}
+export declare namespace toTupleList {
+    type ReturnType<list extends readonly Authorization<true>[] | readonly Authorization<false>[]> = Compute<TupleList<list extends readonly Authorization<true>[] ? true : false>>;
+    type ErrorType = Errors.GlobalErrorType;
+}
+//# sourceMappingURL=Authorization.d.ts.map

package/_types/Authorization.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Authorization.d.ts","sourceRoot":"","sources":["../Authorization.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,OAAO,MAAM,cAAc,CAAA;AAC5C,OAAO,KAAK,KAAK,MAAM,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AACjC,OAAO,KAAK,GAAG,MAAM,UAAU,CAAA;AAC/B,OAAO,KAAK,GAAG,MAAM,UAAU,CAAA;AAC/B,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAC3C,OAAO,KAAK,EAAE,OAAO,EAAW,SAAS,EAAE,MAAM,qBAAqB,CAAA;AAEtE,+CAA+C;AAC/C,MAAM,MAAM,aAAa,CACvB,MAAM,SAAS,OAAO,GAAG,OAAO,EAChC,UAAU,GAAG,MAAM,EACnB,UAAU,GAAG,MAAM,IACjB,OAAO,CACT;IACE,gEAAgE;IAChE,OAAO,EAAE,OAAO,CAAC,OAAO,CAAA;IACxB,6BAA6B;IAC7B,OAAO,EAAE,UAAU,CAAA;IACnB,2CAA2C;IAC3C,KAAK,EAAE,UAAU,CAAA;CAClB,GAAG,CAAC,MAAM,SAAS,IAAI,GACpB,SAAS,CAAC,SAAS,CAAC,IAAI,EAAE,UAAU,EAAE,UAAU,CAAC,GACjD,SAAS,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CACpC,CAAA;AAED,uEAAuE;AACvE,MAAM,MAAM,GAAG,GAAG,aAAa,CAAC,IAAI,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,CAAA;AAEvD,sDAAsD;AACtD,MAAM,MAAM,IAAI,CACd,MAAM,SAAS,OAAO,GAAG,OAAO,EAChC,UAAU,GAAG,MAAM,EACnB,UAAU,GAAG,MAAM,IACjB,OAAO,CAAC,SAAS,aAAa,CAAC,MAAM,EAAE,UAAU,EAAE,UAAU,CAAC,EAAE,CAAC,CAAA;AAErE,8DAA8D;AAC9D,MAAM,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,CAAA;AAElD,iFAAiF;AACjF,MAAM,MAAM,UAAU,CAAC,UAAU,GAAG,MAAM,EAAE,UAAU,GAAG,MAAM,IAAI,IAAI,CACrE,IAAI,EACJ,UAAU,EACV,UAAU,CACX,CAAA;AAED,0EAA0E;AAC1E,MAAM,MAAM,MAAM,CAAC,UAAU,GAAG,MAAM,EAAE,UAAU,GAAG,MAAM,IAAI,aAAa,CAC1E,IAAI,EACJ,UAAU,EACV,UAAU,CACX,CAAA;AAED,yEAAyE;AACzE,MAAM,MAAM,KAAK,CAAC,MAAM,SAAS,OAAO,GAAG,OAAO,IAAI,MAAM,SAAS,IAAI,GACrE,SAAS;IACP,OAAO,EAAE,GAAG,CAAC,GAAG;IAChB,OAAO,EAAE,GAAG,CAAC,GAAG;IAChB,KAAK,EAAE,GAAG,CAAC,GAAG;IACd,OAAO,EAAE,GAAG,CAAC,GAAG;IAChB,CAAC,EAAE,GAAG,CAAC,GAAG;IACV,CAAC,EAAE,GAAG,CAAC,GAAG;CACX,GACD,SAAS,CAAC,OAAO,EAAE,GAAG,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC,CAAA;AAEjE,+EAA+E;AAC/E,MAAM,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,CAAA;AAErC,gFAAgF;AAChF,MAAM,MAAM,SAAS,CAAC,MAAM,SAAS,OAAO,GAAG,OAAO,IACpD,SAAS,KAAK,CAAC,MAAM,CAAC,EAAE,CAAA;AAE1B,uFAAuF;AACvF,MAAM,MAAM,eAAe,GAAG,SAAS,CAAC,IAAI,CAAC,CAAA;AAE7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,wBAAgB,IAAI,CAClB,KAAK,CAAC,aAAa,SAAS,aAAa,GAAG,GAAG,EAC/C,KAAK,CAAC,SAAS,SAAS,SAAS,CAAC,SAAS,GAAG,SAAS,GAAG,SAAS,EAEnE,aAAa,EAAE,aAAa,GAAG,aAAa,EAC5C,OAAO,GAAE,IAAI,CAAC,OAAO,CAAC,SAAS,CAAM,GACpC,IAAI,CAAC,UAAU,CAAC,aAAa,EAAE,SAAS,CAAC,CAI3C;yBAVe,IAAI;4BAqCM,OAAO,KAEtB,IAAI,CAAC,SAAS;;AA3BzB,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,KAAK,OAAO,CACV,SAAS,SAAS,SAAS,CAAC,SAAS,GAAG,SAAS,GAC7C,SAAS,CAAC,SAAS,GACnB,SAAS,IACX;QACF,yEAAyE;QACzE,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC,SAAS,GAAG,SAAS,CAAA;KACxD,CAAA;IAED,KAAK,UAAU,CACb,aAAa,SAAS,aAAa,GAAG,GAAG,GAAG,aAAa,EACzD,SAAS,SAAS,SAAS,CAAC,SAAS,GAAG,SAAS,GAC7C,SAAS,CAAC,SAAS,GACnB,SAAS,IACX,OAAO,CACT,aAAa,SAAS,GAAG,GACrB,MAAM,GACN,aAAa,GACX,CAAC,SAAS,SAAS,SAAS,CAAC,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,CACzE,CAAA;IAED,KAAK,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACxC;AAMD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,OAAO,CAAC,aAAa,EAAE,GAAG,GAAG,MAAM,CAUlD;yBAVe,OAAO;4BAgBM,OAAO,KAEzB,OAAO,CAAC,SAAS;;AAN5B,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,KAAK,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACxC;AAMD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,WAAW,CAAC,iBAAiB,EAAE,OAAO,GAAG,UAAU,CAElE;yBAFe,WAAW;4BAQM,OAAO,KAE7B,WAAW,CAAC,SAAS;;AANhC,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,KAAK,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACxC;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,wBAAgB,SAAS,CAAC,KAAK,CAAC,KAAK,SAAS,KAAK,EACjD,KAAK,EAAE,KAAK,GACX,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC,CAU7B;yBAZe,SAAS;4BAsBM,OAAO,KAE3B,SAAS,CAAC,SAAS;;AAV9B,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,KAAK,UAAU,CAAC,aAAa,SAAS,KAAK,GAAG,KAAK,IAAI,OAAO,CAC5D,aAAa,CAAC,aAAa,SAAS,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC,CAChE,CAAA;IAED,KAAK,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACxC;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyDG;AACH,wBAAgB,aAAa,CAAC,KAAK,CAAC,SAAS,SAAS,SAAS,EAC7D,SAAS,EAAE,SAAS,GACnB,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC,CAIrC;yBANe,aAAa;4BAgBM,OAAO,KAE/B,aAAa,CAAC,SAAS;;AAVlC,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,KAAK,UAAU,CAAC,SAAS,SAAS,SAAS,IAAI,OAAO,CACpD,SAAS,CAAC,SAAS,SAAS,SAAS,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC,CAC5D,CAAA;IAED,KAAK,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACxC;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,cAAc,CAAC,aAAa,EAAE,aAAa,GAAG,GAAG,CAAC,GAAG,CAEpE;yBAFe,cAAc;4BAQM,OAAO,KAEhC,cAAc,CAAC,SAAS;;AANnC,MAAM,CAAC,OAAO,WAAW,cAAc,CAAC;IACtC,KAAK,SAAS,GAAG,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACzD;AAMD;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,IAAI,CAAC,aAAa,EAAE,aAAa,GAAG,GAAG,CAAC,GAAG,CAE1D;yBAFe,IAAI;4BAaM,OAAO,KAEtB,IAAI,CAAC,SAAS;;AAXzB,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,KAAK,SAAS,GACV,OAAO,CAAC,SAAS,GACjB,IAAI,CAAC,SAAS,CAAC,SAAS,GACxB,GAAG,CAAC,MAAM,CAAC,SAAS,GACpB,GAAG,CAAC,OAAO,CAAC,SAAS,GACrB,MAAM,CAAC,eAAe,CAAA;CAC3B;AAMD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,KAAK,CAAC,aAAa,EAAE,MAAM,GAAG,GAAG,CAShD;yBATe,KAAK;4BAeM,OAAO,KAEvB,KAAK,CAAC,SAAS;;AAN1B,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,KAAK,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACxC;AAMD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,SAAS,CAAC,iBAAiB,EAAE,UAAU,GAAG,OAAO,CAEhE;yBAFe,SAAS;4BAQM,OAAO,KAE3B,SAAS,CAAC,SAAS;;AAN9B,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,KAAK,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACxC;AAMD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,OAAO,CAAC,KAAK,CAAC,aAAa,SAAS,aAAa,EAC/D,aAAa,EAAE,aAAa,GAC3B,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CASnC;yBAXe,OAAO;4BAoBM,OAAO,KAEzB,OAAO,CAAC,SAAS;;AAT5B,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,KAAK,UAAU,CAAC,aAAa,SAAS,aAAa,GAAG,aAAa,IACjE,OAAO,CAAC,KAAK,CAAC,aAAa,SAAS,SAAS,CAAC,SAAS,GAAG,IAAI,GAAG,KAAK,CAAC,CAAC,CAAA;IAE1E,KAAK,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACxC;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAgB,WAAW,CACzB,KAAK,CAAC,IAAI,SACN,SAAS,aAAa,CAAC,IAAI,CAAC,EAAE,GAC9B,SAAS,aAAa,CAAC,KAAK,CAAC,EAAE,EACnC,IAAI,CAAC,EAAE,IAAI,GAAG,SAAS,GAAG,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,CAOvD;yBAXe,WAAW;4BAyBM,OAAO,KAE7B,WAAW,CAAC,SAAS;;AAdhC,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,KAAK,UAAU,CACb,IAAI,SACA,SAAS,aAAa,CAAC,IAAI,CAAC,EAAE,GAC9B,SAAS,aAAa,CAAC,KAAK,CAAC,EAAE,IACjC,OAAO,CACT,SAAS,CAAC,IAAI,SAAS,SAAS,aAAa,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,GAAG,KAAK,CAAC,CACtE,CAAA;IAED,KAAK,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACxC"}

package/_types/Base58.d.ts

@@ -0,0 +1,131 @@
+import * as Bytes from './Bytes.js';
+import type * as Errors from './Errors.js';
+import * as Hex from './Hex.js';
+import * as internal from './internal/base58.js';
+/**
+ * Encodes a {@link ox#Bytes.Bytes} to a Base58-encoded string.
+ *
+ * @example
+ * ```ts twoslash
+ * import { Base58, Bytes } from 'ox'
+ *
+ * const value = Base58.fromBytes(Bytes.fromString('Hello World!'))
+ * // @log: '2NEpo7TZRRrLZSi2U'
+ * ```
+ *
+ * @param value - The byte array to encode.
+ * @returns The Base58 encoded string.
+ */
+export declare function fromBytes(value: Bytes.Bytes): string;
+export declare namespace fromBytes {
+    var parseError: (error: unknown) => fromBytes.ErrorType;
+}
+export declare namespace fromBytes {
+    type ErrorType = internal.from.ErrorType | Errors.GlobalErrorType;
+}
+/**
+ * Encodes a {@link ox#Hex.Hex} to a Base58-encoded string.
+ *
+ * @example
+ * ```ts twoslash
+ * import { Base58, Hex } from 'ox'
+ *
+ * const value = Base58.fromHex(Hex.fromString('Hello World!'))
+ * // @log: '2NEpo7TZRRrLZSi2U'
+ * ```
+ *
+ * @param value - The byte array to encode.
+ * @returns The Base58 encoded string.
+ */
+export declare function fromHex(value: Hex.Hex): string;
+export declare namespace fromHex {
+    var parseError: (error: unknown) => fromHex.ErrorType;
+}
+export declare namespace fromHex {
+    type ErrorType = internal.from.ErrorType | Errors.GlobalErrorType;
+}
+/**
+ * Encodes a string to a Base58-encoded string.
+ *
+ * @example
+ * ```ts twoslash
+ * import { Base58 } from 'ox'
+ *
+ * const value = Base58.fromString('Hello World!')
+ * // @log: '2NEpo7TZRRrLZSi2U'
+ * ```
+ *
+ * @param value - The string to encode.
+ * @returns The Base58 encoded string.
+ */
+export declare function fromString(value: string): string;
+export declare namespace fromString {
+    var parseError: (error: unknown) => fromString.ErrorType;
+}
+export declare namespace fromString {
+    type ErrorType = internal.from.ErrorType | Errors.GlobalErrorType;
+}
+/**
+ * Decodes a Base58-encoded string to a {@link ox#Bytes.Bytes}.
+ *
+ * @example
+ * ```ts twoslash
+ * import { Base58 } from 'ox'
+ *
+ * const value = Base58.toBytes('2NEpo7TZRRrLZSi2U')
+ * // @log: Uint8Array [ 72, 101, 108, 108, 111, 32, 87, 111, 114, 108, 100, 33 ]
+ * ```
+ *
+ * @param value - The Base58 encoded string.
+ * @returns The decoded byte array.
+ */
+export declare function toBytes(value: string): Bytes.Bytes;
+export declare namespace toBytes {
+    var parseError: (error: unknown) => toBytes.ErrorType;
+}
+export declare namespace toBytes {
+    type ErrorType = Errors.GlobalErrorType;
+}
+/**
+ * Decodes a Base58-encoded string to {@link ox#Hex.Hex}.
+ *
+ * @example
+ * ```ts twoslash
+ * import { Base58 } from 'ox'
+ *
+ * const value = Base58.toHex('2NEpo7TZRRrLZSi2U')
+ * // @log: '0x48656c6c6f20576f726c6421'
+ * ```
+ *
+ * @param value - The Base58 encoded string.
+ * @returns The decoded hex string.
+ */
+export declare function toHex(value: string): Hex.Hex;
+export declare namespace toHex {
+    var parseError: (error: unknown) => toHex.ErrorType;
+}
+export declare namespace toHex {
+    type ErrorType = Errors.GlobalErrorType;
+}
+/**
+ * Decodes a Base58-encoded string to a string.
+ *
+ * @example
+ * ```ts twoslash
+ * import { Base58 } from 'ox'
+ *
+ * const value = Base58.toString('2NEpo7TZRRrLZSi2U')
+ * // @log: 'Hello World!'
+ * ```
+ *
+ * @param value - The Base58 encoded string.
+ * @returns The decoded string.
+ */
+export declare function toString(value: string): string;
+export declare namespace toString {
+    var parseError: (error: unknown) => toString.ErrorType;
+}
+export declare namespace toString {
+    type ErrorType = Errors.GlobalErrorType;
+}
+//# sourceMappingURL=Base58.d.ts.map

package/_types/Base58.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Base58.d.ts","sourceRoot":"","sources":["../Base58.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AACnC,OAAO,KAAK,KAAK,MAAM,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,GAAG,MAAM,UAAU,CAAA;AAC/B,OAAO,KAAK,QAAQ,MAAM,sBAAsB,CAAA;AAEhD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,UAE3C;yBAFe,SAAS;4BAQM,OAAO,KAE3B,SAAS,CAAC,SAAS;;AAN9B,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,KAAK,SAAS,GAAG,QAAQ,CAAC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CAClE;AAMD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,UAErC;yBAFe,OAAO;4BAQM,OAAO,KAEzB,OAAO,CAAC,SAAS;;AAN5B,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,KAAK,SAAS,GAAG,QAAQ,CAAC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CAClE;AAMD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,UAEvC;yBAFe,UAAU;4BAQM,OAAO,KAE5B,UAAU,CAAC,SAAS;;AAN/B,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,KAAK,SAAS,GAAG,QAAQ,CAAC,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CAClE;AAMD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC,KAAK,CAElD;yBAFe,OAAO;4BAQM,OAAO,KAEzB,OAAO,CAAC,SAAS;;AAN5B,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,KAAK,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACxC;AAMD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,GAAG,CAAC,GAAG,CAsB5C;yBAtBe,KAAK;4BA4BM,OAAO,KAEvB,KAAK,CAAC,SAAS;;AAN1B,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,KAAK,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACxC;AAMD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE9C;yBAFe,QAAQ;4BAQM,OAAO,KAE1B,QAAQ,CAAC,SAAS;;AAN7B,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,KAAK,SAAS,GAAG,MAAM,CAAC,eAAe,CAAA;CACxC"}