Create Bridge readme with run steps #688
Conversation
Co-authored-by: Andy Golay <andygolay@gmail.com>
| Verify this by running: | ||
| ``` | ||
| movement account list --account 0xf7c46960ef7aa1b25cd5d48efef064525aa4ccec286fc3b3a7176bbfec09b84c | ||
| ``` |
There was a problem hiding this comment.
Maybe here add something like:
Note: this step requires Movement CLI initialized to the following endpoints.
You can initialize with movement init --skip-faucet. When prompted, enter custom network and the following REST endpoint:
https://testnet.movementnetwork.xyz
Your config.yaml should look like:
profiles:
default:
network: Custom
private_key: "<your-private-key>"
public_key: "<your-public-key>"
account: "<your-account-address>"
rest_url: "https://testnet.movementnetwork.xyz/"
To fund your account, visit the faucet UI at and select Movement.
0xmovses
changed the title
once network is defo up and stable
| movement account list --account 0xf7c46960ef7aa1b25cd5d48efef064525aa4ccec286fc3b3a7176bbfec09b84c | ||
| ``` | ||
| ## Running the Atomic Bridge Relayer In Production | ||
| The atomic bridge relayer services requires a `config.json` at the root of the application inside a `./movement` |
There was a problem hiding this comment.
The path to the bridge config file is .movement/bridge. The config file in .movement is the suzuka node one. I made 2 separate config files because I didn't find how to mix both without mixing the Rust struct.
| "mvt_init_network": "custom" | ||
| }, | ||
| "testing": { | ||
| "eth_well_known_account_private_keys": [ |
There was a problem hiding this comment.
The eth_well_known_account_private_keys field must be empty. It's only use for testing purpose. You can put an empty vec.
| --args 0x1234 676d6f7665 \ | ||
| --profile default | ||
| ``` | ||
| You'll notice that the args in the module are of type `vec<u8>`, so you have to correctly convert any string into its hex representation. |
There was a problem hiding this comment.
Not clear. The arg is a 0x string, not a Vec<u8>. I would say that to fill the args parameters, the preimage that is a 32 bytes array should be encoded in a 0x string using xxd for example.
|
|
||
| ## Bridging MOVE from Ethereum to Movement without a UI | ||
|
|
||
| First we need to create the `preimage` or secret, for the transfer. |
There was a problem hiding this comment.
You can add: This preimage is an arbitrary array of 32 bytes. For each transfer, the premiage should be regenerated and be unique.
to describe what is a preimage.
| ``` | ||
| The relayer will now call functions on the movement atomic bridge contract. You can inspect the logs of the service to see its progress. | ||
|
|
||
| Copy the `BridgeTransferId` in the logs. |
There was a problem hiding this comment.
It's not very clear how you get the bridge transfer Id from the logs. Perhaps you should add which part of the logs to copy.
Summary
Creates a readme describing how to run the bridge and manual steps to test it outside of the e2e tests. This allows manual testing without the need of the frontend UI.
Changelog
protocol-units/bridge.Testing
Try out the commands :)
Outstanding issues
New contract deployments will happen, README's should be updated.