@xylabs/eth-address 5.0.80 → 5.0.81

package/README.md

@@ -23,44 +23,46 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
 ## Classes
 
-- [EthAddress](#classes/EthAddress)
+- [EthAddressWrapper](#classes/EthAddressWrapper)
 
 ## Functions
 
-- [isEthAddress](#functions/isEthAddress)
+- [isEthAddressWrapper](#functions/isEthAddressWrapper)
 - [ellipsize](#functions/ellipsize)
 - [padHex](#functions/padHex)
 
 ### classes
 
-  ### <a id="EthAddress"></a>EthAddress
+  ### <a id="EthAddressWrapper"></a>EthAddressWrapper
 
 [**@xylabs/eth-address**](#../README)
 
 ***
 
-## Properties
+## Constructors
 
-### type
+### Constructor
 
 ```ts
-readonly static type: "EthAddress" = 'EthAddress';
+protected new EthAddressWrapper(address): EthAddressWrapper;
 ```
 
-***
+### Parameters
 
-### type
+#### address
 
-```ts
-type: string = EthAddress.type;
-```
+`bigint`
+
+### Returns
+
+`EthAddressWrapper`
 
 ## Methods
 
 ### fromString()
 
 ```ts
-static fromString(value?, base?): undefined | EthAddress;
+static fromString(value?, base?): EthAddressWrapper | undefined;
 ```
 
 ### Parameters
@@ -75,14 +77,14 @@ static fromString(value?, base?): undefined | EthAddress;
 
 ### Returns
 
-`undefined` \| `EthAddress`
+`EthAddressWrapper` \| `undefined`
 
 ***
 
 ### parse()
 
 ```ts
-static parse(value, base?): undefined | EthAddress;
+static parse(value, base?): EthAddressWrapper | undefined;
 ```
 
 ### Parameters
@@ -97,7 +99,7 @@ static parse(value, base?): undefined | EthAddress;
 
 ### Returns
 
-`undefined` \| `EthAddress`
+`EthAddressWrapper` \| `undefined`
 
 ***
 
@@ -129,7 +131,7 @@ equals(address?): boolean;
 
 #### address?
 
-`null` | `string` | `EthAddress`
+`string` | `EthAddressWrapper` | `null`
 
 ### Returns
 
@@ -188,12 +190,12 @@ toLowerCaseString(): string;
 ### toShortString()
 
 ```ts
-toShortString(length): string;
+toShortString(length?): string;
 ```
 
 ### Parameters
 
-#### length
+#### length?
 
 `number` = `2`
 
@@ -244,7 +246,7 @@ validate(): boolean;
 ***
 
 ```ts
-function ellipsize(value, length): string;
+function ellipsize(value, length?): string;
 ```
 
 ## Parameters
@@ -253,7 +255,7 @@ function ellipsize(value, length): string;
 
 `string`
 
-### length
+### length?
 
 `number` = `2`
 
@@ -261,14 +263,14 @@ function ellipsize(value, length): string;
 
 `string`
 
-  ### <a id="isEthAddress"></a>isEthAddress
+  ### <a id="isEthAddressWrapper"></a>isEthAddressWrapper
 
 [**@xylabs/eth-address**](#../README)
 
 ***
 
 ```ts
-function isEthAddress(obj): boolean;
+function isEthAddressWrapper(obj): obj is { type: string } & EthAddressWrapper;
 ```
 
 ## Parameters
@@ -281,7 +283,7 @@ function isEthAddress(obj): boolean;
 
 ## Returns
 
-`boolean`
+`obj is { type: string } & EthAddressWrapper`
 
   ### <a id="padHex"></a>padHex
 
@@ -290,7 +292,7 @@ function isEthAddress(obj): boolean;
 ***
 
 ```ts
-function padHex(hex, byteCount): string;
+function padHex(hex, byteCount?): string;
 ```
 
 ## Parameters
@@ -299,7 +301,7 @@ function padHex(hex, byteCount): string;
 
 `string`
 
-### byteCount
+### byteCount?
 
 `number` = `0`
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/eth-address",
-  "version": "5.0.80",
+  "version": "5.0.81",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "eth",
@@ -31,28 +31,25 @@
   "exports": {
     ".": {
       "types": "./dist/neutral/index.d.ts",
-      "source": "./src/index.ts",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
   "module": "./dist/neutral/index.mjs",
-  "source": "./src/index.ts",
   "types": "./dist/neutral/index.d.ts",
   "files": [
     "dist",
-    "src",
     "!**/*.bench.*",
     "!**/*.spec.*",
     "!**/*.test.*"
   ],
   "dependencies": {
-    "@xylabs/assert": "~5.0.80",
+    "@xylabs/assert": "~5.0.81",
     "ethers": "^6.16.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "~7.3.2",
-    "@xylabs/tsconfig": "~7.3.2",
+    "@xylabs/ts-scripts-yarn3": "~7.4.11",
+    "@xylabs/tsconfig": "~7.4.11",
     "typescript": "~5.9.3",
     "vitest": "~4.0.18"
   },

package/src/EthAddress.ts

@@ -1,72 +0,0 @@
-import { assertEx } from '@xylabs/assert'
-import { getAddress } from 'ethers'
-
-import { ellipsize } from './ellipsize.ts'
-import { padHex } from './padHex.ts'
-
-export const isEthAddressWrapper = (obj: { type: string }) => obj instanceof EthAddressWrapper
-
-export class EthAddressWrapper {
-  private 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 EthAddressWrapper(bi)
-    }
-  }
-
-  static parse(value: unknown, base?: number) {
-    if (typeof value === 'string') {
-      return this.fromString(value, base)
-    }
-  }
-
-  static validate(address: string) {
-    return /^(0x)?[\da-f]{40}$/i.test(address)
-  }
-
-  equals(address?: EthAddressWrapper | string | null): boolean {
-    if (address !== null && address !== undefined) {
-      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(): string {
-    return `0x${this.toHex()}`
-  }
-
-  toLowerCaseString() {
-    return this.toString().toLowerCase()
-  }
-
-  toShortString(length = 2) {
-    return `0x${ellipsize(this.toHex(), length)}`
-  }
-
-  toString(checksum?: boolean, chainId?: string) {
-    if (checksum) {
-      const strippedAddress = this.toHex()
-      return getAddress(chainId === undefined ? `0x${strippedAddress}` : `${chainId}0x${strippedAddress}`)
-    }
-    return `0x${this.toHex()}`
-  }
-
-  validate() {
-    return EthAddressWrapper.validate(this.toString())
-  }
-}

package/src/ellipsize.ts

@@ -1,5 +0,0 @@
-export const ellipsize = (value: string, length = 2) => {
-  const part1 = value.slice(0, length)
-  const part2 = value.slice(value.length - length)
-  return `${part1}...${part2}`
-}

package/src/index.ts

@@ -1,3 +0,0 @@
-export * from './ellipsize.ts'
-export * from './EthAddress.ts'
-export * from './padHex.ts'

package/src/padHex.ts

@@ -1,14 +0,0 @@
-const padHex = (hex: string, byteCount = 0) => {
-  let result = hex
-  if (hex.length % 2 !== 0) {
-    result = `0${hex}`
-  }
-
-  while (result.length / 2 < byteCount) {
-    result = `00${result}`
-  }
-
-  return result
-}
-
-export { padHex }