chore: renames L1ToL2Message to parentChain/Chain

scripts/testSetup.ts

@@ -22,10 +22,10 @@ import { Wallet } from '@ethersproject/wallet'
 import dotenv from 'dotenv'
 import { EthBridger, InboxTools, Erc20Bridger } from '../src'
 import {
-  ParentChain as L1Network,
-  ChildChain as L2Network,
-  getParentChain as getL1Network,
-  getChildChain as getL2Network,
+  ParentChain,
+  ChildChain,
+  getParentChain,
+  getChildChain,
   addCustomNetwork,
 } from '../src/lib/dataEntities/networks'
 import { Signer } from 'ethers'
@@ -70,8 +70,8 @@ export const getCustomNetworks = async (
   l1Url: string,
   l2Url: string
 ): Promise<{
-  l1Network: L1Network
-  l2Network: Omit<L2Network, 'tokenBridge'>
+  l1Network: ParentChain
+  l2Network: Omit<ChildChain, 'tokenBridge'>
 }> => {
   const l1Provider = new JsonRpcProvider(l1Url)
   const l2Provider = new JsonRpcProvider(l2Url)
@@ -98,7 +98,7 @@ export const getCustomNetworks = async (
   const l1NetworkInfo = await l1Provider.getNetwork()
   const l2NetworkInfo = await l2Provider.getNetwork()
 
-  const l1Network: L1Network = {
+  const l1Network: ParentChain = {
     blockTime: 10,
     chainID: l1NetworkInfo.chainId,
     explorerUrl: '',
@@ -108,7 +108,7 @@ export const getCustomNetworks = async (
     isArbitrum: false,
   }
 
-  const l2Network: Omit<L2Network, 'tokenBridge'> = {
+  const l2Network: Omit<ChildChain, 'tokenBridge'> = {
     chainID: l2NetworkInfo.chainId,
     confirmPeriodBlocks: confirmPeriodBlocks.toNumber(),
     ethBridge: {
@@ -149,7 +149,7 @@ export const setupNetworks = async (
     l2Deployer,
     coreL2Network.ethBridge.inbox
   )
-  const l2Network: L2Network = {
+  const l2Network: ChildChain = {
     ...coreL2Network,
     tokenBridge: {
       l1CustomGateway: l1Contracts.customGateway.address,
@@ -204,8 +204,8 @@ export const getSigner = (provider: JsonRpcProvider, key?: string) => {
 }
 
 export const testSetup = async (): Promise<{
-  l1Network: L1Network
-  l2Network: L2Network
+  l1Network: ParentChain
+  l2Network: ChildChain
   l1Signer: Signer
   l2Signer: Signer
   erc20Bridger: Erc20Bridger
@@ -225,10 +225,10 @@ export const testSetup = async (): Promise<{
   const l1Signer = seed.connect(ethProvider)
   const l2Signer = seed.connect(arbProvider)
 
-  let setL1Network: L1Network, setL2Network: L2Network
+  let setL1Network: ParentChain, setL2Network: ChildChain
   try {
-    const l1Network = await getL1Network(l1Deployer)
-    const l2Network = await getL2Network(l2Deployer)
+    const l1Network = await getParentChain(l1Deployer)
+    const l2Network = await getChildChain(l2Deployer)
     setL1Network = l1Network
     setL2Network = l2Network
   } catch (err) {
@@ -240,8 +240,8 @@ export const testSetup = async (): Promise<{
       const { l1Network, l2Network } = JSON.parse(
         fs.readFileSync(localNetworkFile).toString()
       ) as {
-        l1Network: L1Network
-        l2Network: L2Network
+        l1Network: ParentChain
+        l2Network: ChildChain
       }
       addCustomNetwork({
         customParentChain: l1Network,

src/index.ts

@@ -32,12 +32,12 @@ export {
   L1TransactionReceipt,
 } from './lib/message/L1Transaction'
 export {
-  L1ToL2MessageStatus,
+  ParentToChildMessageStatus as L1ToL2MessageStatus,
   EthDepositStatus,
-  L1ToL2Message,
-  L1ToL2MessageReader,
-  L1ToL2MessageReaderClassic,
-  L1ToL2MessageWriter,
+  ParentToChildMessage as L1ToL2Message,
+  ParentToChildMessageReader as L1ToL2MessageReader,
+  ParentToChildMessageReaderClassic as L1ToL2MessageReaderClassic,
+  ParentToChildMessageWriter as L1ToL2MessageWriter,
 } from './lib/message/L1ToL2Message'
 export { L1ToL2MessageGasEstimator } from './lib/message/L1ToL2MessageGasEstimator'
 export { argSerializerConstructor } from './lib/utils/byte_serialize_params'

src/lib/assetBridger/assetBridger.ts

@@ -22,8 +22,8 @@ import { L2ContractTransaction } from '../message/L2Transaction'
 
 import {
   parentChains as l1Networks,
-  ParentChain as L1Network,
   ChildChain as L2Network,
+  ParentChain,
 } from '../dataEntities/networks'
 import {
   SignerOrProvider,
@@ -34,7 +34,7 @@ import {
  * Base for bridging assets from l1 to l2 and back
  */
 export abstract class AssetBridger<DepositParams, WithdrawParams> {
-  public readonly l1Network: L1Network
+  public readonly l1Network: ParentChain
 
   public constructor(public readonly l2Network: L2Network) {
     this.l1Network = l1Networks[l2Network.parentChainId]

src/lib/assetBridger/erc20Bridger.ts

@@ -45,10 +45,7 @@ import {
   L1ToL2MessageGasEstimator,
 } from '../message/L1ToL2MessageGasEstimator'
 import { SignerProviderUtils } from '../dataEntities/signerOrProvider'
-import {
-  ChildChain as L2Network,
-  getChildChain as getL2Network,
-} from '../dataEntities/networks'
+import { ChildChain, getChildChain } from '../dataEntities/networks'
 import { ArbSdkError, MissingProviderArbSdkError } from '../dataEntities/errors'
 import { DISABLED_GATEWAY } from '../dataEntities/constants'
 import { EventFetcher } from '../utils/eventFetcher'
@@ -181,7 +178,7 @@ export class Erc20Bridger extends AssetBridger<
   /**
    * Bridger for moving ERC20 tokens back and forth between L1 to L2
    */
-  public constructor(l2Network: L2Network) {
+  public constructor(l2Network: ChildChain) {
     super(l2Network)
   }
 
@@ -191,7 +188,7 @@ export class Erc20Bridger extends AssetBridger<
    * @returns
    */
   public static async fromProvider(l2Provider: Provider) {
-    return new Erc20Bridger(await getL2Network(l2Provider))
+    return new Erc20Bridger(await getChildChain(l2Provider))
   }
 
   /**

src/lib/assetBridger/ethBridger.ts

@@ -45,7 +45,7 @@ import {
 import { OmitTyped } from '../utils/types'
 import { SignerProviderUtils } from '../dataEntities/signerOrProvider'
 import { MissingProviderArbSdkError } from '../dataEntities/errors'
-import { getChildChain as getL2Network } from '../dataEntities/networks'
+import { getChildChain } from '../dataEntities/networks'
 
 export interface EthWithdrawParams {
   /**
@@ -138,7 +138,7 @@ export class EthBridger extends AssetBridger<
    * @returns
    */
   public static async fromProvider(l2Provider: Provider) {
-    return new EthBridger(await getL2Network(l2Provider))
+    return new EthBridger(await getChildChain(l2Provider))
   }
 
   /**

src/lib/dataEntities/networks.ts

@@ -402,7 +402,18 @@ export const addCustomNetwork = ({
   customParentChain?: ParentChain
   customChildChain: ChildChain
 }): void => {
-  console.log({ customChildChain })
+  //@ts-expect-error - Nitro returns this value with partnerChainID
+  if (customChildChain.partnerChainID) {
+    //@ts-expect-error - Nitro returns this value with partnerChainID
+    customChildChain.parentChainId = customChildChain.partnerChainID
+  }
+
+  //@ts-expect-error - Nitro returns this value with partnerChainID
+  if (customParentChain.partnerChainIDs?.length > 0) {
+    //@ts-expect-error - Nitro returns this value with partnerChainID
+    customParentChain.childChainIds = customParentChain.partnerChainIDs
+  }
+
   if (customParentChain) {
     if (parentChains[customParentChain.chainID]) {
       throw new ArbSdkError(
@@ -429,11 +440,14 @@ export const addCustomNetwork = ({
 
   childChains[customChildChain.chainID] = customChildChain
 
+  console.log({ customChildChain })
+
   const parentChainChildChain = parentChains[customChildChain.parentChainId]
   if (!parentChainChildChain)
     throw new ArbSdkError(
       `Network ${customChildChain.chainID}'s parent chain, ${customChildChain.parentChainId}, not recognized`
     )
+  console.log({ parentChainChildChain })
 
   if (!parentChainChildChain.childChainIds.includes(customChildChain.chainID)) {
     parentChainChildChain.childChainIds.push(customChildChain.chainID)