docs/uml/GammaController.svg

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
 "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Generated by graphviz version 2.40.1 (20161225.0304)
 -->
<!-- Title: UmlClassDiagram Pages: 1 -->
<svg width="1212pt" height="1663pt"
 viewBox="0.00 0.00 1211.50 1662.60" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 1658.6)">
<title>UmlClassDiagram</title>
<polygon fill="#ffffff" stroke="transparent" points="-4,4 -4,-1658.6 1207.5038,-1658.6 1207.5038,4 -4,4"/>
<!-- 0 -->
<g id="node1" class="node">
<title>0</title>
<polygon fill="#f2f2f2" stroke="#000000" points="0,-.5 0,-1654.1 1203.5038,-1654.1 1203.5038,-.5 0,-.5"/>
<text text-anchor="middle" x="601.7519" y="-1637.5" font-family="Times,serif" font-size="14.00" fill="#000000">Controller</text>
<polyline fill="none" stroke="#000000" points="0,-1629.3 1203.5038,-1629.3 "/>
<text text-anchor="start" x="8" y="-1612.7" font-family="Times,serif" font-size="14.00" fill="#000000">Internal:</text>
<text text-anchor="start" x="8" y="-1595.9" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;BASE: uint256</text>
<text text-anchor="start" x="8" y="-1579.1" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;accountVaultCounter: mapping(address=&gt;uint256)</text>
<text text-anchor="start" x="8" y="-1562.3" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;vaults: mapping(address=&gt;mapping(uint256=&gt;MarginVault.Vault))</text>
<text text-anchor="start" x="8" y="-1545.5" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;operators: mapping(address=&gt;mapping(address=&gt;bool))</text>
<text text-anchor="start" x="8" y="-1528.7" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;vaultType: mapping(address=&gt;mapping(uint256=&gt;uint256))</text>
<text text-anchor="start" x="8" y="-1511.9" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;vaultLatestUpdate: mapping(address=&gt;mapping(uint256=&gt;uint256))</text>
<text text-anchor="start" x="8" y="-1495.1" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;nakedCap: mapping(address=&gt;uint256)</text>
<text text-anchor="start" x="8" y="-1478.3" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;nakedPoolBalance: mapping(address=&gt;uint256)</text>
<text text-anchor="start" x="8" y="-1461.5" font-family="Times,serif" font-size="14.00" fill="#000000">Public:</text>
<text text-anchor="start" x="8" y="-1444.7" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;addressbook: AddressBookInterface</text>
<text text-anchor="start" x="8" y="-1427.9" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;whitelist: WhitelistInterface</text>
<text text-anchor="start" x="8" y="-1411.1" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;oracle: OracleInterface</text>
<text text-anchor="start" x="8" y="-1394.3" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;calculator: MarginCalculatorInterface</text>
<text text-anchor="start" x="8" y="-1377.5" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;pool: MarginPoolInterface</text>
<text text-anchor="start" x="8" y="-1360.7" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;partialPauser: address</text>
<text text-anchor="start" x="8" y="-1343.9" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;fullPauser: address</text>
<text text-anchor="start" x="8" y="-1327.1" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;systemPartiallyPaused: bool</text>
<text text-anchor="start" x="8" y="-1310.3" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;systemFullyPaused: bool</text>
<text text-anchor="start" x="8" y="-1293.5" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;callRestricted: bool</text>
<polyline fill="none" stroke="#000000" points="0,-1285.3 1203.5038,-1285.3 "/>
<text text-anchor="start" x="8" y="-1268.7" font-family="Times,serif" font-size="14.00" fill="#000000">Internal:</text>
<text text-anchor="start" x="8" y="-1251.9" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;_isNotPartiallyPaused()</text>
<text text-anchor="start" x="8" y="-1235.1" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;_isNotFullyPaused()</text>
<text text-anchor="start" x="8" y="-1218.3" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;_isAuthorized(_sender: address, _accountOwner: address)</text>
<text text-anchor="start" x="8" y="-1201.5" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;_runActions(_actions: Actions.ActionArgs[]): (bool, address, uint256)</text>
<text text-anchor="start" x="8" y="-1184.7" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;_verifyFinalState(_owner: address, _vaultId: uint256)</text>
<text text-anchor="start" x="8" y="-1167.9" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;_openVault(_args: Actions.OpenVaultArgs)</text>
<text text-anchor="start" x="8" y="-1151.1" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;_depositLong(_args: Actions.DepositArgs)</text>
<text text-anchor="start" x="8" y="-1134.3" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;_withdrawLong(_args: Actions.WithdrawArgs)</text>
<text text-anchor="start" x="8" y="-1117.5" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;_depositCollateral(_args: Actions.DepositArgs)</text>
<text text-anchor="start" x="8" y="-1100.7" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;_withdrawCollateral(_args: Actions.WithdrawArgs)</text>
<text text-anchor="start" x="8" y="-1083.9" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;_mintOtoken(_args: Actions.MintArgs)</text>
<text text-anchor="start" x="8" y="-1067.1" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;_burnOtoken(_args: Actions.BurnArgs)</text>
<text text-anchor="start" x="8" y="-1050.3" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;_redeem(_args: Actions.RedeemArgs)</text>
<text text-anchor="start" x="8" y="-1033.5" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;_settleVault(_args: Actions.SettleVaultArgs)</text>
<text text-anchor="start" x="8" y="-1016.7" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;_liquidate(_args: Actions.LiquidateArgs)</text>
<text text-anchor="start" x="8" y="-999.9" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;_call(_args: Actions.CallArgs)</text>
<text text-anchor="start" x="8" y="-983.1" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;_checkVaultId(_accountOwner: address, _vaultId: uint256): bool</text>
<text text-anchor="start" x="8" y="-966.3" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;_isNotEmpty(_array: address[]): bool</text>
<text text-anchor="start" x="8" y="-949.5" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;_isCalleeWhitelisted(_callee: address): bool</text>
<text text-anchor="start" x="8" y="-932.7" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;_isLiquidatable(_owner: address, _vaultId: uint256, _roundId: uint256): (MarginVault.Vault, bool, uint256, uint256)</text>
<text text-anchor="start" x="8" y="-915.9" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;_getOtokenDetails(_otoken: address): (address, address, address, uint256)</text>
<text text-anchor="start" x="8" y="-899.1" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;_canSettleAssets(_underlying: address, _strike: address, _collateral: address, _expiry: uint256): bool</text>
<text text-anchor="start" x="8" y="-882.3" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;_refreshConfigInternal()</text>
<text text-anchor="start" x="8" y="-865.5" font-family="Times,serif" font-size="14.00" fill="#000000">External:</text>
<text text-anchor="start" x="8" y="-848.7" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;initialize(_addressBook: address, _owner: address)</text>
<text text-anchor="start" x="8" y="-831.9" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;donate(_asset: address, _amount: uint256)</text>
<text text-anchor="start" x="8" y="-815.1" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;setSystemPartiallyPaused(_partiallyPaused: bool)</text>
<text text-anchor="start" x="8" y="-798.3" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;setSystemFullyPaused(_fullyPaused: bool)</text>
<text text-anchor="start" x="8" y="-781.5" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;setFullPauser(_fullPauser: address)</text>
<text text-anchor="start" x="8" y="-764.7" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;setPartialPauser(_partialPauser: address)</text>
<text text-anchor="start" x="8" y="-747.9" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;setCallRestriction(_isRestricted: bool)</text>
<text text-anchor="start" x="8" y="-731.1" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;setOperator(_operator: address, _isOperator: bool)</text>
<text text-anchor="start" x="8" y="-714.3" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;refreshConfiguration()</text>
<text text-anchor="start" x="8" y="-697.5" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;setNakedCap(_collateral: address, _cap: uint256)</text>
<text text-anchor="start" x="8" y="-680.7" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;operate(_actions: Actions.ActionArgs[])</text>
<text text-anchor="start" x="8" y="-663.9" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;sync(_owner: address, _vaultId: uint256)</text>
<text text-anchor="start" x="8" y="-647.1" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;isOperator(_owner: address, _operator: address): bool</text>
<text text-anchor="start" x="8" y="-630.3" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;getConfiguration(): (address, address, address, address)</text>
<text text-anchor="start" x="8" y="-613.5" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;getProceed(_owner: address, _vaultId: uint256): uint256</text>
<text text-anchor="start" x="8" y="-596.7" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;isLiquidatable(_owner: address, _vaultId: uint256, _roundId: uint256): (bool, uint256, uint256)</text>
<text text-anchor="start" x="8" y="-579.9" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;isSettlementAllowed(_otoken: address): bool</text>
<text text-anchor="start" x="8" y="-563.1" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;canSettleAssets(_underlying: address, _strike: address, _collateral: address, _expiry: uint256): bool</text>
<text text-anchor="start" x="8" y="-546.3" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;getAccountVaultCounter(_accountOwner: address): uint256</text>
<text text-anchor="start" x="8" y="-529.5" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;hasExpired(_otoken: address): bool</text>
<text text-anchor="start" x="8" y="-512.7" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;getVault(_owner: address, _vaultId: uint256): MarginVault.Vault</text>
<text text-anchor="start" x="8" y="-495.9" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;getNakedCap(_asset: address): uint256</text>
<text text-anchor="start" x="8" y="-479.1" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;getNakedPoolBalance(_asset: address): uint256</text>
<text text-anchor="start" x="8" y="-462.3" font-family="Times,serif" font-size="14.00" fill="#000000">Public:</text>
<text text-anchor="start" x="8" y="-445.5" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;&lt;&lt;event&gt;&gt; AccountOperatorUpdated(accountOwner: address, operator: address, isSet: bool)</text>
<text text-anchor="start" x="8" y="-428.7" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;&lt;&lt;event&gt;&gt; VaultOpened(accountOwner: address, vaultId: uint256, vaultType: uint256)</text>
<text text-anchor="start" x="8" y="-411.9" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;&lt;&lt;event&gt;&gt; LongOtokenDeposited(otoken: address, accountOwner: address, from: address, vaultId: uint256, amount: uint256)</text>
<text text-anchor="start" x="8" y="-395.1" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;&lt;&lt;event&gt;&gt; LongOtokenWithdrawed(otoken: address, AccountOwner: address, to: address, vaultId: uint256, amount: uint256)</text>
<text text-anchor="start" x="8" y="-378.3" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;&lt;&lt;event&gt;&gt; CollateralAssetDeposited(asset: address, accountOwner: address, from: address, vaultId: uint256, amount: uint256)</text>
<text text-anchor="start" x="8" y="-361.5" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;&lt;&lt;event&gt;&gt; CollateralAssetWithdrawed(asset: address, AccountOwner: address, to: address, vaultId: uint256, amount: uint256)</text>
<text text-anchor="start" x="8" y="-344.7" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;&lt;&lt;event&gt;&gt; ShortOtokenMinted(otoken: address, AccountOwner: address, to: address, vaultId: uint256, amount: uint256)</text>
<text text-anchor="start" x="8" y="-327.9" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;&lt;&lt;event&gt;&gt; ShortOtokenBurned(otoken: address, AccountOwner: address, from: address, vaultId: uint256, amount: uint256)</text>
<text text-anchor="start" x="8" y="-311.1" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;&lt;&lt;event&gt;&gt; Redeem(otoken: address, redeemer: address, receiver: address, collateralAsset: address, otokenBurned: uint256, payout: uint256)</text>
<text text-anchor="start" x="8" y="-294.3" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;&lt;&lt;event&gt;&gt; VaultSettled(accountOwner: address, oTokenAddress: address, to: address, payout: uint256, vaultId: uint256, vaultType: uint256)</text>
<text text-anchor="start" x="8" y="-277.5" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;&lt;&lt;event&gt;&gt; VaultLiquidated(liquidator: address, receiver: address, vaultOwner: address, auctionPrice: uint256, auctionStartingRound: uint256, collateralPayout: uint256, debtAmount: uint256, vaultId: uint256)</text>
<text text-anchor="start" x="8" y="-260.7" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;&lt;&lt;event&gt;&gt; CallExecuted(from: address, to: address, data: bytes)</text>
<text text-anchor="start" x="8" y="-243.9" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;&lt;&lt;event&gt;&gt; FullPauserUpdated(oldFullPauser: address, newFullPauser: address)</text>
<text text-anchor="start" x="8" y="-227.1" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;&lt;&lt;event&gt;&gt; PartialPauserUpdated(oldPartialPauser: address, newPartialPauser: address)</text>
<text text-anchor="start" x="8" y="-210.3" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;&lt;&lt;event&gt;&gt; SystemPartiallyPaused(isPaused: bool)</text>
<text text-anchor="start" x="8" y="-193.5" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;&lt;&lt;event&gt;&gt; SystemFullyPaused(isPaused: bool)</text>
<text text-anchor="start" x="8" y="-176.7" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;&lt;&lt;event&gt;&gt; CallRestricted(isRestricted: bool)</text>
<text text-anchor="start" x="8" y="-159.9" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;&lt;&lt;event&gt;&gt; Donated(donator: address, asset: address, amount: uint256)</text>
<text text-anchor="start" x="8" y="-143.1" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;&lt;&lt;event&gt;&gt; NakedCapUpdated(collateral: address, cap: uint256)</text>
<text text-anchor="start" x="8" y="-126.3" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;&lt;&lt;modifier&gt;&gt; notPartiallyPaused()</text>
<text text-anchor="start" x="8" y="-109.5" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;&lt;&lt;modifier&gt;&gt; notFullyPaused()</text>
<text text-anchor="start" x="8" y="-92.7" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;&lt;&lt;modifier&gt;&gt; onlyFullPauser()</text>
<text text-anchor="start" x="8" y="-75.9" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;&lt;&lt;modifier&gt;&gt; onlyPartialPauser()</text>
<text text-anchor="start" x="8" y="-59.1" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;&lt;&lt;modifier&gt;&gt; onlyAuthorized(_sender: address, _accountOwner: address)</text>
<text text-anchor="start" x="8" y="-42.3" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;&lt;&lt;modifier&gt;&gt; onlyWhitelistedCallee(_callee: address)</text>
<text text-anchor="start" x="8" y="-25.5" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;getPayout(_otoken: address, _amount: uint256): uint256</text>
<text text-anchor="start" x="8" y="-8.7" font-family="Times,serif" font-size="14.00" fill="#000000"> &#160;&#160;&#160;getVaultWithDetails(_owner: address, _vaultId: uint256): (MarginVault.Vault, uint256, uint256)</text>
</g>
</g>
</svg>