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.

Sign up for GitHub

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

Jump to bottom

Document PE Bounty and Bond Design #702

Merged
merged 19 commits into from
Oct 23, 2020
Merged

Document PE Bounty and Bond Design #702

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
81f088a
add bounty doc
souradeep-das Sep 1, 2020
c4affe4
Merge branch 'v2.0.0' into docs
souradeep-das Sep 1, 2020
26fe971
Merge branch 'v2.0.0' into docs
souradeep-das Sep 28, 2020
b509be6
docs: simplify bond and bounty
souradeep-das Sep 28, 2020
9f83f2f
docs: minor changes
souradeep-das Sep 28, 2020
c2899fe
Update plasma_framework/docs/design/exit_bond_and_bounty_mechanics.md
kevsul Sep 29, 2020
96cc0dd
Update plasma_framework/docs/design/exit_bond_and_bounty_mechanics.md
kevsul Sep 29, 2020
f5ee026
Update plasma_framework/docs/design/exit_bond_and_bounty_mechanics.md
kevsul Sep 29, 2020
6564c81
Apply suggestions from code review
souradeep-das Sep 30, 2020
572cdf1
docs: rephrase non-exitable
souradeep-das Sep 30, 2020
980bbd0
Apply suggestions from code review
souradeep-das Oct 9, 2020
11eb36b
Merge branch 'v2.0.0' into docs
souradeep-das Oct 19, 2020
fd552d3
docs: rename person to user
souradeep-das Oct 19, 2020
b72d4d5
Update plasma_framework/docs/design/exit_bond_and_bounty_mechanics.md
souradeep-das Oct 22, 2020
ddcb22f
docs: stack exits
souradeep-das Oct 22, 2020
0cb33b7
Update plasma_framework/docs/design/exit_bond_and_bounty_mechanics.md
souradeep-das Oct 23, 2020
7b4eaa4
docs: replace with constant for ife bounty
souradeep-das Oct 23, 2020
c92fde7
Merge branch 'v2.0.0' into docs
souradeep-das Oct 23, 2020
fca7c32
docs: solidoc
souradeep-das Oct 23, 2020
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
1 change: 0 additions & 1 deletion plasma_framework/docs/contracts/Address.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ returns(bool)
* [EthDepositVerifier](EthDepositVerifier.md)
* [EthVault](EthVault.md)
* [ExitableTimestamp](ExitableTimestamp.md)
* [ExitBounty](ExitBounty.md)
* [ExitGameController](ExitGameController.md)
* [ExitGameRegistry](ExitGameRegistry.md)
* [ExitId](ExitId.md)
Expand Down
1 change: 0 additions & 1 deletion plasma_framework/docs/contracts/Bits.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,6 @@ True, if the bit is '0'; otherwise, False
* [EthDepositVerifier](EthDepositVerifier.md)
* [EthVault](EthVault.md)
* [ExitableTimestamp](ExitableTimestamp.md)
* [ExitBounty](ExitBounty.md)
* [ExitGameController](ExitGameController.md)
* [ExitGameRegistry](ExitGameRegistry.md)
* [ExitId](ExitId.md)
Expand Down
1 change: 0 additions & 1 deletion plasma_framework/docs/contracts/BlockController.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,6 @@ returns(bool)
* [EthDepositVerifier](EthDepositVerifier.md)
* [EthVault](EthVault.md)
* [ExitableTimestamp](ExitableTimestamp.md)
* [ExitBounty](ExitBounty.md)
* [ExitGameController](ExitGameController.md)
* [ExitGameRegistry](ExitGameRegistry.md)
* [ExitId](ExitId.md)
Expand Down
1 change: 0 additions & 1 deletion plasma_framework/docs/contracts/BlockModel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ struct Block {
* [EthDepositVerifier](EthDepositVerifier.md)
* [EthVault](EthVault.md)
* [ExitableTimestamp](ExitableTimestamp.md)
* [ExitBounty](ExitBounty.md)
* [ExitGameController](ExitGameController.md)
* [ExitGameRegistry](ExitGameRegistry.md)
* [ExitId](ExitId.md)
Expand Down
34 changes: 27 additions & 7 deletions plasma_framework/docs/contracts/BondSize.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ Stores an updateable bond size
struct Params {
uint128 previousBondSize,
uint128 updatedBondSize,
uint128 previousExitBountySize,
uint128 updatedExitBountySize,
uint128 effectiveUpdateTime,
uint16 lowerBoundDivisor,
uint16 upperBoundMultiplier
Expand All @@ -29,15 +31,16 @@ uint64 public constant WAITING_PERIOD;

## Functions

- [buildParams(uint128 initialBondSize, uint16 lowerBoundDivisor, uint16 upperBoundMultiplier)](#buildparams)
- [updateBondSize(struct BondSize.Params self, uint128 newBondSize)](#updatebondsize)
- [buildParams(uint128 initialBondSize, uint128 initialExitBountySize, uint16 lowerBoundDivisor, uint16 upperBoundMultiplier)](#buildparams)
- [updateBondSize(struct BondSize.Params self, uint128 newBondSize, uint128 newExitBountySize)](#updatebondsize)
- [bondSize(struct BondSize.Params self)](#bondsize)
- [validateBondSize(struct BondSize.Params self, uint128 newBondSize)](#validatebondsize)
- [exitBountySize(struct BondSize.Params self)](#exitbountysize)
- [validateBondSize(struct BondSize.Params self, uint128 newBondSize, uint128 newExitBountySize)](#validatebondsize)

### buildParams

```js
function buildParams(uint128 initialBondSize, uint16 lowerBoundDivisor, uint16 upperBoundMultiplier) internal pure
function buildParams(uint128 initialBondSize, uint128 initialExitBountySize, uint16 lowerBoundDivisor, uint16 upperBoundMultiplier) internal pure
returns(struct BondSize.Params)
```

Expand All @@ -46,6 +49,7 @@ returns(struct BondSize.Params)
| Name | Type | Description |
| ------------- |------------- | -----|
| initialBondSize | uint128 | |
| initialExitBountySize | uint128 | |
| lowerBoundDivisor | uint16 | |
| upperBoundMultiplier | uint16 | |

Expand All @@ -54,7 +58,7 @@ returns(struct BondSize.Params)
Updates the bond size

```js
function updateBondSize(struct BondSize.Params self, uint128 newBondSize) internal nonpayable
function updateBondSize(struct BondSize.Params self, uint128 newBondSize, uint128 newExitBountySize) internal nonpayable
```

**Arguments**
Expand All @@ -63,6 +67,7 @@ function updateBondSize(struct BondSize.Params self, uint128 newBondSize) intern
| ------------- |------------- | -----|
| self | struct BondSize.Params | |
| newBondSize | uint128 | The new bond size |
| newExitBountySize | uint128 | The new exit bounty size |

### bondSize

Expand All @@ -79,10 +84,25 @@ returns(uint128)
| ------------- |------------- | -----|
| self | struct BondSize.Params | |

### exitBountySize

Returns the current exit bounty size

```js
function exitBountySize(struct BondSize.Params self) internal view
returns(uint128)
```

**Arguments**

| Name | Type | Description |
| ------------- |------------- | -----|
| self | struct BondSize.Params | |

### validateBondSize

```js
function validateBondSize(struct BondSize.Params self, uint128 newBondSize) private view
function validateBondSize(struct BondSize.Params self, uint128 newBondSize, uint128 newExitBountySize) private view
```

**Arguments**
Expand All @@ -91,6 +111,7 @@ function validateBondSize(struct BondSize.Params self, uint128 newBondSize) priv
| ------------- |------------- | -----|
| self | struct BondSize.Params | |
| newBondSize | uint128 | |
| newExitBountySize | uint128 | |

## Contracts

Expand All @@ -105,7 +126,6 @@ function validateBondSize(struct BondSize.Params self, uint128 newBondSize) priv
* [EthDepositVerifier](EthDepositVerifier.md)
* [EthVault](EthVault.md)
* [ExitableTimestamp](ExitableTimestamp.md)
* [ExitBounty](ExitBounty.md)
* [ExitGameController](ExitGameController.md)
* [ExitGameRegistry](ExitGameRegistry.md)
* [ExitId](ExitId.md)
Expand Down
1 change: 0 additions & 1 deletion plasma_framework/docs/contracts/ECDSA.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,6 @@ returns(bytes32)
* [EthDepositVerifier](EthDepositVerifier.md)
* [EthVault](EthVault.md)
* [ExitableTimestamp](ExitableTimestamp.md)
* [ExitBounty](ExitBounty.md)
* [ExitGameController](ExitGameController.md)
* [ExitGameRegistry](ExitGameRegistry.md)
* [ExitId](ExitId.md)
Expand Down
1 change: 0 additions & 1 deletion plasma_framework/docs/contracts/Erc20DepositVerifier.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,6 @@ Verified (owner, token, amount) of the deposit ERC20 token data
* [EthDepositVerifier](EthDepositVerifier.md)
* [EthVault](EthVault.md)
* [ExitableTimestamp](ExitableTimestamp.md)
* [ExitBounty](ExitBounty.md)
* [ExitGameController](ExitGameController.md)
* [ExitGameRegistry](ExitGameRegistry.md)
* [ExitId](ExitId.md)
Expand Down
1 change: 0 additions & 1 deletion plasma_framework/docs/contracts/Erc20Vault.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,6 @@ function withdraw(address payable receiver, address token, uint256 amount) exter
* [EthDepositVerifier](EthDepositVerifier.md)
* [EthVault](EthVault.md)
* [ExitableTimestamp](ExitableTimestamp.md)
* [ExitBounty](ExitBounty.md)
* [ExitGameController](ExitGameController.md)
* [ExitGameRegistry](ExitGameRegistry.md)
* [ExitId](ExitId.md)
Expand Down
1 change: 0 additions & 1 deletion plasma_framework/docs/contracts/EthDepositVerifier.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,6 @@ function verify(bytes depositTx, uint256 amount, address sender) external view
* [EthDepositVerifier](EthDepositVerifier.md)
* [EthVault](EthVault.md)
* [ExitableTimestamp](ExitableTimestamp.md)
* [ExitBounty](ExitBounty.md)
* [ExitGameController](ExitGameController.md)
* [ExitGameRegistry](ExitGameRegistry.md)
* [ExitId](ExitId.md)
Expand Down
1 change: 0 additions & 1 deletion plasma_framework/docs/contracts/EthVault.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,6 @@ function withdraw(address payable receiver, uint256 amount) external nonpayable
* [EthDepositVerifier](EthDepositVerifier.md)
* [EthVault](EthVault.md)
* [ExitableTimestamp](ExitableTimestamp.md)
* [ExitBounty](ExitBounty.md)
* [ExitGameController](ExitGameController.md)
* [ExitGameRegistry](ExitGameRegistry.md)
* [ExitId](ExitId.md)
Expand Down
96 changes: 0 additions & 96 deletions plasma_framework/docs/contracts/ExitBounty.md
View file
Open in desktop

This file was deleted.

6 changes: 3 additions & 3 deletions plasma_framework/docs/contracts/ExitGameController.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ modifier nonReentrant() internal
- [hasExitQueue(uint256 vaultId, address token)](#hasexitqueue)
- [addExitQueue(uint256 vaultId, address token)](#addexitqueue)
- [enqueue(uint256 vaultId, address token, uint32 exitableAt, struct PosLib.Position txPos, uint168 exitId, IExitProcessor exitProcessor)](#enqueue)
- [processExits(uint256 vaultId, address token, uint168 topExitId, uint256 maxExitsToProcess)](#processexits)
- [processExits(uint256 vaultId, address token, uint168 topExitId, uint256 maxExitsToProcess, bytes32 senderData)](#processexits)
- [isAnyInputFinalizedByOtherExit(bytes32[] _outputIds, uint168 exitId)](#isanyinputfinalizedbyotherexit)
- [batchFlagOutputsFinalized(bytes32[] outputIds, uint168 exitId)](#batchflagoutputsfinalized)
- [flagOutputFinalized(bytes32 outputId, uint168 exitId)](#flagoutputfinalized)
Expand Down Expand Up @@ -174,7 +174,7 @@ A unique priority number computed for the exit
Processes any exits that have completed the challenge period. Exits are processed according to the exit priority.

```js
function processExits(uint256 vaultId, address token, uint168 topExitId, uint256 maxExitsToProcess) external nonpayable nonReentrant
function processExits(uint256 vaultId, address token, uint168 topExitId, uint256 maxExitsToProcess, bytes32 senderData) external nonpayable nonReentrant
```

**Returns**
Expand All @@ -189,6 +189,7 @@ Total number of processed exits
| token | address | The token type to process |
| topExitId | uint168 | Unique identifier for prioritizing the first exit to process. Set to zero to skip this check. |
| maxExitsToProcess | uint256 | Maximum number of exits to process |
| senderData | bytes32 | A keccak256 hash of the sender's address |

### isAnyInputFinalizedByOtherExit

Expand Down Expand Up @@ -320,7 +321,6 @@ returns(bytes32)
* [EthDepositVerifier](EthDepositVerifier.md)
* [EthVault](EthVault.md)
* [ExitableTimestamp](ExitableTimestamp.md)
* [ExitBounty](ExitBounty.md)
* [ExitGameController](ExitGameController.md)
* [ExitGameRegistry](ExitGameRegistry.md)
* [ExitId](ExitId.md)
Expand Down
1 change: 0 additions & 1 deletion plasma_framework/docs/contracts/ExitGameRegistry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,6 @@ returns(uint256)
* [EthDepositVerifier](EthDepositVerifier.md)
* [EthVault](EthVault.md)
* [ExitableTimestamp](ExitableTimestamp.md)
* [ExitBounty](ExitBounty.md)
* [ExitGameController](ExitGameController.md)
* [ExitGameRegistry](ExitGameRegistry.md)
* [ExitId](ExitId.md)
Expand Down
1 change: 0 additions & 1 deletion plasma_framework/docs/contracts/ExitId.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,6 @@ Unique in-flight exit ID
* [EthDepositVerifier](EthDepositVerifier.md)
* [EthVault](EthVault.md)
* [ExitableTimestamp](ExitableTimestamp.md)
* [ExitBounty](ExitBounty.md)
* [ExitGameController](ExitGameController.md)
* [ExitGameRegistry](ExitGameRegistry.md)
* [ExitId](ExitId.md)
Expand Down
1 change: 0 additions & 1 deletion plasma_framework/docs/contracts/ExitPriority.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,6 @@ returns(uint168)
* [EthDepositVerifier](EthDepositVerifier.md)
* [EthVault](EthVault.md)
* [ExitableTimestamp](ExitableTimestamp.md)
* [ExitBounty](ExitBounty.md)
* [ExitGameController](ExitGameController.md)
* [ExitGameRegistry](ExitGameRegistry.md)
* [ExitId](ExitId.md)
Expand Down
1 change: 0 additions & 1 deletion plasma_framework/docs/contracts/ExitableTimestamp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,6 @@ returns(uint32)
* [EthDepositVerifier](EthDepositVerifier.md)
* [EthVault](EthVault.md)
* [ExitableTimestamp](ExitableTimestamp.md)
* [ExitBounty](ExitBounty.md)
* [ExitGameController](ExitGameController.md)
* [ExitGameRegistry](ExitGameRegistry.md)
* [ExitId](ExitId.md)
Expand Down
1 change: 0 additions & 1 deletion plasma_framework/docs/contracts/FailFastReentrancyGuard.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ modifier nonReentrant(ExitGameController exitGameController) internal
* [EthDepositVerifier](EthDepositVerifier.md)
* [EthVault](EthVault.md)
* [ExitableTimestamp](ExitableTimestamp.md)
* [ExitBounty](ExitBounty.md)
* [ExitGameController](ExitGameController.md)
* [ExitGameRegistry](ExitGameRegistry.md)
* [ExitId](ExitId.md)
Expand Down
1 change: 0 additions & 1 deletion plasma_framework/docs/contracts/FeeClaimOutputToPaymentTxCondition.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,6 @@ returns(bool)
* [EthDepositVerifier](EthDepositVerifier.md)
* [EthVault](EthVault.md)
* [ExitableTimestamp](ExitableTimestamp.md)
* [ExitBounty](ExitBounty.md)
* [ExitGameController](ExitGameController.md)
* [ExitGameRegistry](ExitGameRegistry.md)
* [ExitId](ExitId.md)
Expand Down
1 change: 0 additions & 1 deletion plasma_framework/docs/contracts/FeeExitGame.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ View Source: [contracts/src/exits/fee/FeeExitGame.sol](../../contracts/src/exits
* [EthDepositVerifier](EthDepositVerifier.md)
* [EthVault](EthVault.md)
* [ExitableTimestamp](ExitableTimestamp.md)
* [ExitBounty](ExitBounty.md)
* [ExitGameController](ExitGameController.md)
* [ExitGameRegistry](ExitGameRegistry.md)
* [ExitId](ExitId.md)
Expand Down
1 change: 0 additions & 1 deletion plasma_framework/docs/contracts/FungibleTokenOutputModel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,6 @@ returns(struct FungibleTokenOutputModel.Output)
* [EthDepositVerifier](EthDepositVerifier.md)
* [EthVault](EthVault.md)
* [ExitableTimestamp](ExitableTimestamp.md)
* [ExitBounty](ExitBounty.md)
* [ExitGameController](ExitGameController.md)
* [ExitGameRegistry](ExitGameRegistry.md)
* [ExitId](ExitId.md)
Expand Down
1 change: 0 additions & 1 deletion plasma_framework/docs/contracts/GenericTransaction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,6 @@ returns(struct GenericTransaction.Output)
* [EthDepositVerifier](EthDepositVerifier.md)
* [EthVault](EthVault.md)
* [ExitableTimestamp](ExitableTimestamp.md)
* [ExitBounty](ExitBounty.md)
* [ExitGameController](ExitGameController.md)
* [ExitGameRegistry](ExitGameRegistry.md)
* [ExitId](ExitId.md)
Expand Down
1 change: 0 additions & 1 deletion plasma_framework/docs/contracts/IERC20.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,6 @@ returns(bool)
* [EthDepositVerifier](EthDepositVerifier.md)
* [EthVault](EthVault.md)
* [ExitableTimestamp](ExitableTimestamp.md)
* [ExitBounty](ExitBounty.md)
* [ExitGameController](ExitGameController.md)
* [ExitGameRegistry](ExitGameRegistry.md)
* [ExitId](ExitId.md)
Expand Down
1 change: 0 additions & 1 deletion plasma_framework/docs/contracts/IErc20DepositVerifier.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ Verified (owner, token, amount) of the deposit ERC20 token data
* [EthDepositVerifier](EthDepositVerifier.md)
* [EthVault](EthVault.md)
* [ExitableTimestamp](ExitableTimestamp.md)
* [ExitBounty](ExitBounty.md)
* [ExitGameController](ExitGameController.md)
* [ExitGameRegistry](ExitGameRegistry.md)
* [ExitId](ExitId.md)
Expand Down
1 change: 0 additions & 1 deletion plasma_framework/docs/contracts/IEthDepositVerifier.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ function verify(bytes depositTx, uint256 amount, address sender) external view
* [EthDepositVerifier](EthDepositVerifier.md)
* [EthVault](EthVault.md)
* [ExitableTimestamp](ExitableTimestamp.md)
* [ExitBounty](ExitBounty.md)
* [ExitGameController](ExitGameController.md)
* [ExitGameRegistry](ExitGameRegistry.md)
* [ExitId](ExitId.md)
Expand Down
Loading