Skip to content

Commit

Permalink
fix: small corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
rube-de committed Oct 22, 2024
1 parent 03b6c37 commit f3b7ca2
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 17 deletions.
4 changes: 2 additions & 2 deletions docs/dapp/opl/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,11 @@ keeping their main logic on their primary chain.
:::info

For how to use use signed messages with the GSN to trigger a cross-chain
messages, please visit our [Gasless Transactions chatper].
messages, please visit our [Gasless Transactions chapter].

:::

[Gasless Transactions chatper]: ../sapphire/gasless.md
[Gasless Transactions chapter]: ../sapphire/gasless.md

## Message Bridges

Expand Down
11 changes: 10 additions & 1 deletion docs/dapp/opl/celer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ It performs two main functions:

- Monitors the Celer State Guardian Network (SGN) for messages ready to be
submitted (with sufficient validator signatures).
- Submits message execution transactions to the MessageBus contract.
- Submits message execution transactions to the MessageBus contract on the
destination chain.

It is necessary a [Message Executor] runs for you dapp. To set up an executor,
you have two options
Expand All @@ -70,6 +71,14 @@ In most cases, Celer advises dApp developers to use the shared executor
services provided by the Celer Network team to avoid server configuration and
operation concerns.

:::info

Oasis is running an executor for the Sapphire Testnet, which is okay to rely on
for a test, for a faster execution it's recommended to run your own or use the
hosted service.

:::

[Message Executor]: https://im-docs.celer.network/developer/development-guide/message-executor
[documentation]: https://im-docs.celer.network/developer/development-guide/message-executor/integration-guide
[celer-form]:https://form.typeform.com/to/RsiUR9Xz
Expand Down
5 changes: 2 additions & 3 deletions docs/dapp/opl/celer/ping-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,8 +182,7 @@ ping 0.001 tBNB (1000000 gwei) will be enough.
:::info

For the `Sapphire Testnet` an executor is running to relay the messages every
few mintues. If you deploy on mainnet please refer to the [Executor chapter]
on how to run an executor.
few mintues. If you deploy on mainnet please refer to the [Executor chapter].
:::

[Executor chapter]: ./README.md#executor
Expand All @@ -192,7 +191,7 @@ on how to run an executor.

To see if you successfully send a ping message cross-chain you can watch for
new transactions at the [MessageBus address] from Celer or your deployed
contract Sapphire Testnet
contract Sapphire Testnet.

[MessageBus address]: https://explorer.oasis.io/testnet/sapphire/address/0x9Bb46D5100d2Db4608112026951c9C965b233f4D

Expand Down
2 changes: 1 addition & 1 deletion docs/dapp/opl/opl-sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ After a few minutes the bridge will detect and then the executor will invoke the

As noted in the [fees](#fees) section, an exectuor needs to relay your messages.
Please refer to the Celer [Executor][celer-executor] section on how to get on
the shared Message Executor on Testnet or how to set up your own executor.
the shared Message Executor or how to set up your own executor.

:::

Expand Down
19 changes: 9 additions & 10 deletions docs/dapp/opl/opl-sdk/ping-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,9 +133,9 @@ message which was received.

- `Host`: OPL wrapper for outside contract.
- `Enclave`: OPL wrapper for the contract on Sapphire side.
- `registerEndpoint`: Registers endpoint in an OPL managed map.
- `registerEndpoint`: Registers endpoints in an OPL managed map.
- `postMessage`: Call registered endpoints.
- `autoswitch`: Finds correct gateway address via chain name.
- `autoswitch`: Finds correct MessageBus address via chain name.

## Compiling the Contract

Expand Down Expand Up @@ -167,12 +167,12 @@ of your latest transaction, and then add 1.
- **`chain`**: `0x6273630000000000000000000000000000000000000000000000000000000000`
(bytes encoded `"bsc"`)

6. Deploy the contract on Sapphire Testnet
6. Deploy the contract on `Sapphire Testnet`

:::info

Copy the address of the deployed contract, you'll need it for the next step and
Remix will remove the contract if you change the chain.
Copy the address of the deployed contract, you'll need it for the next step as
Remix will remove the contract from the UI if you change the chain.

:::

Expand All @@ -185,7 +185,7 @@ Remix will remove the contract if you change the chain.
2. In MetaMask, switch to the `BSC Testnet` network and select
`Injected Provider - MetaMask` as the environment in Remix.
3. Select the `Ping.sol` contract.
4. Fill in your contract addess you just have deployed on `Sapphire Testnet`.
4. Fill in the contract addess you just have deployed on `Sapphire Testnet`.
5. Deploy the contract on `BSC Testnet`.

[BNB faucet]: https://www.bnbchain.org/en/testnet-faucet
Expand All @@ -200,16 +200,15 @@ You'll need the following parameter for `startPing`:
- `_message`: The encoded message. e.g. "Hello from BSC" -
`0x48656c6c6f2066726f6d20425343000000000000000000000000000000000000`.

Additionally you'll have to pay a fee which you send as value. For sending the
Additionally you'll have to pay a fee which you send as `value`. For sending the
ping 0.001 tBNB (1000000 gwei) will be enough.

Finally execute the function `startPing`.

:::info

For the `Sapphire Testnet` an executor is running to relay the messages every
few mintues. If you deploy on mainnet please refer to the [Executor chapter]
on how to run an executor.
few mintues. If you deploy on mainnet please refer to the [Executor chapter].
:::

[Executor chapter]: ../celer/README.md#executor
Expand All @@ -218,7 +217,7 @@ on how to run an executor.

To see if you successfully send a ping message cross-chain you can watch for
new transactions at the [MessageBus address] from Celer or your deployed
contract Sapphire Testnet
contract on `Sapphire Testnet`.

[MessageBus address]: https://explorer.oasis.io/testnet/sapphire/address/0x9Bb46D5100d2Db4608112026951c9C965b233f4D

Expand Down

0 comments on commit f3b7ca2

Please sign in to comment.