Skip to content

Commit

Permalink
Update relayer-gas-example.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bucanero committed Jul 25, 2024
1 parent 81e0149 commit d0e47a8
Showing 1 changed file with 17 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,13 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

In this article you'll learn how to run end-to-end tests on the entire Multichain Relayer system.
You'll find two tests available: an integrated test and a manual test.
The [integration test](#integration-test) is the best way to check that all multichain gas relayer systems are working well together.
[Manual testing](#manual-testing) is a good way to debug issues if any individual part of the system isn't working.

## Requirements

Before you start testing, set up your local environment and install the [Relayer server](multichain-server.md), the [Event indexer](https://github.com/near/gas-station-event-indexer) and [NEAR CLI](https://github.com/near/near-cli-rs).

:::info Required tools

Expand All @@ -21,12 +28,12 @@ For this tutorial, you need to have installed:

:::

## Setup

Before you start testing, set up your local environment and install the [Relayer server](multichain-server.md), the [Event indexer](https://github.com/near/gas-station-event-indexer) and [NEAR CLI](https://github.com/near/near-cli-rs).

## Integration test

:::tip
This test is the best way to verify that all multichain gas relayer systems are working well together.
:::

In separate terminals, you need to run the following tools:

1. [Multichain Relayer server](#multichain-relayer-server), with a valid `config.toml` configuration file
Expand Down Expand Up @@ -108,6 +115,10 @@ python3 integration_tests/integration_test.py --verbose

This section offers instructions on how to manually perform end-to-end tests on the entire multichain relayer system including the gas station contract, indexer, and relayer server.

:::tip
This test is a good way to debug issues if any individual part of the system isn't working.
:::
### Test setup
The following instructions are only need to be called once to initialize the account on the Gas Station. Make sure to replace the `<account_id>` (string) with the account you want to initialize and `<token_id>` (integer) with the token id of the NFT you minted in step 2:
Expand Down Expand Up @@ -234,9 +245,9 @@ Python and Rust output different hex RLP encoded transactions.
> **Note:** this step will be updated soon, as support for yield/resume calls is implemented on MPC contract.
7. Watch the output of the [gas station event indexer](#gas-station-event-indexer) to see the transactions being emitted by the gas station contract.
7. Watch the output of the [gas station event indexer](https://github.com/near/gas-station-event-indexer) to see the transactions being emitted by the gas station contract.
8. Watch the output of the [multichain relayer server](#multichain-relayer-server) to see the transactions being sent to the foreign chain.
8. Watch the output of the [multichain relayer server](https://github.com/near/multichain-relayer-server) to see the transactions being sent to the foreign chain.
Expand Down

0 comments on commit d0e47a8

Please sign in to comment.