From 993c180b518e083b71f7509332b27ff10191bb84 Mon Sep 17 00:00:00 2001 From: pgebal Date: Fri, 18 Oct 2019 09:10:18 +0200 Subject: [PATCH] docs: update docs for getting exit ids and calculating timestamps (#372) --- .../docs/contracts/ExitableTimestamp.md | 26 ++++++++++++++++--- .../docs/contracts/PaymentExitGame.md | 4 +-- 2 files changed, 24 insertions(+), 6 deletions(-) diff --git a/plasma_framework/docs/contracts/ExitableTimestamp.md b/plasma_framework/docs/contracts/ExitableTimestamp.md index 94b59d7cb..dcc1611f0 100644 --- a/plasma_framework/docs/contracts/ExitableTimestamp.md +++ b/plasma_framework/docs/contracts/ExitableTimestamp.md @@ -15,12 +15,15 @@ struct Calculator { ## Functions -- [calculate(struct ExitableTimestamp.Calculator _calculator, uint256 _now, uint256 _blockTimestamp, bool _isDeposit)](#calculate) +- [calculateTxExitableTimestamp(struct ExitableTimestamp.Calculator _calculator, uint256 _now, uint256 _blockTimestamp)](#calculatetxexitabletimestamp) +- [calculateDepositTxOutputExitableTimestamp(struct ExitableTimestamp.Calculator _calculator, uint256 _now)](#calculatedeposittxoutputexitabletimestamp) -### calculate +### calculateTxExitableTimestamp + +Calculates the exitable timestamp for a mined transaction ```js -function calculate(struct ExitableTimestamp.Calculator _calculator, uint256 _now, uint256 _blockTimestamp, bool _isDeposit) internal pure +function calculateTxExitableTimestamp(struct ExitableTimestamp.Calculator _calculator, uint256 _now, uint256 _blockTimestamp) internal pure returns(uint64) ``` @@ -31,7 +34,22 @@ returns(uint64) | _calculator | struct ExitableTimestamp.Calculator | | | _now | uint256 | | | _blockTimestamp | uint256 | | -| _isDeposit | bool | | + +### calculateDepositTxOutputExitableTimestamp + +Calculates the exitable timestamp for deposit transaction output for standard exit + +```js +function calculateDepositTxOutputExitableTimestamp(struct ExitableTimestamp.Calculator _calculator, uint256 _now) internal pure +returns(uint64) +``` + +**Arguments** + +| Name | Type | Description | +| ------------- |------------- | -----| +| _calculator | struct ExitableTimestamp.Calculator | | +| _now | uint256 | | ## Contracts diff --git a/plasma_framework/docs/contracts/PaymentExitGame.md b/plasma_framework/docs/contracts/PaymentExitGame.md index 7194e3433..9ca08e6c8 100644 --- a/plasma_framework/docs/contracts/PaymentExitGame.md +++ b/plasma_framework/docs/contracts/PaymentExitGame.md @@ -66,7 +66,7 @@ Helper function to compute standard exit id. ```js function getStandardExitId(bool _isDeposit, bytes _txBytes, uint256 _utxoPos) public pure -returns(uint192) +returns(uint160) ``` **Arguments** @@ -83,7 +83,7 @@ Helper function to compute in-flight exit id. ```js function getInFlightExitId(bytes _txBytes) public pure -returns(uint192) +returns(uint160) ``` **Arguments**