@xylabs/eth-address 7.0.7 → 8.0.0

package/README.md

@@ -1,347 +1,3 @@
-[![logo][]](https://xylabs.com)
-
 # @xylabs/eth-address
 
-[![npm][npm-badge]][npm-link]
-[![license][license-badge]][license-link]
-
-> Base functionality used throughout XY Labs TypeScript/JavaScript libraries
-
-## Install
-
-Using npm:
-
-```sh
-npm install {{name}}
-```
-
-Using yarn:
-
-```sh
-yarn add {{name}}
-```
-
-Using pnpm:
-
-```sh
-pnpm add {{name}}
-```
-
-Using bun:
-
-```sh
-bun add {{name}}
-```
-
-
-## License
-
-See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
-
-## Reference
-
-### packages
-
-  ### eth-address
-
-    ### .temp-typedoc
-
-      ### classes
-
-        ### <a id="EthAddressWrapper"></a>EthAddressWrapper
-
-[**@xylabs/eth-address**](#../README)
-
-***
-
-Wrapper around an Ethereum address providing parsing, formatting, validation, and checksum support.
-
-## Constructors
-
-### Constructor
-
-```ts
-protected new EthAddressWrapper(address): EthAddressWrapper;
-```
-
-### Parameters
-
-#### address
-
-`bigint`
-
-### Returns
-
-`EthAddressWrapper`
-
-## Methods
-
-### fromString()
-
-```ts
-static fromString(value?, base?): EthAddressWrapper | undefined;
-```
-
-### Parameters
-
-#### value?
-
-`string`
-
-#### base?
-
-`number` = `16`
-
-### Returns
-
-`EthAddressWrapper` \| `undefined`
-
-***
-
-### parse()
-
-```ts
-static parse(value, base?): EthAddressWrapper | undefined;
-```
-
-### Parameters
-
-#### value
-
-`unknown`
-
-#### base?
-
-`number`
-
-### Returns
-
-`EthAddressWrapper` \| `undefined`
-
-***
-
-### validate()
-
-```ts
-static validate(address): boolean;
-```
-
-### Parameters
-
-#### address
-
-`string`
-
-### Returns
-
-`boolean`
-
-***
-
-### equals()
-
-```ts
-equals(address?): boolean;
-```
-
-### Parameters
-
-#### address?
-
-`string` \| `EthAddressWrapper` \| `null`
-
-### Returns
-
-`boolean`
-
-***
-
-### toBigNumber()
-
-```ts
-toBigNumber(): bigint;
-```
-
-### Returns
-
-`bigint`
-
-***
-
-### toHex()
-
-```ts
-toHex(): string;
-```
-
-### Returns
-
-`string`
-
-***
-
-### toJSON()
-
-```ts
-toJSON(): string;
-```
-
-### Returns
-
-`string`
-
-***
-
-### toLowerCaseString()
-
-```ts
-toLowerCaseString(): string;
-```
-
-### Returns
-
-`string`
-
-***
-
-### toShortString()
-
-```ts
-toShortString(length?): string;
-```
-
-### Parameters
-
-#### length?
-
-`number` = `2`
-
-### Returns
-
-`string`
-
-***
-
-### toString()
-
-```ts
-toString(checksum?, chainId?): string;
-```
-
-### Parameters
-
-#### checksum?
-
-`boolean`
-
-#### chainId?
-
-`string`
-
-### Returns
-
-`string`
-
-***
-
-### validate()
-
-```ts
-validate(): boolean;
-```
-
-### Returns
-
-`boolean`
-
-      ### functions
-
-        ### <a id="ellipsize"></a>ellipsize
-
-[**@xylabs/eth-address**](#../README)
-
-***
-
-```ts
-function ellipsize(value, length?): string;
-```
-
-Truncates a string to show the first and last `length` characters separated by an ellipsis.
-
-## Parameters
-
-### value
-
-`string`
-
-The string to ellipsize
-
-### length?
-
-`number` = `2`
-
-Number of characters to keep at each end (default 2)
-
-## Returns
-
-`string`
-
-The ellipsized string
-
-        ### <a id="isEthAddressWrapper"></a>isEthAddressWrapper
-
-[**@xylabs/eth-address**](#../README)
-
-***
-
-```ts
-function isEthAddressWrapper(obj): obj is { type: string } & EthAddressWrapper;
-```
-
-Type guard that checks if the given object is an instance of EthAddressWrapper.
-
-## Parameters
-
-### obj
-
-### type
-
-`string`
-
-## Returns
-
-`obj is { type: string } & EthAddressWrapper`
-
-        ### <a id="padHex"></a>padHex
-
-[**@xylabs/eth-address**](#../README)
-
-***
-
-```ts
-function padHex(hex, byteCount?): string;
-```
-
-## Parameters
-
-### hex
-
-`string`
-
-### byteCount?
-
-`number` = `0`
-
-## Returns
-
-`string`
-
-## Credits
-
-[Made with 🔥 and ❄️ by XY Labs](https://xylabs.com)
-
-[npm-badge]: https://img.shields.io/npm/v/@xylabs/eth-address.svg
-[npm-link]: https://www.npmjs.com/package/@xylabs/eth-address
-[license-badge]: https://img.shields.io/npm/l/@xylabs/eth-address.svg
-[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE
-[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
+DEPRECATED — use `@ariestools/eth-address` instead.

package/dist/neutral/index.d.ts

@@ -1,4 +1,2 @@
-export * from './ellipsize.ts';
-export * from './EthAddress.ts';
-export * from './padHex.ts';
+export * from '@ariestools/eth-address';
 //# sourceMappingURL=index.d.ts.map

package/dist/neutral/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA;AAC9B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,aAAa,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAA"}

package/dist/neutral/index.mjs

@@ -1,81 +1,3 @@
-// src/ellipsize.ts
-import {
-  ellipsize
-} from "@xylabs/sdk/ellipsize";
-
-// src/EthAddress.ts
-import { assertEx } from "@xylabs/sdk/assert";
-import { ellipsize as ellipsize2 } from "@xylabs/sdk/ellipsize";
-import { getAddress } from "ethers";
-
-// src/padHex.ts
-var padHex = (hex, byteCount = 0) => {
-  let result = hex.length % 2 === 0 ? hex : `0${hex}`;
-  while (result.length / 2 < byteCount) {
-    result = `00${result}`;
-  }
-  return result;
-};
-
-// src/EthAddress.ts
-var isEthAddressWrapper = (obj) => obj instanceof EthAddressWrapper;
-var EthAddressWrapper = class _EthAddressWrapper {
-  address;
-  constructor(address) {
-    this.address = address;
-  }
-  static fromString(value, base = 16) {
-    if (value === void 0) {
-      return;
-    }
-    const bi = base === 16 ? BigInt(value.startsWith("0x") ? value : `0x${value}`) : BigInt(value);
-    return new _EthAddressWrapper(bi);
-  }
-  static parse(value, base) {
-    if (typeof value === "string") {
-      return this.fromString(value, base);
-    }
-  }
-  static validate(address) {
-    return /^(0x)?[\da-f]{40}$/i.test(address);
-  }
-  equals(address) {
-    if (address !== null && address !== void 0) {
-      const inAddress = typeof address === "string" ? assertEx(_EthAddressWrapper.fromString(address), () => "Bad Address") : address;
-      return this.address === inAddress.address;
-    }
-    return false;
-  }
-  toBigNumber() {
-    return this.address;
-  }
-  toHex() {
-    return padHex(this.address.toString(16), 20);
-  }
-  toJSON() {
-    return `0x${this.toHex()}`;
-  }
-  toLowerCaseString() {
-    return this.toString().toLowerCase();
-  }
-  toShortString(length = 2) {
-    return `0x${ellipsize2(this.toHex(), length)}`;
-  }
-  toString(checksum, chainId) {
-    if (checksum === true) {
-      const strippedAddress = this.toHex();
-      return getAddress(chainId === void 0 ? `0x${strippedAddress}` : `${chainId}0x${strippedAddress}`);
-    }
-    return `0x${this.toHex()}`;
-  }
-  validate() {
-    return _EthAddressWrapper.validate(this.toString());
-  }
-};
-export {
-  EthAddressWrapper,
-  ellipsize,
-  isEthAddressWrapper,
-  padHex
-};
+// src/index.ts
+export * from "@ariestools/eth-address";
 //# sourceMappingURL=index.mjs.map

package/dist/neutral/index.mjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
-  "sources": ["../../src/ellipsize.ts", "../../src/EthAddress.ts", "../../src/padHex.ts"],
-  "sourcesContent": ["export {\n  /** @deprecated import from @xylabs/sdk-js (or @xylabs/sdk/ellipsize) instead */\n  ellipsize,\n} from '@xylabs/sdk/ellipsize'\n", "import { assertEx } from '@xylabs/sdk/assert'\nimport { ellipsize } from '@xylabs/sdk/ellipsize'\nimport { getAddress } from 'ethers'\n\nimport { padHex } from './padHex.ts'\n\n/** Type guard that checks if the given object is an instance of EthAddressWrapper. */\nexport const isEthAddressWrapper = (obj: { type: string }) => obj instanceof EthAddressWrapper\n\n/** Wrapper around an Ethereum address providing parsing, formatting, validation, and checksum support. */\nexport class EthAddressWrapper {\n  private address: bigint\n\n  protected constructor(address: bigint) {\n    this.address = address\n  }\n\n  static fromString(value?: string, base = 16) {\n    if (value === undefined) {\n      return\n    }\n    const bi = base === 16 ? BigInt(value.startsWith('0x') ? value : `0x${value}`) : BigInt(value)\n    return new EthAddressWrapper(bi)\n  }\n\n  static parse(value: unknown, base?: number) {\n    if (typeof value === 'string') {\n      return this.fromString(value, base)\n    }\n  }\n\n  static validate(address: string) {\n    return /^(0x)?[\\da-f]{40}$/i.test(address)\n  }\n\n  equals(address?: EthAddressWrapper | string | null): boolean {\n    if (address !== null && address !== undefined) {\n      const inAddress = typeof address === 'string' ? assertEx(EthAddressWrapper.fromString(address), () => 'Bad Address') : address\n      return this.address === inAddress.address\n    }\n    return false\n  }\n\n  toBigNumber() {\n    return this.address\n  }\n\n  toHex() {\n    return padHex(this.address.toString(16), 20)\n  }\n\n  toJSON(): string {\n    return `0x${this.toHex()}`\n  }\n\n  toLowerCaseString() {\n    return this.toString().toLowerCase()\n  }\n\n  toShortString(length = 2) {\n    return `0x${ellipsize(this.toHex(), length)}`\n  }\n\n  toString(checksum?: boolean, chainId?: string) {\n    if (checksum === true) {\n      const strippedAddress = this.toHex()\n      return getAddress(chainId === undefined ? `0x${strippedAddress}` : `${chainId}0x${strippedAddress}`)\n    }\n    return `0x${this.toHex()}`\n  }\n\n  validate() {\n    return EthAddressWrapper.validate(this.toString())\n  }\n}\n", "const padHex = (hex: string, byteCount = 0) => {\n  let result = hex.length % 2 === 0 ? hex : `0${hex}`\n\n  while (result.length / 2 < byteCount) {\n    result = `00${result}`\n  }\n\n  return result\n}\n\nexport { padHex }\n"],
-  "mappings": ";AAAA;AAAA,EAEE;AAAA,OACK;;;ACHP,SAAS,gBAAgB;AACzB,SAAS,aAAAA,kBAAiB;AAC1B,SAAS,kBAAkB;;;ACF3B,IAAM,SAAS,CAAC,KAAa,YAAY,MAAM;AAC7C,MAAI,SAAS,IAAI,SAAS,MAAM,IAAI,MAAM,IAAI,GAAG;AAEjD,SAAO,OAAO,SAAS,IAAI,WAAW;AACpC,aAAS,KAAK,MAAM;AAAA,EACtB;AAEA,SAAO;AACT;;;ADDO,IAAM,sBAAsB,CAAC,QAA0B,eAAe;AAGtE,IAAM,oBAAN,MAAM,mBAAkB;AAAA,EACrB;AAAA,EAEE,YAAY,SAAiB;AACrC,SAAK,UAAU;AAAA,EACjB;AAAA,EAEA,OAAO,WAAW,OAAgB,OAAO,IAAI;AAC3C,QAAI,UAAU,QAAW;AACvB;AAAA,IACF;AACA,UAAM,KAAK,SAAS,KAAK,OAAO,MAAM,WAAW,IAAI,IAAI,QAAQ,KAAK,KAAK,EAAE,IAAI,OAAO,KAAK;AAC7F,WAAO,IAAI,mBAAkB,EAAE;AAAA,EACjC;AAAA,EAEA,OAAO,MAAM,OAAgB,MAAe;AAC1C,QAAI,OAAO,UAAU,UAAU;AAC7B,aAAO,KAAK,WAAW,OAAO,IAAI;AAAA,IACpC;AAAA,EACF;AAAA,EAEA,OAAO,SAAS,SAAiB;AAC/B,WAAO,sBAAsB,KAAK,OAAO;AAAA,EAC3C;AAAA,EAEA,OAAO,SAAsD;AAC3D,QAAI,YAAY,QAAQ,YAAY,QAAW;AAC7C,YAAM,YAAY,OAAO,YAAY,WAAW,SAAS,mBAAkB,WAAW,OAAO,GAAG,MAAM,aAAa,IAAI;AACvH,aAAO,KAAK,YAAY,UAAU;AAAA,IACpC;AACA,WAAO;AAAA,EACT;AAAA,EAEA,cAAc;AACZ,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,QAAQ;AACN,WAAO,OAAO,KAAK,QAAQ,SAAS,EAAE,GAAG,EAAE;AAAA,EAC7C;AAAA,EAEA,SAAiB;AACf,WAAO,KAAK,KAAK,MAAM,CAAC;AAAA,EAC1B;AAAA,EAEA,oBAAoB;AAClB,WAAO,KAAK,SAAS,EAAE,YAAY;AAAA,EACrC;AAAA,EAEA,cAAc,SAAS,GAAG;AACxB,WAAO,KAAKC,WAAU,KAAK,MAAM,GAAG,MAAM,CAAC;AAAA,EAC7C;AAAA,EAEA,SAAS,UAAoB,SAAkB;AAC7C,QAAI,aAAa,MAAM;AACrB,YAAM,kBAAkB,KAAK,MAAM;AACnC,aAAO,WAAW,YAAY,SAAY,KAAK,eAAe,KAAK,GAAG,OAAO,KAAK,eAAe,EAAE;AAAA,IACrG;AACA,WAAO,KAAK,KAAK,MAAM,CAAC;AAAA,EAC1B;AAAA,EAEA,WAAW;AACT,WAAO,mBAAkB,SAAS,KAAK,SAAS,CAAC;AAAA,EACnD;AACF;",
-  "names": ["ellipsize", "ellipsize"]
+  "sources": ["../../src/index.ts"],
+  "sourcesContent": ["export * from '@ariestools/eth-address'\n"],
+  "mappings": ";AAAA,cAAc;",
+  "names": []
 }

package/package.json

@@ -1,15 +1,11 @@
 {
   "name": "@xylabs/eth-address",
-  "version": "7.0.7",
-  "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
+  "version": "8.0.0",
+  "description": "DEPRECATED — use @ariestools/eth-address. Backward-compatibility re-export shim.",
   "keywords": [
-    "eth",
-    "ethereum",
-    "address",
     "xylabs",
-    "utility",
-    "typescript",
-    "esm"
+    "deprecated",
+    "shim"
   ],
   "homepage": "https://xylabs.com",
   "bugs": {
@@ -43,7 +39,7 @@
     "README.md"
   ],
   "dependencies": {
-    "@xylabs/sdk": "~7.0.7"
+    "@ariestools/eth-address": "~8.0.0"
   },
   "devDependencies": {
     "@opentelemetry/api": "~1.9.1",
@@ -56,8 +52,6 @@
     "eslint-import-resolver-typescript": "~4.4.5",
     "ethers": "~6.17.0",
     "typescript": "~6.0.3",
-    "vite": "~8.1.3",
-    "vitest": "~4.1.9",
     "zod": "~4.4.3"
   },
   "peerDependencies": {
@@ -72,5 +66,6 @@
   },
   "publishConfig": {
     "access": "public"
-  }
+  },
+  "deprecated": "Use @ariestools/eth-address instead. @xylabs/eth-address is a compatibility shim only and will not receive further updates."
 }

package/dist/neutral/EthAddress.d.ts

@@ -1,23 +0,0 @@
-/** Type guard that checks if the given object is an instance of EthAddressWrapper. */
-export declare const isEthAddressWrapper: (obj: {
-    type: string;
-}) => obj is {
-    type: string;
-} & EthAddressWrapper;
-/** Wrapper around an Ethereum address providing parsing, formatting, validation, and checksum support. */
-export declare class EthAddressWrapper {
-    private address;
-    protected constructor(address: bigint);
-    static fromString(value?: string, base?: number): EthAddressWrapper | undefined;
-    static parse(value: unknown, base?: number): EthAddressWrapper | undefined;
-    static validate(address: string): boolean;
-    equals(address?: EthAddressWrapper | string | null): boolean;
-    toBigNumber(): bigint;
-    toHex(): string;
-    toJSON(): string;
-    toLowerCaseString(): string;
-    toShortString(length?: number): string;
-    toString(checksum?: boolean, chainId?: string): string;
-    validate(): boolean;
-}
-//# sourceMappingURL=EthAddress.d.ts.map

package/dist/neutral/EthAddress.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"EthAddress.d.ts","sourceRoot":"","sources":["../../src/EthAddress.ts"],"names":[],"mappings":"AAMA,sFAAsF;AACtF,eAAO,MAAM,mBAAmB,GAAI,KAAK;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE;UAAR,MAAM;qBAAuC,CAAA;AAE9F,0GAA0G;AAC1G,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,OAAO,CAAQ;IAEvB,SAAS,aAAa,OAAO,EAAE,MAAM;IAIrC,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,IAAI,SAAK;IAQ3C,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,MAAM;IAM1C,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM;IAI/B,MAAM,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO;IAQ5D,WAAW;IAIX,KAAK;IAIL,MAAM,IAAI,MAAM;IAIhB,iBAAiB;IAIjB,aAAa,CAAC,MAAM,SAAI;IAIxB,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,MAAM;IAQ7C,QAAQ;CAGT"}

package/dist/neutral/ellipsize.d.ts

@@ -1,4 +0,0 @@
-export { 
-/** @deprecated import from @xylabs/sdk-js (or @xylabs/sdk/ellipsize) instead */
-ellipsize, } from '@xylabs/sdk/ellipsize';
-//# sourceMappingURL=ellipsize.d.ts.map

package/dist/neutral/ellipsize.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ellipsize.d.ts","sourceRoot":"","sources":["../../src/ellipsize.ts"],"names":[],"mappings":"AAAA,OAAO;AACL,gFAAgF;AAChF,SAAS,GACV,MAAM,uBAAuB,CAAA"}

package/dist/neutral/padHex.d.ts

@@ -1,3 +0,0 @@
-declare const padHex: (hex: string, byteCount?: number) => string;
-export { padHex };
-//# sourceMappingURL=padHex.d.ts.map

package/dist/neutral/padHex.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"padHex.d.ts","sourceRoot":"","sources":["../../src/padHex.ts"],"names":[],"mappings":"AAAA,QAAA,MAAM,MAAM,GAAI,KAAK,MAAM,EAAE,kBAAa,WAQzC,CAAA;AAED,OAAO,EAAE,MAAM,EAAE,CAAA"}