@xylabs/eth-address 2.6.14

package/dist/esm/EthAddress.d.ts

@@ -0,0 +1,21 @@
+/// <reference types="bn.js" />
+import { BigNumber } from '@xylabs/bignumber';
+export declare const isEthAddress: (obj: {
+    type: string;
+}) => boolean;
+export declare class EthAddress {
+    type: string;
+    private address;
+    static type: string;
+    private constructor();
+    equals(address?: EthAddress | string | null): boolean;
+    static fromString(value?: string, base?: number): EthAddress | undefined;
+    static parse(value: unknown, base?: number): EthAddress | undefined;
+    toBigNumber(): BigNumber;
+    toString(): string;
+    toLowerCaseString(): string;
+    toJSON(): string;
+    toHex(): string;
+    toShortString(length?: number): string;
+}
+//# sourceMappingURL=EthAddress.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"EthAddress.d.ts","sourceRoot":"","sources":["../../src/EthAddress.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAK7C,eAAO,MAAM,YAAY,QAAS;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,YAAkC,CAAA;AAEpF,qBAAa,UAAU;IACd,IAAI,SAAkB;IAE7B,OAAO,CAAC,OAAO,CAAW;IAE1B,MAAM,CAAC,IAAI,SAAe;IAE1B,OAAO;IAIA,MAAM,CAAC,OAAO,CAAC,EAAE,UAAU,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO;IAa5D,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,IAAI,SAAK;IAO3C,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,MAAM;IAMnC,WAAW;IAIX,QAAQ;IAIR,iBAAiB;IAIjB,MAAM,IAAI,MAAM;IAIhB,KAAK;IAIL,aAAa,CAAC,MAAM,SAAI;CAGhC"}

package/dist/esm/EthAddress.js

@@ -0,0 +1,56 @@
+import { assertEx } from '@xylabs/assert';
+import { BigNumber } from '@xylabs/bignumber';
+import { ellipsize } from './ellipsize';
+import { padHex } from './padHex';
+export const isEthAddress = (obj) => obj?.type === EthAddress.type;
+export class EthAddress {
+    type = EthAddress.type;
+    address;
+    static type = 'EthAddress';
+    constructor(address) {
+        this.address = address;
+    }
+    equals(address) {
+        if (address) {
+            let inAddress;
+            if (typeof address === 'string') {
+                inAddress = assertEx(EthAddress.fromString(address), 'Bad Address');
+            }
+            else {
+                inAddress = address;
+            }
+            return this.address.eq(inAddress.address);
+        }
+        return false;
+    }
+    static fromString(value, base = 16) {
+        if (value) {
+            const bn = new BigNumber(value.startsWith('0x') ? value.substring(2) : value, base);
+            return new EthAddress(bn);
+        }
+    }
+    static parse(value, base) {
+        if (typeof value === 'string') {
+            return this.fromString(value, base);
+        }
+    }
+    toBigNumber() {
+        return this.address;
+    }
+    toString() {
+        return `0x${this.toHex()}`;
+    }
+    toLowerCaseString() {
+        return this.toString().toLowerCase();
+    }
+    toJSON() {
+        return `0x${this.toHex()}`;
+    }
+    toHex() {
+        return padHex(this.address.toString(16), 20);
+    }
+    toShortString(length = 2) {
+        return `0x${ellipsize(this.toHex(), length)}`;
+    }
+}
+//# sourceMappingURL=EthAddress.js.map

