ox 0.11.1 → 0.11.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # ox
 
+## 0.11.2
+
+### Patch Changes
+
+- [#153](https://github.com/wevm/ox/pull/153) [`95ebfcf`](https://github.com/wevm/ox/commit/95ebfcf1caf857b3658c26c26bb2d6ebbd88b904) Thanks [@jxom](https://github.com/jxom)! - Added `TokenId.compute` to compute deterministic TIP-20 token addresses from sender and salt.
+
 ## 0.11.1
 
 ### Patch Changes

package/_cjs/tempo/TokenId.js

@@ -3,7 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.from = from;
 exports.fromAddress = fromAddress;
 exports.toAddress = toAddress;
+exports.compute = compute;
+const AbiParameters = require("../core/AbiParameters.js");
 const Address = require("../core/Address.js");
+const Hash = require("../core/Hash.js");
 const Hex = require("../core/Hex.js");
 const tip20Prefix = '0x20c0';
 function from(tokenIdOrAddress) {
@@ -25,4 +28,11 @@ function toAddress(tokenId) {
     const tokenIdHex = Hex.fromNumber(tokenId, { size: 18 });
     return Hex.concat(tip20Prefix, tokenIdHex);
 }
+function compute(value) {
+    const hash = Hash.keccak256(AbiParameters.encode(AbiParameters.from('address, bytes32'), [
+        value.sender,
+        value.salt,
+    ]));
+    return Hex.concat(Hex.padRight(tip20Prefix, 12), Hex.slice(hash, 0, 8));
+}
 //# sourceMappingURL=TokenId.js.map

package/_cjs/tempo/TokenId.js.map

@@ -1 +1 @@
-{"version":3,"file":"TokenId.js","sourceRoot":"","sources":["../../tempo/TokenId.ts"],"names":[],"mappings":";;AA0BA,oBAOC;AAiBD,kCAIC;AAiBD,8BAQC;AA/ED,8CAA6C;AAC7C,sCAAqC;AAErC,MAAM,WAAW,GAAG,QAAQ,CAAA;AAuB5B,SAAgB,IAAI,CAAC,gBAA2C;IAC9D,IACE,OAAO,gBAAgB,KAAK,QAAQ;QACpC,OAAO,gBAAgB,KAAK,QAAQ;QAEpC,OAAO,MAAM,CAAC,gBAAgB,CAAC,CAAA;IACjC,OAAO,WAAW,CAAC,gBAAgB,CAAC,CAAA;AACtC,CAAC;AAiBD,SAAgB,WAAW,CAAC,OAAwB;IAClD,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC;QAChD,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAA;IAC3C,OAAO,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,CAAA;AAC7D,CAAC;AAiBD,SAAgB,SAAS,CAAC,OAAyB;IACjD,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAChC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QACvB,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,MAAM,UAAU,GAAG,GAAG,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAA;IACxD,OAAO,GAAG,CAAC,MAAM,CAAC,WAAW,EAAE,UAAU,CAAC,CAAA;AAC5C,CAAC"}
+{"version":3,"file":"TokenId.js","sourceRoot":"","sources":["../../tempo/TokenId.ts"],"names":[],"mappings":";;AA4BA,oBAOC;AAiBD,kCAIC;AAiBD,8BAQC;AAsBD,0BAWC;AAlHD,0DAAyD;AACzD,8CAA6C;AAC7C,wCAAuC;AACvC,sCAAqC;AAErC,MAAM,WAAW,GAAG,QAAQ,CAAA;AAuB5B,SAAgB,IAAI,CAAC,gBAA2C;IAC9D,IACE,OAAO,gBAAgB,KAAK,QAAQ;QACpC,OAAO,gBAAgB,KAAK,QAAQ;QAEpC,OAAO,MAAM,CAAC,gBAAgB,CAAC,CAAA;IACjC,OAAO,WAAW,CAAC,gBAAgB,CAAC,CAAA;AACtC,CAAC;AAiBD,SAAgB,WAAW,CAAC,OAAwB;IAClD,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC;QAChD,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAA;IAC3C,OAAO,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,CAAA;AAC7D,CAAC;AAiBD,SAAgB,SAAS,CAAC,OAAyB;IACjD,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAChC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QACvB,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,MAAM,UAAU,GAAG,GAAG,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAA;IACxD,OAAO,GAAG,CAAC,MAAM,CAAC,WAAW,EAAE,UAAU,CAAC,CAAA;AAC5C,CAAC;AAsBD,SAAgB,OAAO,CAAC,KAAoB;IAC1C,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CACzB,aAAa,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE;QAC3D,KAAK,CAAC,MAAM;QACZ,KAAK,CAAC,IAAI;KACX,CAAC,CACH,CAAA;IACD,OAAO,GAAG,CAAC,MAAM,CACf,GAAG,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC,EAC7B,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,CACH,CAAA;AACtB,CAAC"}

package/_cjs/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
-exports.version = '0.11.1';
+exports.version = '0.11.2';
 //# sourceMappingURL=version.js.map

package/_esm/tempo/TokenId.js

@@ -1,4 +1,6 @@
+import * as AbiParameters from '../core/AbiParameters.js';
 import * as Address from '../core/Address.js';
+import * as Hash from '../core/Hash.js';
 import * as Hex from '../core/Hex.js';
 const tip20Prefix = '0x20c0';
 /**
@@ -68,4 +70,31 @@ export function toAddress(tokenId) {
     const tokenIdHex = Hex.fromNumber(tokenId, { size: 18 });
     return Hex.concat(tip20Prefix, tokenIdHex);
 }
+/**
+ * Computes a deterministic TIP-20 token address from a sender address and salt.
+ *
+ * The address is computed as: `TIP20_PREFIX (12 bytes) || keccak256(abi.encode(sender, salt))[:8]`
+ *
+ * [TIP-20 Token Standard](https://docs.tempo.xyz/protocol/tip20/overview)
+ *
+ * @example
+ * ```ts twoslash
+ * import { TokenId } from 'ox/tempo'
+ *
+ * const address = TokenId.compute({
+ *   sender: '0x1234567890123456789012345678901234567890',
+ *   salt: '0x0000000000000000000000000000000000000000000000000000000000000001',
+ * })
+ * ```
+ *
+ * @param value - The sender address and salt.
+ * @returns The computed TIP-20 token address.
+ */
+export function compute(value) {
+    const hash = Hash.keccak256(AbiParameters.encode(AbiParameters.from('address, bytes32'), [
+        value.sender,
+        value.salt,
+    ]));
+    return Hex.concat(Hex.padRight(tip20Prefix, 12), Hex.slice(hash, 0, 8));
+}
 //# sourceMappingURL=TokenId.js.map

package/_esm/tempo/TokenId.js.map

@@ -1 +1 @@
-{"version":3,"file":"TokenId.js","sourceRoot":"","sources":["../../tempo/TokenId.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,oBAAoB,CAAA;AAC7C,OAAO,KAAK,GAAG,MAAM,gBAAgB,CAAA;AAErC,MAAM,WAAW,GAAG,QAAQ,CAAA;AAK5B;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,IAAI,CAAC,gBAA2C;IAC9D,IACE,OAAO,gBAAgB,KAAK,QAAQ;QACpC,OAAO,gBAAgB,KAAK,QAAQ;QAEpC,OAAO,MAAM,CAAC,gBAAgB,CAAC,CAAA;IACjC,OAAO,WAAW,CAAC,gBAAgB,CAAC,CAAA;AACtC,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,WAAW,CAAC,OAAwB;IAClD,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC;QAChD,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAA;IAC3C,OAAO,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,CAAA;AAC7D,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,SAAS,CAAC,OAAyB;IACjD,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAChC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QACvB,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,MAAM,UAAU,GAAG,GAAG,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAA;IACxD,OAAO,GAAG,CAAC,MAAM,CAAC,WAAW,EAAE,UAAU,CAAC,CAAA;AAC5C,CAAC"}
+{"version":3,"file":"TokenId.js","sourceRoot":"","sources":["../../tempo/TokenId.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,aAAa,MAAM,0BAA0B,CAAA;AACzD,OAAO,KAAK,OAAO,MAAM,oBAAoB,CAAA;AAC7C,OAAO,KAAK,IAAI,MAAM,iBAAiB,CAAA;AACvC,OAAO,KAAK,GAAG,MAAM,gBAAgB,CAAA;AAErC,MAAM,WAAW,GAAG,QAAQ,CAAA;AAK5B;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,IAAI,CAAC,gBAA2C;IAC9D,IACE,OAAO,gBAAgB,KAAK,QAAQ;QACpC,OAAO,gBAAgB,KAAK,QAAQ;QAEpC,OAAO,MAAM,CAAC,gBAAgB,CAAC,CAAA;IACjC,OAAO,WAAW,CAAC,gBAAgB,CAAC,CAAA;AACtC,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,WAAW,CAAC,OAAwB;IAClD,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC;QAChD,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAA;IAC3C,OAAO,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,CAAA;AAC7D,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,SAAS,CAAC,OAAyB;IACjD,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAChC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QACvB,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,MAAM,UAAU,GAAG,GAAG,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAA;IACxD,OAAO,GAAG,CAAC,MAAM,CAAC,WAAW,EAAE,UAAU,CAAC,CAAA;AAC5C,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,OAAO,CAAC,KAAoB;IAC1C,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CACzB,aAAa,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAAE;QAC3D,KAAK,CAAC,MAAM;QACZ,KAAK,CAAC,IAAI;KACX,CAAC,CACH,CAAA;IACD,OAAO,GAAG,CAAC,MAAM,CACf,GAAG,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,CAAC,EAC7B,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,CACH,CAAA;AACtB,CAAC"}

package/_esm/version.js

@@ -1,3 +1,3 @@
 /** @internal */
-export const version = '0.11.1';
+export const version = '0.11.2';
 //# sourceMappingURL=version.js.map

package/_types/tempo/TokenId.d.ts

@@ -1,4 +1,5 @@
 import * as Address from '../core/Address.js';
+import * as Hex from '../core/Hex.js';
 export type TokenId = bigint;
 export type TokenIdOrAddress = TokenId | Address.Address;
 /**
@@ -52,4 +53,33 @@ export declare function fromAddress(address: Address.Address): TokenId;
  * @returns The address.
  */
 export declare function toAddress(tokenId: TokenIdOrAddress): Address.Address;
+/**
+ * Computes a deterministic TIP-20 token address from a sender address and salt.
+ *
+ * The address is computed as: `TIP20_PREFIX (12 bytes) || keccak256(abi.encode(sender, salt))[:8]`
+ *
+ * [TIP-20 Token Standard](https://docs.tempo.xyz/protocol/tip20/overview)
+ *
+ * @example
+ * ```ts twoslash
+ * import { TokenId } from 'ox/tempo'
+ *
+ * const address = TokenId.compute({
+ *   sender: '0x1234567890123456789012345678901234567890',
+ *   salt: '0x0000000000000000000000000000000000000000000000000000000000000001',
+ * })
+ * ```
+ *
+ * @param value - The sender address and salt.
+ * @returns The computed TIP-20 token address.
+ */
+export declare function compute(value: compute.Value): Address.Address;
+export declare namespace compute {
+    type Value = {
+        /** The salt (32 bytes). */
+        salt: Hex.Hex;
+        /** The sender address. */
+        sender: Address.Address;
+    };
+}
 //# sourceMappingURL=TokenId.d.ts.map

package/_types/tempo/TokenId.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TokenId.d.ts","sourceRoot":"","sources":["../../tempo/TokenId.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,oBAAoB,CAAA;AAK7C,MAAM,MAAM,OAAO,GAAG,MAAM,CAAA;AAC5B,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;AAExD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,IAAI,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,MAAM,GAAG,OAAO,CAOzE;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,GAAG,OAAO,CAI7D;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAQpE"}
+{"version":3,"file":"TokenId.d.ts","sourceRoot":"","sources":["../../tempo/TokenId.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,OAAO,MAAM,oBAAoB,CAAA;AAE7C,OAAO,KAAK,GAAG,MAAM,gBAAgB,CAAA;AAIrC,MAAM,MAAM,OAAO,GAAG,MAAM,CAAA;AAC5B,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAAG,OAAO,CAAC,OAAO,CAAA;AAExD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,IAAI,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,MAAM,GAAG,OAAO,CAOzE;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,GAAG,OAAO,CAI7D;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAQpE;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,KAAK,GAAG,OAAO,CAAC,OAAO,CAW7D;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,KAAY,KAAK,GAAG;QAClB,2BAA2B;QAC3B,IAAI,EAAE,GAAG,CAAC,GAAG,CAAA;QACb,0BAA0B;QAC1B,MAAM,EAAE,OAAO,CAAC,OAAO,CAAA;KACxB,CAAA;CACF"}

package/_types/version.d.ts

@@ -1,3 +1,3 @@
 /** @internal */
-export declare const version = "0.11.1";
+export declare const version = "0.11.2";
 //# sourceMappingURL=version.d.ts.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ox",
   "description": "Ethereum Standard Library",
-  "version": "0.11.1",
+  "version": "0.11.2",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",

package/tempo/TokenId.test.ts

@@ -38,3 +38,36 @@ test('toAddress', () => {
     '0x20c0000000000000000000000000000000000def',
   )
 })
+
+test('compute', () => {
+  const sender = '0x1234567890123456789012345678901234567890'
+  const salt1 =
+    '0x0000000000000000000000000000000000000000000000000000000000000001'
+  const salt2 =
+    '0x0000000000000000000000000000000000000000000000000000000000000002'
+
+  const address1 = TokenId.compute({ sender, salt: salt1 })
+  const address2 = TokenId.compute({ sender, salt: salt2 })
+
+  // deterministic: same inputs produce same output
+  expect(TokenId.compute({ sender, salt: salt1 })).toBe(address1)
+
+  // different salts produce different addresses
+  expect(address1).not.toBe(address2)
+
+  // addresses have TIP-20 prefix (0x20c0 followed by zeroes for 12 bytes total)
+  expect(address1.toLowerCase().startsWith('0x20c000000000000000000000')).toBe(
+    true,
+  )
+  expect(address2.toLowerCase().startsWith('0x20c000000000000000000000')).toBe(
+    true,
+  )
+
+  // addresses are 20 bytes (40 hex chars + 0x prefix)
+  expect(address1.length).toBe(42)
+
+  // different senders produce different addresses
+  const otherSender = '0xabcdefabcdefabcdefabcdefabcdefabcdefabcd'
+  const address3 = TokenId.compute({ sender: otherSender, salt: salt1 })
+  expect(address3).not.toBe(address1)
+})

package/tempo/TokenId.ts

@@ -1,4 +1,6 @@
+import * as AbiParameters from '../core/AbiParameters.js'
 import * as Address from '../core/Address.js'
+import * as Hash from '../core/Hash.js'
 import * as Hex from '../core/Hex.js'
 
 const tip20Prefix = '0x20c0'
@@ -78,3 +80,45 @@ export function toAddress(tokenId: TokenIdOrAddress): Address.Address {
   const tokenIdHex = Hex.fromNumber(tokenId, { size: 18 })
   return Hex.concat(tip20Prefix, tokenIdHex)
 }
+
+/**
+ * Computes a deterministic TIP-20 token address from a sender address and salt.
+ *
+ * The address is computed as: `TIP20_PREFIX (12 bytes) || keccak256(abi.encode(sender, salt))[:8]`
+ *
+ * [TIP-20 Token Standard](https://docs.tempo.xyz/protocol/tip20/overview)
+ *
+ * @example
+ * ```ts twoslash
+ * import { TokenId } from 'ox/tempo'
+ *
+ * const address = TokenId.compute({
+ *   sender: '0x1234567890123456789012345678901234567890',
+ *   salt: '0x0000000000000000000000000000000000000000000000000000000000000001',
+ * })
+ * ```
+ *
+ * @param value - The sender address and salt.
+ * @returns The computed TIP-20 token address.
+ */
+export function compute(value: compute.Value): Address.Address {
+  const hash = Hash.keccak256(
+    AbiParameters.encode(AbiParameters.from('address, bytes32'), [
+      value.sender,
+      value.salt,
+    ]),
+  )
+  return Hex.concat(
+    Hex.padRight(tip20Prefix, 12),
+    Hex.slice(hash, 0, 8),
+  ) as Address.Address
+}
+
+export declare namespace compute {
+  export type Value = {
+    /** The salt (32 bytes). */
+    salt: Hex.Hex
+    /** The sender address. */
+    sender: Address.Address
+  }
+}

package/version.ts

@@ -1,2 +1,2 @@
 /** @internal */
-export const version = '0.11.1'
+export const version = '0.11.2'