ox 0.14.30 → 0.14.32

package/core/internal/abiParameters.ts

@@ -140,7 +140,8 @@ export function decodeArray(
 
   // If the length of the array is not known in advance (dynamic array),
   // this means we will need to wonder off to the pointer and decode.
-  if (!length) {
+  // Note: zero-length fixed arrays (`T[0]`) are not dynamic.
+  if (length === null) {
     // Dealing with a dynamic type, so get the offset of the array data.
     const offset = Bytes.toNumber(cursor.readBytes(sizeOfOffset))
 
@@ -167,6 +168,12 @@ export function decodeArray(
       })
       consumed += consumed_
       value.push(data)
+      // Charge zero-width elements against the read limit to bound work
+      // on huge lengths of zero-width types (e.g. `uint256[0][]`).
+      if (consumed_ === 0) {
+        cursor.assertReadLimit()
+        cursor._touch()
+      }
     }
 
     // As we have gone wondering, restore to the original position + next slot.
@@ -211,6 +218,12 @@ export function decodeArray(
     })
     consumed += consumed_
     value.push(data)
+    // Charge zero-width elements against the read limit to bound work
+    // on huge lengths of zero-width types (e.g. `uint256[0][4294967295]`).
+    if (consumed_ === 0) {
+      cursor.assertReadLimit()
+      cursor._touch()
+    }
   }
   return [value, consumed]
 }
@@ -583,7 +596,9 @@ export function encodeArray<const parameter extends AbiParameters.Parameter>(
       type: `${parameter.type}[${length}]`,
     })
 
