From 20d600773ac36bc30dab6ce7c155e352ef156ea3 Mon Sep 17 00:00:00 2001 From: JonathanAmenechi <7217608+JonathanAmenechi@users.noreply.github.com> Date: Thu, 3 Aug 2023 14:42:12 -0400 Subject: [PATCH 1/2] fix: docs on reward, proposal bond, liveness --- src/UmaCtfAdapter.sol | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/src/UmaCtfAdapter.sol b/src/UmaCtfAdapter.sol index 986dc29..6d72460 100644 --- a/src/UmaCtfAdapter.sol +++ b/src/UmaCtfAdapter.sol @@ -69,9 +69,16 @@ contract UmaCtfAdapter is IUmaCtfAdapter, Auth, BulletinBoard, IOptimisticReques /// Prepares the condition using the Adapter as the oracle and a fixed outcome slot count = 2. /// @param ancillaryData - Data used to resolve a question /// @param rewardToken - ERC20 token address used for payment of rewards and fees - /// @param reward - Reward offered to a successful proposer - /// @param proposalBond - Bond required to be posted by OO proposers/disputers. If 0, the default OO bond is used. - /// @param liveness - UMA liveness period in seconds. If 0, the default liveness period is used. + /// @param reward - Reward offered to a successful OO proposer. + /// Must be chosen carefully, to properly economically incentize OO proposers. + /// @param proposalBond - Bond required to be posted by OO proposers/disputers. + /// If 0, the default OO bond is used. + /// Must be chosen carefully, to properly economically incentize OO proposers and disputers. + /// Questions expected to secure a large amount of value should consider a larger proposal bond. + /// @param liveness - OO liveness period in seconds. + /// If 0, the default liveness period is used. + /// Must be chosen carefully, depending on the value backed by the question. + /// Questions expected to secure a large amount of value should consider a higher liveness period. function initialize( bytes memory ancillaryData, address rewardToken, From 736cdee87644bb593d29ee0e88fb09354eea4448 Mon Sep 17 00:00:00 2001 From: JonathanAmenechi <7217608+JonathanAmenechi@users.noreply.github.com> Date: Thu, 3 Aug 2023 18:56:12 -0400 Subject: [PATCH 2/2] chore: default --- src/UmaCtfAdapter.sol | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/UmaCtfAdapter.sol b/src/UmaCtfAdapter.sol index 6d72460..628229b 100644 --- a/src/UmaCtfAdapter.sol +++ b/src/UmaCtfAdapter.sol @@ -76,9 +76,9 @@ contract UmaCtfAdapter is IUmaCtfAdapter, Auth, BulletinBoard, IOptimisticReques /// Must be chosen carefully, to properly economically incentize OO proposers and disputers. /// Questions expected to secure a large amount of value should consider a larger proposal bond. /// @param liveness - OO liveness period in seconds. - /// If 0, the default liveness period is used. + /// If 0, the default liveness period of 2 hours is used. /// Must be chosen carefully, depending on the value backed by the question. - /// Questions expected to secure a large amount of value should consider a higher liveness period. + /// Questions expected to secure a large amount of value should consider a longer liveness period. function initialize( bytes memory ancillaryData, address rewardToken,