Skip to content
This repository has been archived by the owner on Dec 4, 2024. It is now read-only.

Commit

Permalink
edits during review
Browse files Browse the repository at this point in the history
  • Loading branch information
kmurphypolygon committed Dec 1, 2023
1 parent 1dc2e9a commit a0c8cd0
Show file tree
Hide file tree
Showing 9 changed files with 26 additions and 281 deletions.
2 changes: 2 additions & 0 deletions wiki-docs/docs/api/json-rpc-debug.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ Executes all transactions in the block specified by number with a tracer and ret
+ <b> disableStorage: Boolean </b> - (optional, default: false) The flag indicating disabling storage capture.
+ <b> enableReturnData: Boolean </b> - (optional, default: false) The flag indicating enabling return data capture.
+ <b> timeOut: String </b> - (optional, default: "5s") The timeout for cancellation of execution.
+ <b> tracer: String </b> - (default: "structTracer") Defines the debug tracer used for given call. Supported values: structTracer, callTracer.


### Returns

Expand Down
118 changes: 0 additions & 118 deletions wiki-docs/docs/contracts/validator-queue.md

This file was deleted.

23 changes: 2 additions & 21 deletions wiki-docs/docs/interfaces/erc20/childerc20-predicate.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,31 +18,12 @@ function initialize(
address newStateReceiver,
address newRootERC20Predicate,
address newChildTokenTemplate,
address newNativeTokenRootAddress,
string calldata newNativeTokenName,
string calldata newNativeTokenSymbol,
uint8 newNativeTokenDecimals
) external;
address newNativeTokenRootAddress
) public virtual onlySystemCall initializer {
```

The parameters for initialization include the addresses of the L2 state sender, the state receiver, the root ERC20 predicate, and the child token template. The initialization also requires the native token's root address, name, symbol, and decimals.

## Deploy a new child token

To create a new child token on the L2 side, call the deployChildToken method:

```solidity
function deployChildToken(
address rootToken,
bytes32 salt,
string calldata name,
string calldata symbol,
uint8 decimals
) external;
```

The parameters for deploying a new child token include the address of the corresponding root token on L1, a unique salt value, and the token's name, symbol, and decimals.

## Process state updates

The onStateReceive method receives state updates from the L1 side and processes the data accordingly:
Expand Down
1 change: 1 addition & 0 deletions wiki-docs/docs/interfaces/erc20/native-erc20.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ This function sets the values for the predicate, rootToken, name, symbol, and de
- `name_` (string): The token's name.
- `symbol_` (string): The token's symbol.
- `decimals_` (uint8): The number of decimals for the token.
- `tokenSupply_` (uint256): Initial total supply of token.

#### Usage

Expand Down
8 changes: 4 additions & 4 deletions wiki-docs/docs/interfaces/network/exit-helper.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ This function allows you to perform a batch exit for multiple events.
#### Parameters

- `inputs` (BatchExitInput[]): An array of BatchExitInput structs, where each struct contains the following fields:
- `blockNumber` (uint256): The block number of the exit event on L2.
- `leafIndex` (uint256): The leaf index in the exit event Merkle tree.
- `unhashedLeaf` (bytes): The ABI-encoded exit event leaf.
- `proof` (bytes32[]): The proof of the event inclusion in the tree.
- `blockNumber` (uint256): The block number of the exit event on L2.
- `leafIndex` (uint256): The leaf index in the exit event Merkle tree.
- `unhashedLeaf` (bytes): The ABI-encoded exit event leaf.
- `proof` (bytes32[]): The proof of the event inclusion in the tree.

#### Usage

Expand Down
73 changes: 0 additions & 73 deletions wiki-docs/docs/interfaces/validators/root-validator-set.md

This file was deleted.

45 changes: 0 additions & 45 deletions wiki-docs/docs/interfaces/validators/validators.md

This file was deleted.

18 changes: 9 additions & 9 deletions wiki-docs/docs/operate/deploy/staking/stake.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ Each validator needs to perform initial staking on the rootchain `StakeManager`
<details>
<summary>Flags ↓</summary>

| Flag | Description | Example |
| -----------------------------| -------------------------------------------------- | ---------------------------------------- |
| `--amount ` | The amount to stake | `--amount 5000000000000000000` |
| `--chain-id` | The ID of the child chain | `--chain-id 100` |
| `--config ` | The path to the SecretsManager config file | `--config /path/to/config/file.yaml` |
| `--data-dir` | The directory for the Polygon Edge data | `--data-dir ./polygon-edge/data` |
| `--jsonrpc` | The JSON-RPC interface | `--jsonrpc 0.0.0.0:8545` |
| `--native-root-token ` | The address of the native root token | `--native-root-token 0x<token_address>` |
| `--stake-manager` | The address of the stake manager contract | `--stake-manager 0x<manager_address>` |
|| Flag | Description | Example |
| -----------------------------| --------------------------------------------------------------------------------- | ---------------------------------------- |
| `--amount ` | The amount to stake | `--amount 5000000000000000000` |
| `--supernet-id` | The ID of the supernet provided by stake manager on supernet registration | `--chain-id 100` |
| `--config ` | The path to the SecretsManager config file | `--config /path/to/config/file.yaml` |
| `--data-dir` | The directory for the Polygon Edge data | `--data-dir ./polygon-edge/data` |
| `--jsonrpc` | The JSON-RPC interface | `--jsonrpc 0.0.0.0:8545` |
| `--stake-token ` | The address of ERC20 Token used for staking on rootchain | `--native-root-token 0x<token_address>` |
| `--stake-manager` | The address of the stake manager contract | `--stake-manager 0x<manager_address>` |

</details>

Expand Down
19 changes: 8 additions & 11 deletions wiki-docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,15 +57,14 @@ nav:
- Upgrade using hardfork: operate/deploy/upgrades/hardfork.md
- Edge v1.1 upgrade requirements: operate/deploy/upgrades/v1.1.md
- Reference:
- Contracts:
- Checkpoint manager: contracts/checkpoint-manager.md
- Exit helper: contracts/exit-helper.md
- Reward pool: contracts/reward-pool.md
- State receiver: contracts/state-receiver.md
- State sender: contracts/state-sender.md
- Validator queue: contracts/validator-queue.md
- Validator set: contracts/validator-set.md
- Withdrawal queue: contracts/withdrawal-queue.md
#- Contracts:
# - Checkpoint manager: contracts/checkpoint-manager.md
# - Exit helper: contracts/exit-helper.md
# - Reward pool: contracts/reward-pool.md
# - State receiver: contracts/state-receiver.md
# - State sender: contracts/state-sender.md
# - Validator set: contracts/validator-set.md
# - Withdrawal queue: contracts/withdrawal-queue.md
- Config parameter reference: operate/param-reference.md
- Smart contract interfaces:
- ERC20:
Expand All @@ -88,9 +87,7 @@ nav:
- StateReceiver: interfaces/network/state-receiver.md
- StateSender: interfaces/network/state-sender.md
- Validators:
- Validator: interfaces/validators/validators.md
- ValidatorSetBase: interfaces/validators/validator-set-base.md
- RootValidatorSet: interfaces/validators/root-validator-set.md
- Staking:
- StakeManager: interfaces/staking/stake-manager.md
- SupernetManager: interfaces/staking/supernet-manager.md
Expand Down

0 comments on commit a0c8cd0

Please sign in to comment.