-  let dynamicChild = false
+  // Zero-length fixed arrays of dynamic types (e.g. `string[0]`) are dynamic
+  // per the ABI spec, even though they have no elements to inspect.
+  let dynamicChild = value.length === 0 && hasDynamicChild(parameter)
   const preparedParameters: PreparedParameter[] = []
   for (let i = 0; i < value.length; i++) {
     const preparedParam = prepareParameter({

package/core/internal/rpcSchemas/eth.ts

@@ -436,6 +436,22 @@ export type Eth = RpcSchema.From<
       }
       ReturnType: AccountProof.Rpc
     }
+  /**
+   * Returns the raw, serialized transaction specified by hash
+   *
+   * @example
+   * ```
+   * request({ method: 'eth_getRawTransactionByHash', params: ['0x...'] })
+   * // '0x...'
+   * ```
+   */
+  | {
+      Request: {
+        method: 'eth_getRawTransactionByHash'
+        params: [hash: Hex.Hex]
+      }
+      ReturnType: Hex.Hex | null
+    }
   /**
    * Returns the value from a storage position at an address
    *

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ox",
   "description": "Ethereum Standard Library",
-  "version": "0.14.30",
+  "version": "0.14.32",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",
@@ -508,6 +508,16 @@
       "import": "./_esm/tempo/Channel.js",
       "default": "./_cjs/tempo/Channel.js"
     },
+    "./tempo/EarnShares": {
+      "types": "./_types/tempo/EarnShares.d.ts",
+      "import": "./_esm/tempo/EarnShares.js",
+      "default": "./_cjs/tempo/EarnShares.js"
+    },
+    "./tempo/KeyAuthorization.test-d": {
+      "types": "./_types/tempo/KeyAuthorization.test-d.d.ts",
+      "import": "./_esm/tempo/KeyAuthorization.test-d.js",
+      "default": "./_cjs/tempo/KeyAuthorization.test-d.js"
+    },
     "./tempo/KeyAuthorization": {
       "types": "./_types/tempo/KeyAuthorization.d.ts",
       "import": "./_esm/tempo/KeyAuthorization.js",
@@ -538,6 +548,11 @@
       "import": "./_esm/tempo/RpcSchemaTempo.js",
       "default": "./_cjs/tempo/RpcSchemaTempo.js"
     },
+    "./tempo/SignatureEnvelope.test-d": {
+      "types": "./_types/tempo/SignatureEnvelope.test-d.d.ts",
+      "import": "./_esm/tempo/SignatureEnvelope.test-d.js",
+      "default": "./_cjs/tempo/SignatureEnvelope.test-d.js"
+    },
     "./tempo/SignatureEnvelope": {
       "types": "./_types/tempo/SignatureEnvelope.d.ts",
       "import": "./_esm/tempo/SignatureEnvelope.js",

package/tempo/EarnShares/package.json

@@ -0,0 +1,6 @@
+{
+  "type": "module",
+  "types": "../../_types/tempo/EarnShares.d.ts",
+  "main": "../../_cjs/tempo/EarnShares.js",
+  "module": "../../_esm/tempo/EarnShares.js"
+}

package/tempo/EarnShares.test.ts

@@ -0,0 +1,122 @@
+import { EarnShares } from 'ox/tempo'
+import { describe, expect, test } from 'vitest'
+
+const anchor = { engineShares: 3n, shareSupply: 2n } as const
+
+describe('toAmount', () => {
+  test('default', () => {
+    expect(EarnShares.toAmount(anchor, 7n)).toBe(4n)
+  })
+
+  test('behavior: rounds down', () => {
+    expect(EarnShares.toAmount({ engineShares: 3n, shareSupply: 1n }, 2n)).toBe(
+      0n,
+    )
+  })
+})
+
+describe('toAmountUp', () => {
+  test('default', () => {
+    expect(EarnShares.toAmountUp(anchor, 7n)).toBe(5n)
+  })
+
+  test('behavior: exact conversions do not round up', () => {
+    expect(EarnShares.toAmountUp(anchor, 3n)).toBe(2n)
+  })
+})
+
+describe('toVenueAmount', () => {
+  test('default', () => {
+    expect(EarnShares.toVenueAmount(anchor, 7n)).toBe(10n)
+  })
+
+  test('behavior: identity at the initial 1:1 anchor', () => {
+    expect(
+      EarnShares.toVenueAmount({ engineShares: 1n, shareSupply: 1n }, 12_345n),
+    ).toBe(12_345n)
+  })
+})
+
+describe('feeShares', () => {
+  test('default', () => {
+    expect(
+      EarnShares.feeShares({
+        activeAssets: 1_100n,
+        shareSupply: 1_000n,
+        totalFeeAssets: 100n,
+      }),
+    ).toBe(100n)
+  })
+
+  test('behavior: zero fee mints nothing', () => {
+    expect(
+      EarnShares.feeShares({
+        activeAssets: 1_100n,
+        shareSupply: 1_000n,
+        totalFeeAssets: 0n,
+      }),
+    ).toBe(0n)
+  })
+
+  test('behavior: fee at or above active assets mints nothing', () => {
+    expect(
+      EarnShares.feeShares({
+        activeAssets: 100n,
+        shareSupply: 1_000n,
+        totalFeeAssets: 100n,
+      }),
+    ).toBe(0n)
+  })
+
+  test('behavior: rounds down', () => {
+    expect(
+      EarnShares.feeShares({
+        activeAssets: 1_000n,
+        shareSupply: 999n,
+        totalFeeAssets: 100n,
+      }),
+    ).toBe(111n)
+  })
+})
+
+describe('minimumOutput', () => {
+  test('default', () => {
+    expect(EarnShares.minimumOutput(1_000_000n, 50)).toBe(995_000n)
+  })
+
+  test('behavior: zero slippage returns the expected output', () => {
+    expect(EarnShares.minimumOutput(1_000_000n, 0)).toBe(1_000_000n)
+  })
+
+  test('behavior: floors to 1n', () => {
+    expect(EarnShares.minimumOutput(1n, 9_999)).toBe(1n)
+  })
+
+  test('error: non-positive expected output', () => {
+    expect(() =>
+      EarnShares.minimumOutput(0n, 50),
+    ).toThrowErrorMatchingInlineSnapshot(
+      `[EarnShares.InvalidExpectedOutputError: Expected output \`0\` must be greater than zero.]`,
+    )
+  })
+
+  test('error: out-of-range slippage', () => {
+    expect(() =>
+      EarnShares.minimumOutput(1_000_000n, 10_000),
+    ).toThrowErrorMatchingInlineSnapshot(`
+      [EarnShares.InvalidSlippageError: Slippage tolerance \`10000\` is invalid.
+
+      Slippage must be a whole number from 0 through 9999 basis points.]
+    `)
+  })
+
+  test('error: non-integer slippage', () => {
+    expect(() =>
+      EarnShares.minimumOutput(1_000_000n, 0.5),
+    ).toThrowErrorMatchingInlineSnapshot(`
+      [EarnShares.InvalidSlippageError: Slippage tolerance \`0.5\` is invalid.
+
+      Slippage must be a whole number from 0 through 9999 basis points.]
+    `)
+  })
+})

package/tempo/EarnShares.ts

@@ -0,0 +1,232 @@
+import * as Errors from '../core/Errors.js'
+
+/** Basis-point denominator used by slippage bounds. */
+export const basisPointScale = 10_000
+
+/**
+ * Tempo Earn `VaultAdapter` conversion anchor.
+ *
+ * The adapter prices vault shares against venue shares through this pair:
+ * `engineShares` venue shares are worth `shareSupply` vault shares. It is initialised
+ * 1:1 and restated on `contribute` and `migrateEngine`.
+ *
+ * These conversions are raw and fee-blind; they ignore pending fee dilution
+ * and are unsuitable for user-facing value (use the adapter's `previewRedeem`).
+ */
+export type Anchor = {
+  /** Venue shares held by the engine at the anchor point. */
+  engineShares: bigint
+  /** Vault share supply at the anchor point. */
+  shareSupply: bigint
+}
+
+/**
+ * Converts venue shares to a vault share amount at the anchor rate, rounding down.
+ *
+ * Mirrors `VaultAdapter.sharesToTokens`.
+ *
+ * @example
+ * ```ts twoslash
+ * import { EarnShares } from 'ox/tempo'
+ *
+ * const shareAmount = EarnShares.toAmount(
+ *   { engineShares: 3n, shareSupply: 2n },
+ *   7n,
+ * )
+ * // @log: 4n
+ * ```
+ *
+ * @param anchor - The conversion anchor.
+ * @param venueShareAmount - Venue share amount, base units.
+ * @returns Vault share amount, rounded down.
+ */
+export function toAmount(anchor: Anchor, venueShareAmount: bigint): bigint {
+  return (venueShareAmount * anchor.shareSupply) / anchor.engineShares
+}
+
+export declare namespace toAmount {
+  type ErrorType = Errors.GlobalErrorType
+}
+
+/**
+ * Converts venue shares to a vault share amount at the anchor rate, rounding up.
+ *
+ * Mirrors the adapter's ceiling conversion used by exact-asset exits.
+ *
+ * @example
+ * ```ts twoslash
+ * import { EarnShares } from 'ox/tempo'
+ *
+ * const shareAmount = EarnShares.toAmountUp(
+ *   { engineShares: 3n, shareSupply: 2n },
+ *   7n,
+ * )
+ * // @log: 5n
+ * ```
+ *
+ * @param anchor - The conversion anchor.
+ * @param venueShareAmount - Venue share amount, base units.
+ * @returns Vault share amount, rounded up.
+ */
+export function toAmountUp(anchor: Anchor, venueShareAmount: bigint): bigint {
+  const { engineShares, shareSupply } = anchor
+  return (venueShareAmount * shareSupply + engineShares - 1n) / engineShares
+}
+
+export declare namespace toAmountUp {
+  type ErrorType = Errors.GlobalErrorType
+}
+
+/**
+ * Converts a vault share amount to venue shares at the anchor rate, rounding down.
+ *
+ * Mirrors `VaultAdapter.tokensToShares`.
+ *
+ * @example
+ * ```ts twoslash
+ * import { EarnShares } from 'ox/tempo'
+ *
+ * const venueShareAmount = EarnShares.toVenueAmount(
+ *   { engineShares: 3n, shareSupply: 2n },
+ *   7n,
+ * )
+ * // @log: 10n
+ * ```
+ *
+ * @param anchor - The conversion anchor.
+ * @param shareAmount - Vault share amount, base units.
+ * @returns Venue share amount, rounded down.
+ */
+export function toVenueAmount(anchor: Anchor, shareAmount: bigint): bigint {
+  return (shareAmount * anchor.engineShares) / anchor.shareSupply
+}
+
+export declare namespace toVenueAmount {
+  type ErrorType = Errors.GlobalErrorType
+}
+
+/**
+ * Computes the dilution-correct vault shares minted for an asset-denominated fee.
+ *
+ * Mirrors `FeeMath`:
+ * `feeShares = floor(fee * shareSupply / (activeAssets - fee))`, zero when the
+ * fee is zero or not smaller than the active assets. Minting this amount to the
+ * fee ledger prices the fee at post-mint value per share.
+ *
+ * @example
+ * ```ts twoslash
+ * import { EarnShares } from 'ox/tempo'
+ *
+ * const shares = EarnShares.feeShares({
+ *   activeAssets: 1_100n,
+ *   shareSupply: 1_000n,
+ *   totalFeeAssets: 100n,
+ * })
+ * // @log: 100n
+ * ```
+ *
+ * @param options - Fee accrual inputs.
+ * @returns Vault shares to mint for the fee, rounded down.
+ */
+export function feeShares(options: feeShares.Options): bigint {
+  const { activeAssets, shareSupply, totalFeeAssets } = options
+  if (totalFeeAssets === 0n || totalFeeAssets >= activeAssets) return 0n
+  return (totalFeeAssets * shareSupply) / (activeAssets - totalFeeAssets)
+}
+
+export declare namespace feeShares {
+  export type Options = {
+    /** Assets backing the active (non-queued) supply, base units. */
+    activeAssets: bigint
+    /** Active vault share supply, base units. */
+    shareSupply: bigint
+    /** Total fee liability in asset units. */
+    totalFeeAssets: bigint
+  }
+  export type ErrorType = Errors.GlobalErrorType
+}
+
+/**
+ * Lowers an expected output by a basis-point slippage tolerance, flooring to `1n`.
+ *
+ * Suitable for lower bounds such as a deposit's minimum shares or a redeem's
+ * minimum assets; not for upper bounds such as an exact withdrawal's maximum
+ * shares.
+ *
+ * @example
+ * ```ts twoslash
+ * import { EarnShares } from 'ox/tempo'
+ *
+ * const minimumShares = EarnShares.minimumOutput(1_000_000n, 50)
+ * // @log: 995_000n
+ * ```
+ *
+ * @param expectedAmount - Expected output in base units.
+ * @param slippageBps - Allowed slippage in basis points from `0` through `9_999`.
+ * @returns The minimum accepted output, floored to `1n`.
+ * @throws `InvalidExpectedOutputError` when `expectedAmount` is not positive.
+ * @throws `InvalidSlippageError` when `slippageBps` is outside its valid range.
+ */
+export function minimumOutput(
+  expectedAmount: bigint,
+  slippageBps: number,
+): bigint {
+  if (expectedAmount <= 0n)
+    throw new InvalidExpectedOutputError({ expectedAmount })
+  if (
+    !Number.isInteger(slippageBps) ||
+    slippageBps < 0 ||
+    slippageBps >= basisPointScale
+  )
+    throw new InvalidSlippageError({ slippageBps })
+  const scale = BigInt(basisPointScale)
+  const bounded = (expectedAmount * (scale - BigInt(slippageBps))) / scale
+  return bounded === 0n ? 1n : bounded
+}
+
+export declare namespace minimumOutput {
+  type ErrorType =
+    | InvalidExpectedOutputError
+    | InvalidSlippageError
+    | Errors.GlobalErrorType
+}
+
+/**
+ * Error thrown when an expected output is not positive.
+ */
+export class InvalidExpectedOutputError extends Errors.BaseError {
+  override readonly name = 'EarnShares.InvalidExpectedOutputError'
+
+  constructor(options: InvalidExpectedOutputError.Options) {
+    super(
+      `Expected output \`${options.expectedAmount}\` must be greater than zero.`,
+    )
+  }
+}
+
+export declare namespace InvalidExpectedOutputError {
+  export type Options = {
+    expectedAmount: bigint
+  }
+}
+
+/**
+ * Error thrown when a slippage tolerance is not an integer from `0` through `9_999`.
+ */
+export class InvalidSlippageError extends Errors.BaseError {
+  override readonly name = 'EarnShares.InvalidSlippageError'
+
+  constructor(options: InvalidSlippageError.Options) {
+    super(`Slippage tolerance \`${options.slippageBps}\` is invalid.`, {
+      metaMessages: [
+        `Slippage must be a whole number from 0 through ${basisPointScale - 1} basis points.`,
+      ],
+    })
+  }
+}
+
+export declare namespace InvalidSlippageError {
+  export type Options = {
+    slippageBps: number
+  }
+}

package/tempo/KeyAuthorization.test-d/package.json

@@ -0,0 +1,6 @@
+{
+  "type": "module",
+  "types": "../../_types/tempo/KeyAuthorization.test-d.d.ts",
+  "main": "../../_cjs/tempo/KeyAuthorization.test-d.js",
+  "module": "../../_esm/tempo/KeyAuthorization.test-d.js"
+}

package/tempo/KeyAuthorization.test-d.ts

@@ -0,0 +1,62 @@
+import { expectTypeOf, test } from 'vitest'
+import * as KeyAuthorization from './KeyAuthorization.js'
+import type * as SignatureEnvelope from './SignatureEnvelope.js'
+
+const authorization = {
+  address: '0x1111111111111111111111111111111111111111',
+  chainId: 1n,
+  type: 'secp256k1',
+} as const satisfies KeyAuthorization.Input
+
+const signature = {
+  signature: {
+    r: 1n,
+    s: 2n,
+    yParity: 0,
+  },
+  type: 'secp256k1',
+} as const satisfies SignatureEnvelope.Secp256k1
+
+const multisig = {
+  account: '0x2222222222222222222222222222222222222222',
+  signatures: [signature],
+  type: 'multisig',
+} as const satisfies SignatureEnvelope.Multisig
+
+test('accepts primitive signatures', () => {
+  const signed = KeyAuthorization.from(authorization, { signature })
+
+  expectTypeOf(signed.signature).toMatchTypeOf<
+    KeyAuthorization.Signed['signature']
+  >()
+})
+
+test('rejects multisig signatures', () => {
+  KeyAuthorization.from(authorization, {
+    // @ts-expect-error Key authorizations accept only primitive signatures.
+    signature: multisig,
+  })
+
+  const multisigRpc = {
+    account: multisig.account,
+    signatures: [
+      {
+        r: '0x01',
+        s: '0x02',
+        type: 'secp256k1',
+        yParity: '0x0',
+      },
+    ],
+  } as const satisfies SignatureEnvelope.MultisigRpc
+
+  const rpc: KeyAuthorization.Rpc = {
+    chainId: '0x1',
+    expiry: null,
+    keyId: authorization.address,
+    keyType: authorization.type,
+    // @ts-expect-error Key authorizations accept only primitive RPC signatures.
+    signature: multisigRpc,
+  }
+
+  expectTypeOf(rpc).toEqualTypeOf<KeyAuthorization.Rpc>()
+})