package/dist/esm/EthAddress.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EthAddress.js","sourceRoot":"","sources":["../../src/EthAddress.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAE7C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEjC,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,GAAqB,EAAE,EAAE,CAAC,GAAG,EAAE,IAAI,KAAK,UAAU,CAAC,IAAI,CAAA;AAEpF,MAAM,OAAO,UAAU;IACd,IAAI,GAAG,UAAU,CAAC,IAAI,CAAA;IAErB,OAAO,CAAW;IAE1B,MAAM,CAAC,IAAI,GAAG,YAAY,CAAA;IAE1B,YAAoB,OAAkB;QACpC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;IAEM,MAAM,CAAC,OAAoC;QAChD,IAAI,OAAO,EAAE;YACX,IAAI,SAAqB,CAAA;YACzB,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;gBAC/B,SAAS,GAAG,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,aAAa,CAAC,CAAA;aACpE;iBAAM;gBACL,SAAS,GAAG,OAAO,CAAA;aACpB;YACD,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;SAC1C;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED,MAAM,CAAC,UAAU,CAAC,KAAc,EAAE,IAAI,GAAG,EAAE;QACzC,IAAI,KAAK,EAAE;YACT,MAAM,EAAE,GAAG,IAAI,SAAS,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;YACnF,OAAO,IAAI,UAAU,CAAC,EAAE,CAAC,CAAA;SAC1B;IACH,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,KAAc,EAAE,IAAa;QACxC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;SACpC;IACH,CAAC;IAEM,WAAW;QAChB,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAEM,QAAQ;QACb,OAAO,KAAK,IAAI,CAAC,KAAK,EAAE,EAAE,CAAA;IAC5B,CAAC;IAEM,iBAAiB;QACtB,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC,WAAW,EAAE,CAAA;IACtC,CAAC;IAEM,MAAM;QACX,OAAO,KAAK,IAAI,CAAC,KAAK,EAAE,EAAE,CAAA;IAC5B,CAAC;IAEM,KAAK;QACV,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAA;IAC9C,CAAC;IAEM,aAAa,CAAC,MAAM,GAAG,CAAC;QAC7B,OAAO,KAAK,SAAS,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,MAAM,CAAC,EAAE,CAAA;IAC/C,CAAC"}

package/dist/esm/ellipsize.d.ts

@@ -0,0 +1,2 @@
+export declare const ellipsize: (value: string, length?: number) => string;
+//# sourceMappingURL=ellipsize.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ellipsize.d.ts","sourceRoot":"","sources":["../../src/ellipsize.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS,UAAW,MAAM,4BAItC,CAAA"}

package/dist/esm/ellipsize.js

@@ -0,0 +1,6 @@
+export const ellipsize = (value, length = 2) => {
+    const part1 = value.slice(0, length);
+    const part2 = value.slice(value.length - length, value.length);
+    return `${part1}...${part2}`;
+};
+//# sourceMappingURL=ellipsize.js.map

package/dist/esm/ellipsize.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ellipsize.js","sourceRoot":"","sources":["../../src/ellipsize.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,KAAa,EAAE,MAAM,GAAG,CAAC,EAAE,EAAE;IACrD,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,CAAA;IACpC,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAA;IAC9D,OAAO,GAAG,KAAK,MAAM,KAAK,EAAE,CAAA;AAC9B,CAAC,CAAA"}

package/dist/esm/index.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA;AAC5B,cAAc,UAAU,CAAA"}

package/dist/esm/index.js

@@ -0,0 +1,4 @@
+export * from './ellipsize';
+export * from './EthAddress';
+export * from './padHex';
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA;AAC5B,cAAc,UAAU,CAAA"}

package/dist/esm/padHex.d.ts

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

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

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

package/dist/esm/padHex.js

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

package/dist/esm/padHex.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"padHex.js","sourceRoot":"","sources":["../../src/padHex.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,GAAG,CAAC,GAAW,EAAE,SAAkB,EAAE,EAAE;IACjD,IAAI,MAAM,GAAG,GAAG,CAAA;IAChB,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,EAAE;QACxB,MAAM,GAAG,IAAI,GAAG,EAAE,CAAA;KACnB;IACD,IAAI,SAAS,EAAE;QACb,OAAO,MAAM,CAAC,MAAM,GAAG,CAAC,GAAG,SAAS,EAAE;YACpC,MAAM,GAAG,KAAK,MAAM,EAAE,CAAA;SACvB;KACF;IACD,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAED,OAAO,EAAE,MAAM,EAAE,CAAA"}

package/package.json

