Merge pull request #129 from oceanprotocol/feature/rinkeby-deployment

feature/rinkeby-deployment
oceanprotocol · Jul 20, 2020 · 3b9dbff · 3b9dbff
2 parents ce5c39a + 9b53c31
commit 3b9dbff
Show file tree

Hide file tree

Showing 29 changed files with 139,129 additions and 7,369 deletions.
diff --git a/artifacts/rinkeby/BConst.json b/artifacts/rinkeby/BConst.json
diff --git a/artifacts/rinkeby/BMath.json b/artifacts/rinkeby/BMath.json
diff --git a/artifacts/rinkeby/BNum.json b/artifacts/rinkeby/BNum.json
diff --git a/artifacts/rinkeby/BToken.json b/artifacts/rinkeby/BToken.json
diff --git a/artifacts/rinkeby/BTokenBase.json b/artifacts/rinkeby/BTokenBase.json
diff --git a/artifacts/rinkeby/Context.json b/artifacts/rinkeby/Context.json
diff --git a/artifacts/rinkeby/Converter.json b/artifacts/rinkeby/Converter.json
diff --git a/artifacts/rinkeby/Factory.json → artifacts/rinkeby/DTFactory.json b/artifacts/rinkeby/Factory.json → artifacts/rinkeby/DTFactory.json
diff --git a/artifacts/rinkeby/DataTokenTemplate.json b/artifacts/rinkeby/DataTokenTemplate.json
diff --git a/artifacts/rinkeby/Deployer.json b/artifacts/rinkeby/Deployer.json
diff --git a/artifacts/rinkeby/ERC20.json b/artifacts/rinkeby/ERC20.json
diff --git a/artifacts/rinkeby/ERC20Pausable.json b/artifacts/rinkeby/ERC20Pausable.json
diff --git a/artifacts/rinkeby/IERC20.json b/artifacts/rinkeby/IERC20.json
diff --git a/artifacts/rinkeby/IERC20Template.json b/artifacts/rinkeby/IERC20Template.json
diff --git a/artifacts/rinkeby/Migrations.json b/artifacts/rinkeby/Migrations.json
diff --git a/artifacts/rinkeby/SFactory.json b/artifacts/rinkeby/SFactory.json
diff --git a/artifacts/rinkeby/SPool.json b/artifacts/rinkeby/SPool.json
diff --git a/artifacts/rinkeby/SafeMath.json b/artifacts/rinkeby/SafeMath.json
diff --git a/docs/contracts/Factory.md → docs/contracts/DTFactory.md b/docs/contracts/Factory.md → docs/contracts/DTFactory.md
@@ -1,10 +1,10 @@
-## `Factory`
+## `DTFactory`
 
 
 
 Implementation of Ocean DataTokens Factory
 
-Factory deploys DataToken proxy contracts.
+DTFactory deploys DataToken proxy contracts.
 New DataToken proxy contracts are links to the template contract's bytecode. 
 Proxy contract functionality is based on Ocean Protocol custom implementation of ERC1167 standard.
 

