chore: rename fromOpaqueData

wevm · Dec 18, 2023 · dcb2b0c · dcb2b0c
1 parent f7fa5b1
commit dcb2b0c
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 27 deletions.
diff --git a/site/.vitepress/sidebar.ts b/site/.vitepress/sidebar.ts
@@ -1004,10 +1004,6 @@ export const sidebar: DefaultTheme.Sidebar = {
           text: 'extractTransactionDepositedLogs',
           link: '/op-stack/utilities/extractTransactionDepositedLogs',
         },
-        {
-          text: 'fromOpaqueData',
-          link: '/op-stack/utilities/fromOpaqueData',
-        },
         {
           text: 'getL2TransactionHash',
           link: '/op-stack/utilities/getL2TransactionHash',
@@ -1020,6 +1016,10 @@ export const sidebar: DefaultTheme.Sidebar = {
           text: 'getSourceHash',
           link: '/op-stack/utilities/getSourceHash',
         },
+        {
+          text: 'opaqueDataToDepositData',
+          link: '/op-stack/utilities/opaqueDataToDepositData',
+        },
         {
           text: 'parseTransaction',
           link: '/op-stack/utilities/parseTransaction',

diff --git a/site/op-stack/utilities/fromOpaqueData.md b/site/op-stack/utilities/fromOpaqueData.md
@@ -2,7 +2,7 @@
 head:
   - - meta
     - property: og:title
-      content: fromOpaqueData
+      content: opaqueDataToDepositData
   - - meta
     - name: description
       content: Decodes opaque deposit data found in the "TransactionDeposited" event log.
@@ -12,21 +12,21 @@ head:
 
 ---
 
-# fromOpaqueData
+# opaqueDataToDepositData
 
 Decodes opaque deposit data found in the `TransactionDeposited` event log data.
 
 ## Import
 ```ts
-import { fromOpaqueData } from 'viem'
+import { opaqueDataToDepositData } from 'viem'
 ```
 
 ## Usage
 
 ```ts
-import { fromOpaqueData } from 'viem'
+import { opaqueDataToDepositData } from 'viem'
 
-const data = fromOpaqueData('0x00000000000000000000000000000000000000000000000000000000000001a40000000000000000000000000000000000000000000000000000000000000045000000000000526c01deadbeef')
+const data = opaqueDataToDepositData('0x00000000000000000000000000000000000000000000000000000000000001a40000000000000000000000000000000000000000000000000000000000000045000000000000526c01deadbeef')
 ```
 
 ## Returns

diff --git a/src/chains/opStack/index.ts b/src/chains/opStack/index.ts
@@ -114,11 +114,11 @@ export {
 } from './utils/extractTransactionDepositedLogs.js'
 
 export {
-  fromOpaqueData,
-  type FromOpaqueDataErrorType,
-  type FromOpaqueDataParameters,
-  type FromOpaqueDataReturnType,
-} from './utils/fromOpaqueData.js'
+  opaqueDataToDepositData,
+  type OpaqueDataToDepositDataErrorType,
+  type OpaqueDataToDepositDataParameters,
+  type OpaqueDataToDepositDataReturnType,
+} from './utils/opaqueDataToDepositData.js'
 
 export {
   getL2TransactionHash,

diff --git a/src/chains/opStack/utils/getL2TransactionHash.ts b/src/chains/opStack/utils/getL2TransactionHash.ts
@@ -6,8 +6,8 @@ import type { Hex } from '../../../types/misc.js'
 import { keccak256 } from '../../../utils/hash/keccak256.js'
 import type { portalAbi } from '../abis.js'
 import { serializeTransaction } from '../serializers.js'
-import { fromOpaqueData } from './fromOpaqueData.js'
 import { getSourceHash } from './getSourceHash.js'
+import { opaqueDataToDepositData } from './opaqueDataToDepositData.js'
 
 export type GetL2TransactionHashParameters = {
   /** The "TransactionDeposited" log to compute the L2 hash from. */
@@ -32,7 +32,7 @@ export function getL2TransactionHash({ log }: GetL2TransactionHashParameters) {
     l1BlockHash: log.blockHash,
     l1LogIndex: log.logIndex,
   })
-  const { data, gas, isCreation, mint, value } = fromOpaqueData(
+  const { data, gas, isCreation, mint, value } = opaqueDataToDepositData(
     log.args.opaqueData,
   )
 

diff --git a/...ains/opStack/utils/fromOpaqueData.test.ts → ...ack/utils/opaqueDataToDepositData.test.ts b/...ains/opStack/utils/fromOpaqueData.test.ts → ...ack/utils/opaqueDataToDepositData.test.ts
@@ -1,6 +1,6 @@
 import { expect, test } from 'vitest'
 import { encodePacked } from '../../../index.js'
-import { fromOpaqueData } from './fromOpaqueData.js'
+import { opaqueDataToDepositData } from './opaqueDataToDepositData.js'
 
 test('default', () => {
   const data_1 = {
@@ -14,7 +14,7 @@ test('default', () => {
     ['uint', 'uint', 'uint64', 'bool', 'bytes'],
     [data_1.mint, data_1.value, data_1.gas, data_1.isCreation, data_1.data],
   )
-  expect(fromOpaqueData(opaqueData_1)).toEqual(data_1)
+  expect(opaqueDataToDepositData(opaqueData_1)).toEqual(data_1)
 
   const data_2 = {
     mint: 0n,
@@ -27,7 +27,7 @@ test('default', () => {
     ['uint', 'uint', 'uint64', 'bool', 'bytes'],
     [data_2.mint, data_2.value, data_2.gas, data_2.isCreation, data_2.data],
   )
-  expect(fromOpaqueData(opaqueData_2)).toEqual(data_2)
+  expect(opaqueDataToDepositData(opaqueData_2)).toEqual(data_2)
 
   const data_3 = {
     mint: 0n,
@@ -40,7 +40,7 @@ test('default', () => {
     ['uint', 'uint', 'uint64', 'bool', 'bytes'],
     [data_3.mint, data_3.value, data_3.gas, data_3.isCreation, data_3.data],
   )
-  expect(fromOpaqueData(opaqueData_3)).toEqual(data_3)
+  expect(opaqueDataToDepositData(opaqueData_3)).toEqual(data_3)
 
   const data_4 = {
     mint: 0n,
@@ -53,7 +53,7 @@ test('default', () => {
     ['uint', 'uint', 'uint64', 'bool', 'bytes'],
     [data_4.mint, data_4.value, data_4.gas, data_4.isCreation, data_4.data],
   )
-  expect(fromOpaqueData(opaqueData_4)).toEqual(data_4)
+  expect(opaqueDataToDepositData(opaqueData_4)).toEqual(data_4)
 
   const data_5 = {
     mint: 0n,
@@ -66,7 +66,7 @@ test('default', () => {
     ['uint', 'uint', 'uint64', 'bool', 'bytes'],
     [data_5.mint, data_5.value, data_5.gas, data_5.isCreation, data_5.data],
   )
-  expect(fromOpaqueData(opaqueData_5)).toEqual(data_5)
+  expect(opaqueDataToDepositData(opaqueData_5)).toEqual(data_5)
 
   const data_6 = {
     mint: 0n,
@@ -79,5 +79,5 @@ test('default', () => {
     ['uint', 'uint', 'uint64', 'bool', 'bytes'],
     [data_6.mint, data_6.value, data_6.gas, data_6.isCreation, data_6.data],
   )
-  expect(fromOpaqueData(opaqueData_6)).toEqual(data_6)
+  expect(opaqueDataToDepositData(opaqueData_6)).toEqual(data_6)
 })
diff --git a/src/chains/opStack/utils/fromOpaqueData.ts → .../opStack/utils/opaqueDataToDepositData.ts b/src/chains/opStack/utils/fromOpaqueData.ts → .../opStack/utils/opaqueDataToDepositData.ts
@@ -4,19 +4,24 @@ import { type SizeErrorType, size } from '../../../utils/data/size.js'
 import { type SliceErrorType, slice } from '../../../utils/data/slice.js'
 import { hexToBigInt } from '../../../utils/encoding/fromHex.js'
 
-export type FromOpaqueDataParameters = Hex
+export type OpaqueDataToDepositDataParameters = Hex
 
-export type FromOpaqueDataReturnType = {
+export type OpaqueDataToDepositDataReturnType = {
   mint: bigint
   value: bigint
   gas: bigint
   isCreation: boolean
   data: Hex
 }
 
-export type FromOpaqueDataErrorType = SliceErrorType | SizeErrorType | ErrorType
+export type OpaqueDataToDepositDataErrorType =
+  | SliceErrorType
+  | SizeErrorType
+  | ErrorType
 
-export function fromOpaqueData(opaqueData: Hex): FromOpaqueDataReturnType {
+export function opaqueDataToDepositData(
+  opaqueData: Hex,
+): OpaqueDataToDepositDataReturnType {
   let offset = 0
   const mint = slice(opaqueData, offset, offset + 32)
   offset += 32