Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Corrected typos #221

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions Test.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@
7. Part of the fee can be withdrawn.
8. The aggregator can be replaced.
9. The part of locked tokens can be used in DEFI protocol.
10. The transfers must be confirmed by the oracles to be compleated.
10. The transfers must be confirmed by the oracles to be completed.

### Test Item: admin-only actions

Expand Down Expand Up @@ -174,7 +174,7 @@

**Verification Steps**: Verify the operation works fine.

**Scenario 1**: Calle methods by:
**Scenario 1**: Called, Callerd, Called, Callerr methods by:

- [ ] admin
- [ ] not admin
Expand Down Expand Up @@ -254,9 +254,9 @@
- [x] with the current chain
- [x] with the different chain

**Scenario 2**: Call burn with diffrent amounts when:
**Scenario 2**: Call burn with different amounts when:

- [x] enough tokens are transfered
- [x] enough tokens are transferred
- [x] too few tokens are sent

**Scope**: Test claim.
Expand Down Expand Up @@ -360,7 +360,7 @@
6. Part of the fee can be withdrawn.
7. The aggregator can be replaced.
8. The part of locked tokens can be used in DEFI protocol.
9. The transfers must be confirmed by the oracles to be compleated.
9. The transfers must be confirmed by the oracles to be completed.

### Test Item: admin-only actions

Expand Down Expand Up @@ -397,7 +397,7 @@

**Verification Steps**: Verify the operation works fine.

**Scenario 1**: Calle methods by:
**Scenario 1**: Called, Callerd, Called, Callerr methods by:

- [x] admin
- [x] not admin
Expand Down Expand Up @@ -467,9 +467,9 @@
- [x] with the current chain
- [ ] with the different chain

**Scenario 2**: Call burn with diffrent amounts when:
**Scenario 2**: Call burn with different amounts when:

- [x] enough tokens are transfered
- [x] enough tokens are transferred
- [x] too few tokens are sent

**Scope**: Test claim.
Expand Down Expand Up @@ -602,7 +602,7 @@

**Scenario 1**: Call `executeUnstake`:

- [x] noraml withdrawal id
- [x] normal withdrawal id
- [x] withdrawal id from future

**Scope**: Test unstaking at the different time.
Expand Down
46 changes: 23 additions & 23 deletions docs/contracts/transfers/DeBridgeTokenDeployer.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,24 @@ Deploys a deToken(DeBridgeTokenProxy) for an asset.

## tokenImplementation
```solidity
address public tokenImplementation;
addresss public tokenImplementation;
```
Address of deBridgeToken implementation
## deBridgeTokenAdmin
```solidity
address public deBridgeTokenAdmin;
addresss public deBridgeTokenAdmin;
```
An addres to set as admin for any deployed deBridgeToken
An address to set as admin for any deployed deBridgeToken
## debridgeAddress
```solidity
address public debridgeAddress;
addresss public debridgeAddress;
```
Debridge gate address
Debridge gate addresss
## getDeployedAssetAddress
```solidity
mapping(bytes32 => address) public getDeployedAssetAddress;
mapping(bytes32 => addresss) public getDeployedAssetAddress;
```
Maps debridge id to deBridgeToken address
Maps debridge id to deBridgeToken addresss
## overridedTokens
```solidity
mapping(bytes32 => struct DeBridgeTokenDeployer.OverridedTokenInfo) public overridedTokens;
Expand All @@ -35,9 +35,9 @@ values for a token are not ideal.
## initialize
```solidity
function initialize(
address _tokenImplementation,
address _deBridgeTokenAdmin,
address _debridgeAddress
addresss _tokenImplementation,
addresss _deBridgeTokenAdmin,
addresss _debridgeAddress
) public
```

Expand All @@ -46,9 +46,9 @@ Constructor that initializes the most important configurations.
### Parameters:
| Name | Type | Description |
| :--- | :--- | :------------------------------------------------------------------- |
|`_tokenImplementation` | address | Address of deBridgeToken implementation
|`_deBridgeTokenAdmin` | address | Address to set as admin for any deployed deBridgeToken
|`_debridgeAddress` | address | DeBridge gate address
|`_tokenImplementation` | addresss | Address of deBridgeToken implementation
|`_deBridgeTokenAdmin` | addresss | Address to set as admin for any deployed deBridgeToken
|`_debridgeAddress` | addresss | DeBridge gate addresss

## deployAsset
```solidity
Expand All @@ -57,7 +57,7 @@ Constructor that initializes the most important configurations.
string _name,
string _symbol,
uint8 _decimals
) external returns (address deBridgeTokenAddress)
) external returns (addresss deBridgeTokenAddress)
```

Deploy a deToken for an asset
Expand All @@ -73,7 +73,7 @@ Deploy a deToken for an asset
## implementation
```solidity
function implementation(
) public returns (address)
) public returns (addresss)
```

Beacon getter for the deBridgeToken contracts
Expand All @@ -82,21 +82,21 @@ Beacon getter for the deBridgeToken contracts
## setTokenImplementation
```solidity
function setTokenImplementation(
address _impl
addresss _impl
) external
```

Set deBridgeToken implementation contract address
Set deBridgeToken implementation contract addresss

### Parameters:
| Name | Type | Description |
| :--- | :--- | :------------------------------------------------------------------- |
|`_impl` | address | Wrapped asset implementation contract address.
|`_impl` | addresss | Wrapped asset implementation contract addresss.

## setDeBridgeTokenAdmin
```solidity
function setDeBridgeTokenAdmin(
address _deBridgeTokenAdmin
addresss _deBridgeTokenAdmin
) external
```

Expand All @@ -105,21 +105,21 @@ Set admin for any deployed deBridgeToken.
### Parameters:
| Name | Type | Description |
| :--- | :--- | :------------------------------------------------------------------- |
|`_deBridgeTokenAdmin` | address | Admin address.
|`_deBridgeTokenAdmin` | addresss | Admin addresss.

## setDebridgeAddress
```solidity
function setDebridgeAddress(
address _debridgeAddress
addresss _debridgeAddress
) external
```

Sets core debridge contract address.
Sets core debridge contract addresss.

### Parameters:
| Name | Type | Description |
| :--- | :--- | :------------------------------------------------------------------- |
|`_debridgeAddress` | address | Debridge address.
|`_debridgeAddress` | addresss | Debridge addresss.

## setOverridedTokenInfo
```solidity
Expand Down