Skip to content

Commit

Permalink
Merge branch 'main' into 0xoats-prover
Browse files Browse the repository at this point in the history
  • Loading branch information
0xoats authored Nov 10, 2023
2 parents a73fcac + f561a8c commit 10b9150
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 6 deletions.
6 changes: 3 additions & 3 deletions packages/protocol/contracts/actors_privileges_deployments.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Introduction

This document provides a comprehensive overview of the actors involved in the smart contract system and outlines their respective privileges and roles.
Different `roles` (we call them `domain`) are granted via `AddressManager` contract's `setAddress()` function. Idea is very similar Optimism's `AddressManager` except that we use the `chainId + domainName` as the key for a given address. We need so, because for bridging purposes, the destination chain's bridge address needs to be inculded signaling the messgae hash is tamper-proof.
Different `roles` (we call them `domain`) are granted via `AddressManager` contract's `setAddress()` function. Idea is very similar Optimism's `AddressManager` except that we use the `chainId + domainName` as the key for a given address. We need so, because for bridging purposes, the destination chain's bridge address needs to be included signaling the message hash is tamper-proof.
Every contract which needs some role-based authentication, needs to inherit from `AddressResolver` contract, which will serve as a 'middleman/lookup' by querying the `AddressManager` per given address is allowed to act on behalf of that domain or not.

## 1. Domains (≈role per chainId)
Expand All @@ -26,9 +26,9 @@ In the context of the smart contract system, various actors play distinct roles.

### 1.3 ERCXXX_Vault

- **Role**: This role is givne to respective token vault contracts (ERC20, ERC721, ERC1155)
- **Role**: This role is given to respective token vault contracts (ERC20, ERC721, ERC1155)
- **Privileges**:
- Part of token briding, the possibility to burn and mint the respective standard tokens (no autotelic minting/burning)
- Part of token bridging, the possibility to burn and mint the respective standard tokens (no autotelic minting/burning)

## 2. Different access modifiers

Expand Down
2 changes: 1 addition & 1 deletion packages/protocol/contracts/bridge/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ If user wants to bridge ether, he/she will initiate a bridge transaction with `s
address refundAddress;
// value to invoke on the destination chain, for ERC20 transfers.
uint256 value;
// Processing fee for the relayer. Zero if user will process themself.
// Processing fee for the relayer. Zero if user will process themselves.
uint256 fee;
// gasLimit to invoke on the destination chain, for ERC20 transfers.
uint256 gasLimit;
Expand Down
2 changes: 1 addition & 1 deletion packages/protocol/docs/iprover.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,4 @@ The proposer and prover interact off-chain to agree on the price and perform the

3. Proposer creates the `ProverAssignment` struct data (obviously together with the `input` and `txList`) and submits the `proposeBlock()` with the necessary parameters.

During `proposeBlock()` transaction, the `onBlockAssigned()` hook which will evaluate the validity of the prover signature, and if that one is correct then executest he transfer of `10 DAI`.
During `proposeBlock()` transaction, the `onBlockAssigned()` hook which will evaluate the validity of the prover signature, and if that one is correct then execute he transfer of `10 DAI`.
2 changes: 1 addition & 1 deletion packages/website/pages/docs/guides/receive-tokens.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,6 @@ This guide will help you receive testnet tokens. You can see all the deployed to

TTKOj has been distributed to all proposers and provers from the alpha-1 and alpha-2 testnets and you can see those transactions [here](https://sepolia.etherscan.io/address/0x7532Cd98ED13c0C164dBC7a92D872955c8C99bD3). You can see the script used [here](https://github.com/taikoxyz/operations). TTKOj will be distributed to alpha-3/alpha-4 participants very soon :)

Otherwise, you can obtain TTKOj by successfully [proposing blocks](/docs/guides/enable-a-proposer) (the protocol rewards you in TTKOj) or from [Swap](https://swap.jolnir.taiko.xyz).
Otherwise, you can obtain TTKOj by successfully [proposing blocks](/docs/guides/enable-a-proposer) (the protocol rewards you in TTKOj) or from [Swap](https://swap-v3.jolnir.taiko.xyz).

</Steps>
2 changes: 2 additions & 0 deletions packages/website/pages/docs/reference/prover-market-page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,5 @@ You can edit the page by clicking [here](https://github.com/taikoxyz/taiko-mono/
| Karandash33 | http://88.198.47.154:9876 | 10 wei |
| Eustace | http://158.220.98.12:9876 | 10 wei |
| Oats | http://164.92.65.55:9876 | 10 wei |
| Gojo Node | http://167.86.127.224:9876 | 13 wei |
| SandNode | http://161.97.79.184:9876 | 10 wei |

0 comments on commit 10b9150

Please sign in to comment.