diff --git a/docs/contracts/SFactory.md b/docs/contracts/SFactory.md
@@ -0,0 +1,38 @@
+## `SFactory`
+
+
+
+
+
+
+### `constructor(address spoolTemplate)` (public)
+
+
+
+
+
+### `newSPool() → address spool` (public)
+
+
+
+
+
+### `getSPool() → address` (external)
+
+
+
+
+
+
+### `SPoolCreated(address newSPoolAddress, address spoolTemplateAddress)`
+
+
+
+
+
+### `SPoolRegistered(address spoolAddress, address registeredBy, uint256 registeredAt)`
+
+
+
+
+
diff --git a/docs/contracts/balancer/BConst.md b/docs/contracts/balancer/BConst.md
@@ -0,0 +1,8 @@
+## `BConst`
+
+
+
+
+
+
+
diff --git a/docs/contracts/balancer/BMath.md b/docs/contracts/balancer/BMath.md
@@ -0,0 +1,107 @@
+## `BMath`
+
+
+
+
+
+
+### `calcSpotPrice(uint256 tokenBalanceIn, uint256 tokenWeightIn, uint256 tokenBalanceOut, uint256 tokenWeightOut, uint256 swapFee) → uint256 spotPrice` (public)
+
+********************************************************************************************
+// calcSpotPrice                                                                             //
+// sP = spotPrice                                                                            //
+// bI = tokenBalanceIn                ( bI / wI )         1                                  //
+// bO = tokenBalanceOut         sP =  -----------  *  ----------                             //
+// wI = tokenWeightIn                 ( bO / wO )     ( 1 - sF )                             //
+// wO = tokenWeightOut                                                                       //
+// sF = swapFee                                                                              //*********************************************************************************************
+
+
+
+### `calcOutGivenIn(uint256 tokenBalanceIn, uint256 tokenWeightIn, uint256 tokenBalanceOut, uint256 tokenWeightOut, uint256 tokenAmountIn, uint256 swapFee) → uint256 tokenAmountOut` (public)
+
+********************************************************************************************
+// calcOutGivenIn                                                                            //
+// aO = tokenAmountOut                                                                       //
+// bO = tokenBalanceOut                                                                      //
+// bI = tokenBalanceIn              /      /            bI             \    (wI / wO) \      //
+// aI = tokenAmountIn    aO = bO * |  1 - | --------------------------  | ^            |     //
+// wI = tokenWeightIn               \      \ ( bI + ( aI * ( 1 - sF )) /              /      //
+// wO = tokenWeightOut                                                                       //
+// sF = swapFee                                                                              //*********************************************************************************************
+
+
+
+### `calcInGivenOut(uint256 tokenBalanceIn, uint256 tokenWeightIn, uint256 tokenBalanceOut, uint256 tokenWeightOut, uint256 tokenAmountOut, uint256 swapFee) → uint256 tokenAmountIn` (public)
+
+********************************************************************************************
+// calcInGivenOut                                                                            //
+// aI = tokenAmountIn                                                                        //
+// bO = tokenBalanceOut               /  /     bO      \    (wO / wI)      \                 //
+// bI = tokenBalanceIn          bI * |  | ------------  | ^            - 1  |                //
+// aO = tokenAmountOut    aI =        \  \ ( bO - aO ) /                   /                 //
+// wI = tokenWeightIn           --------------------------------------------                 //
+// wO = tokenWeightOut                          ( 1 - sF )                                   //
+// sF = swapFee                                                                              //*********************************************************************************************
+
+
+
+### `calcPoolOutGivenSingleIn(uint256 tokenBalanceIn, uint256 tokenWeightIn, uint256 poolSupply, uint256 totalWeight, uint256 tokenAmountIn, uint256 swapFee) → uint256 poolAmountOut` (public)
+
+********************************************************************************************
+// calcPoolOutGivenSingleIn                                                                  //
+// pAo = poolAmountOut         /                                              \              //
+// tAi = tokenAmountIn        ///      /     //    wI \      \\       \     wI \             //
+// wI = tokenWeightIn        //| tAi *| 1 - || 1 - --  | * sF || + tBi \    --  \            //
+// tW = totalWeight     pAo=||  \      \     \\    tW /      //         | ^ tW   | * pS - pS //
+// tBi = tokenBalanceIn      \\  ------------------------------------- /        /            //
+// pS = poolSupply            \\                    tBi               /        /             //
+// sF = swapFee                \                                              /              //*********************************************************************************************
+
+
+
+### `calcSingleInGivenPoolOut(uint256 tokenBalanceIn, uint256 tokenWeightIn, uint256 poolSupply, uint256 totalWeight, uint256 poolAmountOut, uint256 swapFee) → uint256 tokenAmountIn` (public)
+
+********************************************************************************************
+// calcSingleInGivenPoolOut                                                                  //
+// tAi = tokenAmountIn              //(pS + pAo)\     /    1    \\                           //
+// pS = poolSupply                 || ---------  | ^ | --------- || * bI - bI                //
+// pAo = poolAmountOut              \\    pS    /     \(wI / tW)//                           //
+// bI = balanceIn          tAi =  --------------------------------------------               //
+// wI = weightIn                              /      wI  \                                   //
+// tW = totalWeight                          |  1 - ----  |  * sF                            //
+// sF = swapFee                               \      tW  /                                   //*********************************************************************************************
+
+
+
+### `calcSingleOutGivenPoolIn(uint256 tokenBalanceOut, uint256 tokenWeightOut, uint256 poolSupply, uint256 totalWeight, uint256 poolAmountIn, uint256 swapFee) → uint256 tokenAmountOut` (public)
+
+********************************************************************************************
+// calcSingleOutGivenPoolIn                                                                  //
+// tAo = tokenAmountOut            /      /                                             \\   //
+// bO = tokenBalanceOut           /      // pS - (pAi * (1 - eF)) \     /    1    \      \\  //
+// pAi = poolAmountIn            | bO - || ----------------------- | ^ | --------- | * b0 || //
+// ps = poolSupply                \      \\          pS           /     \(wO / tW)/      //  //
+// wI = tokenWeightIn      tAo =   \      \                                             //   //
+// tW = totalWeight                    /     /      wO \       \                             //
+// sF = swapFee                    *  | 1 - |  1 - ---- | * sF  |                            //
+// eF = exitFee                        \     \      tW /       /                             //*********************************************************************************************
+
+
+
+### `calcPoolInGivenSingleOut(uint256 tokenBalanceOut, uint256 tokenWeightOut, uint256 poolSupply, uint256 totalWeight, uint256 tokenAmountOut, uint256 swapFee) → uint256 poolAmountIn` (public)
+
+********************************************************************************************
+// calcPoolInGivenSingleOut                                                                  //
+// pAi = poolAmountIn               // /               tAo             \\     / wO \     \   //
+// bO = tokenBalanceOut            // | bO - -------------------------- |\   | ---- |     \  //
+// tAo = tokenAmountOut      pS - ||   \     1 - ((1 - (tO / tW)) * sF)/  | ^ \ tW /  * pS | //
+// ps = poolSupply                 \\ -----------------------------------/                /  //
+// wO = tokenWeightOut  pAi =       \\               bO                 /                /   //
+// tW = totalWeight           -------------------------------------------------------------  //
+// sF = swapFee                                        ( 1 - eF )                            //
+// eF = exitFee                                                                              //*********************************************************************************************
+
+
+
+
diff --git a/docs/contracts/balancer/BNum.md b/docs/contracts/balancer/BNum.md
@@ -0,0 +1,68 @@
+## `BNum`
+
+
+
+
+
+
+### `btoi(uint256 a) → uint256` (internal)
+
+
+
+
+
+### `bfloor(uint256 a) → uint256` (internal)
+
+
+
+
+
+### `badd(uint256 a, uint256 b) → uint256` (internal)
+
+
+
+
+
+### `bsub(uint256 a, uint256 b) → uint256` (internal)
+
+
+
+
+
+### `bsubSign(uint256 a, uint256 b) → uint256, bool` (internal)
+
+
+
+
+
+### `bmul(uint256 a, uint256 b) → uint256` (internal)
+
+
+
+
+
+### `bdiv(uint256 a, uint256 b) → uint256` (internal)
+
+
+
+
+
+### `bpowi(uint256 a, uint256 n) → uint256` (internal)
+
+
+
+
+
+### `bpow(uint256 base, uint256 exp) → uint256` (internal)
+
+
+
+
+
+### `bpowApprox(uint256 base, uint256 exp, uint256 precision) → uint256` (internal)
+
+
+
+
+
+
diff --git a/docs/contracts/balancer/BToken.md b/docs/contracts/balancer/BToken.md
@@ -0,0 +1,74 @@
+## `BToken`
+
+
+
+
+
+
+### `name() → string` (public)
+
+
+
+
+
+### `symbol() → string` (public)
+
+
+
+
+
+### `decimals() → uint8` (public)
+
+
+
+
+
+### `allowance(address src, address dst) → uint256` (external)
+
+
+
+
+
+### `balanceOf(address whom) → uint256` (external)
+
+
+
+
+
+### `totalSupply() → uint256` (public)
+
+
+
+
+
+### `approve(address dst, uint256 amt) → bool` (external)
+
+
+
+
+
+### `increaseApproval(address dst, uint256 amt) → bool` (external)
+
+
+
+
+
+### `decreaseApproval(address dst, uint256 amt) → bool` (external)
+
+
+
+
+
+### `transfer(address dst, uint256 amt) → bool` (external)
+
+
+
+
+
+### `transferFrom(address src, address dst, uint256 amt) → bool` (external)
+
+
+
+
+
+