Skip to content

Commit

Permalink
add some docs in en and ja
Browse files Browse the repository at this point in the history
  • Loading branch information
thurendous committed Sep 18, 2024
1 parent e058f67 commit 734cba1
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 3 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -455,3 +455,13 @@ y: burnedToken

- [Foundry Book](https://book.getfoundry.sh/)
- [OpenZeppelin](https://docs.openzeppelin.com/)

## Some notes for Dev

1. All contracts must be deployed. After that we can connect it from the web2 side.
1. What Phase 1 looks like is as the image below.
2. The main function which needs to be called by relayer on behalf of the user is the `exchange()` function.
1. In order to call it, the user needs to generate its own signature by signing with his private keys.
2. The trusted relayer will then call the function with the signed message. Gas fee will be paid by the relayer instead of the user.
3. Some of the data is stored in the contract in nature. But the dev can decide if they want to store the data also in DB or not.
4. Some accounts with special roles are initialized in the contract in the beginning. Needless to say, the roles are supposed to be handled very carefully.
19 changes: 17 additions & 2 deletions readmeInJa.md
Original file line number Diff line number Diff line change
Expand Up @@ -456,6 +456,21 @@ y: バーンされたトークン
- [Foundry Book](https://book.getfoundry.sh/)
- [OpenZeppelin](https://docs.openzeppelin.com/)

```
## 開発者向けの注意事項

```
1. すべてのコントラクトはデプロイされる必要があります。その後、Web2 側から接続することができます。

1. phase 1 では、下記画像にあるようになります。

1. ユーザーに代わってリレーヤーが呼び出す必要がある主要な関数は`exchange()`関数です。

1. この関数を呼び出すために、ユーザーは自身の秘密鍵で署名して独自の署名を生成する必要があります。
2. 信頼されたリレーヤーは、署名されたメッセージを使用してこの関数を呼び出します。ガス代はリレーやーが負担します。

1. 一部のデータはオンチェーンのコントラクトに保存されます。ただし、開発者はこのデータをデータベースにも保存するかどうかを決定できます。二重管理もやむを得ず可能になったりすると考えています。

1. 特別な役割を持つ一部のアカウントは、最初にコントラクト内で初期化されます。言うまでもありませんが、これらのアカウントは慎重に扱われるべきです。

<div style="text-align: center;">
<img src="./images/phaseOneImage.png" alt="フェーズ1" width="80%"/>
</div>
1 change: 0 additions & 1 deletion script/DeployContracts.s.sol
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,6 @@ contract DeployContracts is Script {
});
}


// deploy the contracts on the base sepolia network for testing
function deploymentsOnBaseSepilia() public returns (DeploymentResult memory) {
admin = vm.addr(vm.envUint("PRIVATE_KEY_ADMIN"));
Expand Down

0 comments on commit 734cba1

Please sign in to comment.