@xylabs/eth-address 4.15.0 → 4.15.1

package/dist/neutral/EthAddress.d.ts

@@ -1,15 +1,21 @@
+export declare const isEthAddressWrapper: (obj: {
+    type: string;
+}) => obj is {
+    type: string;
+} & EthAddressWrapper;
+/** @deprecated use isEthAddressWrapper */
 export declare const isEthAddress: (obj: {
     type: string;
-}) => boolean;
-export declare class EthAddress {
-    static readonly type = "EthAddress";
+}) => obj is {
     type: string;
+} & EthAddressWrapper;
+export declare class EthAddressWrapper {
     private address;
-    private constructor();
-    static fromString(value?: string, base?: number): EthAddress | undefined;
-    static parse(value: unknown, base?: number): EthAddress | undefined;
+    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?: EthAddress | string | null): boolean;
+    equals(address?: EthAddressWrapper | string | null): boolean;
     toBigNumber(): bigint;
     toHex(): string;
     toJSON(): string;
@@ -18,4 +24,7 @@ export declare class EthAddress {
     toString(checksum?: boolean, chainId?: string): string;
     validate(): boolean;
 }
+/** @deprecated use EthAddressWrapper */
+export declare class EthAddress extends EthAddressWrapper {
+}
 //# sourceMappingURL=EthAddress.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"EthAddress.d.ts","sourceRoot":"","sources":["../../src/EthAddress.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,YAAY,GAAI,KAAK;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,YAAkC,CAAA;AAEpF,qBAAa,UAAU;IACrB,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAe;IAEnC,IAAI,SAAkB;IAEtB,OAAO,CAAC,OAAO,CAAQ;IAEvB,OAAO;IAIP,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,IAAI,SAAK;IAO3C,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,UAAU,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO;IAQrD,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"}
