From d5a14f94688cdf5e5acd19dcf543a1d37b3c6b4d Mon Sep 17 00:00:00 2001 From: Dmytrol <46675332+Dimitrolito@users.noreply.github.com> Date: Mon, 16 Dec 2024 12:00:29 +0200 Subject: [PATCH 1/2] typos README.md Signed-off-by: Dmytrol <46675332+Dimitrolito@users.noreply.github.com> --- bridge-ui/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bridge-ui/README.md b/bridge-ui/README.md index 9c5ad4316..b364761dd 100644 --- a/bridge-ui/README.md +++ b/bridge-ui/README.md @@ -128,7 +128,7 @@ docker run -p 3000:3000 linea/bridge-ui Frontend should be available at: http://localhost:3000 -### End to end tests +### End-to-end tests E2E tests are run in the CI but can also be run locally. Make sure `E2E_TEST_PRIVATE_KEY` .env (The private key used needs to have some sepolia ETH, USDC and WETH to run the tests) From 8a1efcce637890d931f2e9604707bdd4fb0bb454 Mon Sep 17 00:00:00 2001 From: Dmytrol <46675332+Dimitrolito@users.noreply.github.com> Date: Mon, 16 Dec 2024 12:01:19 +0200 Subject: [PATCH 2/2] typos README.md Signed-off-by: Dmytrol <46675332+Dimitrolito@users.noreply.github.com> --- contracts/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/contracts/README.md b/contracts/README.md index efa4eed77..051fdb5a6 100644 --- a/contracts/README.md +++ b/contracts/README.md @@ -91,7 +91,7 @@ If the stack is *already running*, to redeploy the contracts, the following comm Note: The addresses change per deployment due to nonce increments, so be sure to validate the correct ones are being used. -**NB:** The end to end tests run against a fresh stack and deploy with predetermined addresses. +**NB:** The end-to-end tests run against a fresh stack and deploy with predetermined addresses. If there is a need to get predetermined addresses for contract deployments, the following script can be used [precomputeDeployedAddresses.ts](./scripts/operational/precomputeDeployedAddress.ts). @@ -112,7 +112,7 @@ The L2MessageService deploy uses nonce 2 as the following are deployed beforehan **Deploying the L1 contracts** ``` # This will deploy the Linea Rollup that is currently deployed on Mainnet - the current version is the LineaRollupV5. -# Some end to end tests will test future upgrades to validate the stack remains functional. +# Some end-to-end tests will test future upgrades to validate the stack remains functional. # Note: By default a test/placeholder verifier contract is used `IntegrationTestTrueVerifier` if you wish to use a proper verifier, adjust the # PLONKVERIFIER_NAME=IntegrationTestTrueVerifier in the make command to be something like PLONKVERIFIER_NAME=PlonkVerifierForDataAggregation . @@ -131,7 +131,7 @@ make deploy-token-bridge-l1 **Deploying the L2 contracts** ``` # This will deploy the current L2 Message Service. -# Some end to end tests will test future upgrades to validate the stack remains functional. +# Some end-to-end tests will test future upgrades to validate the stack remains functional. make deploy-l2messageservice @@ -152,7 +152,7 @@ The above command will trigger the following commands to deploy: - deploy-token-bridge-l2 - deploy-l2-test-erc20 -Note: the deploy-l1-test-erc20 and deploy-l2-test-erc20 commands are executed for use in the end to end tests. +Note: the deploy-l1-test-erc20 and deploy-l2-test-erc20 commands are executed for use in the end-to-end tests. ## Installation and testing @@ -167,4 +167,4 @@ pnpm run test pnpm run test:reportgas pnpm run coverage -``` \ No newline at end of file +```