@@ -0,0 +1,65 @@
+{
+  "license": "LGPL-3.0",
+  "name": "@xylabs/eth-address",
+  "author": {
+    "email": "support@xylabs.com",
+    "name": "XY Labs Development Team",
+    "url": "https://xylabs.com"
+  },
+  "bugs": {
+    "email": "support@xylabs.com",
+    "url": "https://github.com/xylabs/sdk-js/issues"
+  },
+  "workspaces": [
+    "packages/**/*"
+  ],
+  "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
+  "browser": "dist/esm/index.js",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "docs": "dist/docs.json",
+  "types": "dist/esm/index.d.ts",
+  "exports": {
+    ".": {
+      "node": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js"
+      },
+      "browser": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js"
+      },
+      "default": "./dist/esm/index.js"
+    },
+    "./dist/docs.json": {
+      "default": "./dist/docs.json"
+    },
+    "./package.json": "./package.json"
+  },
+  "homepage": "https://xylabs.com",
+  "keywords": [
+    "xylabs",
+    "utility",
+    "typescript",
+    "esm"
+  ],
+  "dependencies": {
+    "@xylabs/assert": "^2.6.14",
+    "@xylabs/bignumber": "^2.6.14"
+  },
+  "devDependencies": {
+    "@xylabs/eslint-config": "2.11.16",
+    "@xylabs/ts-scripts-yarn3": "^2.11.16",
+    "eslint": "^8.30.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/xylabs/sdk-js.git"
+  },
+  "sideEffects": false,
+  "version": "2.6.14",
+  "packageManager": "yarn@3.3.1"
+}

package/src/EthAddress.spec.ts

@@ -0,0 +1,10 @@
+import { EthAddress } from './EthAddress'
+
+describe('EthAddress', () => {
+  test('checking happy path', () => {
+    const addressString = '7284b6A4233B8B05910F2CbF7dBf6715325F6fCb'.toLowerCase()
+    const address = EthAddress.fromString(addressString, 16)
+    expect(address?.toString()).toBe(`0x${addressString}`)
+    expect(address?.toShortString()).toBe('0x72...cb')
+  })
+})

package/src/EthAddress.ts

@@ -0,0 +1,69 @@
+import { assertEx } from '@xylabs/assert'
+import { BigNumber } from '@xylabs/bignumber'
+
+import { ellipsize } from './ellipsize'
+import { padHex } from './padHex'
+
+export const isEthAddress = (obj: { type: string }) => obj?.type === EthAddress.type
+
+export class EthAddress {
+  public type = EthAddress.type
+
+  private address: BigNumber
+
+  static type = 'EthAddress'
+
+  private constructor(address: BigNumber) {
+    this.address = address
+  }
+
+  public equals(address?: EthAddress | string | null): boolean {
+    if (address) {
+      let inAddress: EthAddress
+      if (typeof address === 'string') {
+        inAddress = assertEx(EthAddress.fromString(address), 'Bad Address')
+      } else {
+        inAddress = address
+      }
+      return this.address.eq(inAddress.address)
+    }
+    return false
+  }
+
+  static fromString(value?: string, base = 16) {
+    if (value) {
+      const bn = new BigNumber(value.startsWith('0x') ? value.substring(2) : value, base)
+      return new EthAddress(bn)
+    }
+  }
+
+  static parse(value: unknown, base?: number) {
+    if (typeof value === 'string') {
+      return this.fromString(value, base)
+    }
+  }
+
+  public toBigNumber() {
+    return this.address
+  }
+
+  public toString() {
+    return `0x${this.toHex()}`
+  }
+
+  public toLowerCaseString() {
+    return this.toString().toLowerCase()
+  }
+
+  public toJSON(): string {
+    return `0x${this.toHex()}`
+  }
+
+  public toHex() {
+    return padHex(this.address.toString(16), 20)
+  }
+
+  public toShortString(length = 2) {
+    return `0x${ellipsize(this.toHex(), length)}`
+  }
+}

package/src/ellipsize.ts

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

package/src/index.ts

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

package/src/padHex.ts

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