+{"version":3,"file":"EthAddress.d.ts","sourceRoot":"","sources":["../../src/EthAddress.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,mBAAmB,GAAI,KAAK;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE;UAAR,MAAM;qBAAuC,CAAA;AAE9F,0CAA0C;AAC1C,eAAO,MAAM,YAAY,QAHgB;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE;UAAR,MAAM;qBAGR,CAAA;AAE/C,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;IAO3C,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;AAED,wCAAwC;AACxC,qBAAa,UAAW,SAAQ,iBAAiB;CAAG"}

package/dist/neutral/index.mjs

@@ -22,10 +22,9 @@ var padHex = (hex, byteCount = 0) => {
 };
 
 // src/EthAddress.ts
-var isEthAddress = (obj) => obj?.type === EthAddress.type;
-var EthAddress = class _EthAddress {
-  static type = "EthAddress";
-  type = _EthAddress.type;
+var isEthAddressWrapper = (obj) => obj instanceof EthAddressWrapper;
+var isEthAddress = isEthAddressWrapper;
+var EthAddressWrapper = class _EthAddressWrapper {
   address;
   constructor(address) {
     this.address = address;
@@ -33,7 +32,7 @@ var EthAddress = class _EthAddress {
   static fromString(value, base = 16) {
     if (value !== void 0) {
       const bi = base === 16 ? BigInt(value.startsWith("0x") ? value : `0x${value}`) : BigInt(value);
-      return new _EthAddress(bi);
+      return new _EthAddressWrapper(bi);
     }
   }
   static parse(value, base) {
@@ -46,7 +45,7 @@ var EthAddress = class _EthAddress {
   }
   equals(address) {
     if (address !== null && address !== void 0) {
-      const inAddress = typeof address === "string" ? assertEx(_EthAddress.fromString(address), () => "Bad Address") : address;
+      const inAddress = typeof address === "string" ? assertEx(_EthAddressWrapper.fromString(address), () => "Bad Address") : address;
       return this.address === inAddress.address;
     }
     return false;
@@ -74,13 +73,17 @@ var EthAddress = class _EthAddress {
     return `0x${this.toHex()}`;
   }
   validate() {
-    return _EthAddress.validate(this.toString());
+    return _EthAddressWrapper.validate(this.toString());
   }
 };
+var EthAddress = class extends EthAddressWrapper {
+};
 export {
   EthAddress,
+  EthAddressWrapper,
   ellipsize,
   isEthAddress,
+  isEthAddressWrapper,
   padHex
 };
 //# sourceMappingURL=index.mjs.map

package/dist/neutral/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/ellipsize.ts","../../src/EthAddress.ts","../../src/padHex.ts"],"sourcesContent":["export const ellipsize = (value: string, length = 2) => {\n  const part1 = value.slice(0, length)\n  const part2 = value.slice(value.length - length)\n  return `${part1}...${part2}`\n}\n","import { assertEx } from '@xylabs/assert'\nimport { getAddress } from 'ethers'\n\nimport { ellipsize } from './ellipsize.ts'\nimport { padHex } from './padHex.ts'\n\nexport const isEthAddress = (obj: { type: string }) => obj?.type === EthAddress.type\n\nexport class EthAddress {\n  static readonly type = 'EthAddress'\n\n  type = EthAddress.type\n\n  private address: bigint\n\n  private constructor(address: bigint) {\n    this.address = address\n  }\n\n  static fromString(value?: string, base = 16) {\n    if (value !== undefined) {\n      const bi = base === 16 ? BigInt(value.startsWith('0x') ? value : `0x${value}`) : BigInt(value)\n      return new EthAddress(bi)\n    }\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?: EthAddress | string | null): boolean {\n    if (address !== null && address !== undefined) {\n      const inAddress = typeof address === 'string' ? assertEx(EthAddress.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) {\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 EthAddress.validate(this.toString())\n  }\n}\n","const padHex = (hex: string, byteCount = 0) => {\n  let result = hex\n  if (hex.length % 2 !== 0) {\n    result = `0${hex}`\n  }\n\n  while (result.length / 2 < byteCount) {\n    result = `00${result}`\n  }\n\n  return result\n}\n\nexport { padHex }\n"],"mappings":";AAAO,IAAM,YAAY,CAAC,OAAe,SAAS,MAAM;AACtD,QAAM,QAAQ,MAAM,MAAM,GAAG,MAAM;AACnC,QAAM,QAAQ,MAAM,MAAM,MAAM,SAAS,MAAM;AAC/C,SAAO,GAAG,KAAK,MAAM,KAAK;AAC5B;;;ACJA,SAAS,gBAAgB;AACzB,SAAS,kBAAkB;;;ACD3B,IAAM,SAAS,CAAC,KAAa,YAAY,MAAM;AAC7C,MAAI,SAAS;AACb,MAAI,IAAI,SAAS,MAAM,GAAG;AACxB,aAAS,IAAI,GAAG;AAAA,EAClB;AAEA,SAAO,OAAO,SAAS,IAAI,WAAW;AACpC,aAAS,KAAK,MAAM;AAAA,EACtB;AAEA,SAAO;AACT;;;ADLO,IAAM,eAAe,CAAC,QAA0B,KAAK,SAAS,WAAW;AAEzE,IAAM,aAAN,MAAM,YAAW;AAAA,EACtB,OAAgB,OAAO;AAAA,EAEvB,OAAO,YAAW;AAAA,EAEV;AAAA,EAEA,YAAY,SAAiB;AACnC,SAAK,UAAU;AAAA,EACjB;AAAA,EAEA,OAAO,WAAW,OAAgB,OAAO,IAAI;AAC3C,QAAI,UAAU,QAAW;AACvB,YAAM,KAAK,SAAS,KAAK,OAAO,MAAM,WAAW,IAAI,IAAI,QAAQ,KAAK,KAAK,EAAE,IAAI,OAAO,KAAK;AAC7F,aAAO,IAAI,YAAW,EAAE;AAAA,IAC1B;AAAA,EACF;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,SAA+C;AACpD,QAAI,YAAY,QAAQ,YAAY,QAAW;AAC7C,YAAM,YAAY,OAAO,YAAY,WAAW,SAAS,YAAW,WAAW,OAAO,GAAG,MAAM,aAAa,IAAI;AAChH,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,KAAK,UAAU,KAAK,MAAM,GAAG,MAAM,CAAC;AAAA,EAC7C;AAAA,EAEA,SAAS,UAAoB,SAAkB;AAC7C,QAAI,UAAU;AACZ,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,YAAW,SAAS,KAAK,SAAS,CAAC;AAAA,EAC5C;AACF;","names":[]}
+{"version":3,"sources":["../../src/ellipsize.ts","../../src/EthAddress.ts","../../src/padHex.ts"],"sourcesContent":["export const ellipsize = (value: string, length = 2) => {\n  const part1 = value.slice(0, length)\n  const part2 = value.slice(value.length - length)\n  return `${part1}...${part2}`\n}\n","import { assertEx } from '@xylabs/assert'\nimport { getAddress } from 'ethers'\n\nimport { ellipsize } from './ellipsize.ts'\nimport { padHex } from './padHex.ts'\n\nexport const isEthAddressWrapper = (obj: { type: string }) => obj instanceof EthAddressWrapper\n\n/** @deprecated use isEthAddressWrapper */\nexport const isEthAddress = isEthAddressWrapper\n\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      const bi = base === 16 ? BigInt(value.startsWith('0x') ? value : `0x${value}`) : BigInt(value)\n      return new EthAddressWrapper(bi)\n    }\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) {\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\n/** @deprecated use EthAddressWrapper */\nexport class EthAddress extends EthAddressWrapper {}\n","const padHex = (hex: string, byteCount = 0) => {\n  let result = hex\n  if (hex.length % 2 !== 0) {\n    result = `0${hex}`\n  }\n\n  while (result.length / 2 < byteCount) {\n    result = `00${result}`\n  }\n\n  return result\n}\n\nexport { padHex }\n"],"mappings":";AAAO,IAAM,YAAY,CAAC,OAAe,SAAS,MAAM;AACtD,QAAM,QAAQ,MAAM,MAAM,GAAG,MAAM;AACnC,QAAM,QAAQ,MAAM,MAAM,MAAM,SAAS,MAAM;AAC/C,SAAO,GAAG,KAAK,MAAM,KAAK;AAC5B;;;ACJA,SAAS,gBAAgB;AACzB,SAAS,kBAAkB;;;ACD3B,IAAM,SAAS,CAAC,KAAa,YAAY,MAAM;AAC7C,MAAI,SAAS;AACb,MAAI,IAAI,SAAS,MAAM,GAAG;AACxB,aAAS,IAAI,GAAG;AAAA,EAClB;AAEA,SAAO,OAAO,SAAS,IAAI,WAAW;AACpC,aAAS,KAAK,MAAM;AAAA,EACtB;AAEA,SAAO;AACT;;;ADLO,IAAM,sBAAsB,CAAC,QAA0B,eAAe;AAGtE,IAAM,eAAe;AAErB,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,YAAM,KAAK,SAAS,KAAK,OAAO,MAAM,WAAW,IAAI,IAAI,QAAQ,KAAK,KAAK,EAAE,IAAI,OAAO,KAAK;AAC7F,aAAO,IAAI,mBAAkB,EAAE;AAAA,IACjC;AAAA,EACF;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,KAAK,UAAU,KAAK,MAAM,GAAG,MAAM,CAAC;AAAA,EAC7C;AAAA,EAEA,SAAS,UAAoB,SAAkB;AAC7C,QAAI,UAAU;AACZ,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;AAGO,IAAM,aAAN,cAAyB,kBAAkB;AAAC;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/eth-address",
-  "version": "4.15.0",
+  "version": "4.15.1",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "eth",
@@ -44,7 +44,7 @@
     "src"
   ],
   "dependencies": {
-    "@xylabs/assert": "^4.15.0",
+    "@xylabs/assert": "^4.15.1",
     "ethers": "^6.15.0"
   },
   "devDependencies": {

package/src/EthAddress.ts

@@ -4,23 +4,22 @@ import { getAddress } from 'ethers'
 import { ellipsize } from './ellipsize.ts'
 import { padHex } from './padHex.ts'
 
-export const isEthAddress = (obj: { type: string }) => obj?.type === EthAddress.type
+export const isEthAddressWrapper = (obj: { type: string }) => obj instanceof EthAddressWrapper
 
-export class EthAddress {
-  static readonly type = 'EthAddress'
-
-  type = EthAddress.type
+/** @deprecated use isEthAddressWrapper */
+export const isEthAddress = isEthAddressWrapper
 
+export class EthAddressWrapper {
   private address: bigint
 
-  private constructor(address: bigint) {
+  protected constructor(address: bigint) {
     this.address = address
   }
 
   static fromString(value?: string, base = 16) {
     if (value !== undefined) {
       const bi = base === 16 ? BigInt(value.startsWith('0x') ? value : `0x${value}`) : BigInt(value)
-      return new EthAddress(bi)
+      return new EthAddressWrapper(bi)
     }
   }
 
@@ -34,9 +33,9 @@ export class EthAddress {
     return /^(0x)?[\da-f]{40}$/i.test(address)
   }
 
-  equals(address?: EthAddress | string | null): boolean {
+  equals(address?: EthAddressWrapper | string | null): boolean {
     if (address !== null && address !== undefined) {
-      const inAddress = typeof address === 'string' ? assertEx(EthAddress.fromString(address), () => 'Bad Address') : address
+      const inAddress = typeof address === 'string' ? assertEx(EthAddressWrapper.fromString(address), () => 'Bad Address') : address
       return this.address === inAddress.address
     }
     return false
@@ -71,6 +70,9 @@ export class EthAddress {
   }
 
   validate() {
-    return EthAddress.validate(this.toString())
+    return EthAddressWrapper.validate(this.toString())
   }
 }
+
+/** @deprecated use EthAddressWrapper */
+export class EthAddress extends EthAddressWrapper {}

package/src/spec/EthAddress.spec.ts

@@ -2,17 +2,17 @@ import {
   describe, expect, test,
 } from 'vitest'
 
-import { EthAddress } from '../EthAddress.ts'
+import { EthAddressWrapper } from '../EthAddress.ts'
 
 describe('EthAddress', () => {
   test('checking happy path', () => {
     const addressString = '7284b6A4233B8B05910F2CbF7dBf6715325F6fCb'.toLowerCase()
-    const address = EthAddress.fromString(addressString, 16)
+    const address = EthAddressWrapper.fromString(addressString, 16)
     expect(address?.toString()).toBe(`0x${addressString}`)
     expect(address?.toShortString()).toBe('0x72...cb')
   })
   test('checksum', () => {
-    const address = EthAddress.fromString('0x90f8bf6a479f320ead074411a4b0e7944ea8c9c1')
+    const address = EthAddressWrapper.fromString('0x90f8bf6a479f320ead074411a4b0e7944ea8c9c1')
     expect(address?.toString(true)).toBe('0x90F8bf6A479f320ead074411a4B0e7944Ea8c9C1')
   })
 })