multichain ampl interface methods

Author: aalavandhan

contracts/UFragments.sol

@@ -144,6 +144,15 @@ contract UFragments is ERC20Detailed, Ownable {
         emit Transfer(address(0x0), owner_, _totalSupply);
     }
 
+    /*
+     * @notice A multi-chain AMPL interface method. On the base-chain contract it reflects
+     *         the value in the contract store.
+     * @return globalAMPLSupply The current total supply.
+     */
+    function globalAMPLSupply() external view returns (uint256) {
+        return _totalSupply;
+    }
+
     /**
      * @return The total number of fragments.
      */

contracts/UFragmentsPolicy.sol

@@ -210,16 +210,25 @@ contract UFragmentsPolicy is Ownable {
         rebaseWindowLengthSec = rebaseWindowLengthSec_;
     }
 
+    /*
+     * @notice A multi-chain AMPL interface method. On the base-chain contract it reflects
+     *         the value in the contract store.
+     * @return globalAmpleforthEpoch The current epoch number.
+     */
+    function globalAmpleforthEpoch() external view returns (uint256) {
+        return epoch;
+    }
+
     /**
      * @notice A multi-chain AMPL interface method. The Ampleforth monetary policy contract
-     *         on the base-chain and XCAmpleController contracts on the satellite-chains
+     *         on the base-chain and XC-AmpleController contracts on the satellite-chains
      *         implement this method. It atomically returns two values:
      *         what the current contract believes to be,
      *         the globalAmpleforthEpoch and globalAMPLSupply.
      * @return globalAmpleforthEpoch The current epoch number.
      * @return globalAMPLSupply The total supply at the current epoch.
      */
-    function getGlobalAmpleforthEpochAndAMPLSupply() external view returns (uint256, uint256) {
+    function globalAmpleforthEpochAndAMPLSupply() external view returns (uint256, uint256) {
         return (epoch, uFrags.totalSupply());
     }
 

contracts/interfaces/IAMPL.sol

@@ -1,6 +1,6 @@
 pragma solidity 0.4.24;
 
-// Interface definition for the AMPL - ERC20 token on Ethereum (the base-chain)
+// Public interface definition for the AMPL - ERC20 token on Ethereum (the base-chain)
 interface IAMPL {
     // ERC20
     function totalSupply() external view returns (uint256);
@@ -52,12 +52,8 @@ interface IAMPL {
     function transferAllFrom(address from, address to) external returns (bool);
 
     // AMPL specific
-    function monetaryPolicy() external view returns (address);
-
     event LogRebase(uint256 indexed epoch, uint256 totalSupply);
 
-    event LogMonetaryPolicyUpdated(address monetaryPolicy);
-
     // Multi-chain AMPL
     function globalAMPLSupply() external view returns (uint256);
 }

contracts/interfaces/IAMPLGovernance.sol

@@ -0,0 +1,9 @@
+pragma solidity 0.4.24;
+
+interface IAMPLGovernance {
+    function monetaryPolicy() external view returns (address);
+
+    function setMonetaryPolicy(address monetaryPolicy_) external;
+
+    event LogMonetaryPolicyUpdated(address monetaryPolicy);
+}

contracts/interfaces/IAMPLSupplyPolicy.sol

@@ -0,0 +1,5 @@
+pragma solidity 0.4.24;
+
+interface IAMPLSupplyPolicy {
+    function rebase(uint256 epoch, int256 supplyDelta) external returns (uint256);
+}

contracts/interfaces/IAmpleforth.sol

@@ -1,30 +1,14 @@
 pragma solidity 0.4.24;
 
-// Interface definition for the Ampleforth supply policy
+// Public interface definition for the Ampleforth supply policy on Ethereum (the base-chain)
 interface IAmpleforth {
     function rebase() external;
 
-    function uFrags() external view returns (address);
-
-    function cpiOracle() external view returns (address);
-
-    function marketOracle() external view returns (address);
-
-    function deviationThreshold() external view returns (uint256);
-
-    function rebaseLag() external view returns (uint256);
-
-    function minRebaseTimeIntervalSec() external view returns (uint256);
+    function epoch() external view returns (uint256);
 
     function lastRebaseTimestampSec() external view returns (uint256);
 
-    function rebaseWindowOffsetSec() external view returns (uint256);
-
-    function rebaseWindowLengthSec() external view returns (uint256);
-
-    function epoch() external view returns (uint256);
-
-    function inRebaseWindow() public view returns (bool);
+    function inRebaseWindow() external view returns (bool);
 
     event LogRebase(
         uint256 indexed epoch,

contracts/interfaces/IAmpleforthGovernance.sol

@@ -0,0 +1,35 @@
+pragma solidity 0.4.24;
+
+interface IAmpleforthGovernance {
+    function uFrags() external view returns (address);
+
+    function cpiOracle() external view returns (address);
+
+    function marketOracle() external view returns (address);
+
+    function deviationThreshold() external view returns (uint256);
+
+    function rebaseLag() external view returns (uint256);
+
+    function minRebaseTimeIntervalSec() external view returns (uint256);
+
+    function rebaseWindowOffsetSec() external view returns (uint256);
+
+    function rebaseWindowLengthSec() external view returns (uint256);
+
+    function setCpiOracle(address cpiOracle_) external;
+
+    function setMarketOracle(address marketOracle_) external;
+
+    function setOrchestrator(address orchestrator_) external;
+
+    function setDeviationThreshold(uint256 deviationThreshold_) external;
+
+    function setRebaseLag(uint256 rebaseLag_) external;
+
+    function setRebaseTimingParameters(
+        uint256 minRebaseTimeIntervalSec_,
+        uint256 rebaseWindowOffsetSec_,
+        uint256 rebaseWindowLengthSec_
+    ) external;
+}

test/unit/UFragments.ts

@@ -65,6 +65,10 @@ describe('UFragments:Initialization', () => {
     expect(await uFragments.totalSupply()).to.eq(INITIAL_SUPPLY)
   })
 
+  it('should set the globalSupply to 50M', async function () {
+    expect(await uFragments.globalAMPLSupply()).to.eq(INITIAL_SUPPLY)
+  })
+
   it('should set the scaledTotalSupply', async function () {
     expect(await uFragments.scaledTotalSupply()).to.eq(TOTAL_GONS)
   })

test/unit/UFragmentsPolicy.ts

@@ -163,9 +163,10 @@ describe('UFragmentsPolicy:initialize', async function () {
     })
     it('epoch', async function () {
       expect(await uFragmentsPolicy.epoch()).to.eq(0)
+      expect(await uFragmentsPolicy.globalAmpleforthEpoch()).to.eq(0)
     })
-    it('getGlobalAmpleforthEpochAndAMPLSupply', async function () {
-      const r = await uFragmentsPolicy.getGlobalAmpleforthEpochAndAMPLSupply()
+    it('globalAmpleforthEpochAndAMPLSupply', async function () {
+      const r = await uFragmentsPolicy.globalAmpleforthEpochAndAMPLSupply()
       expect(r[0]).to.eq(0)
       expect(r[1]).to.eq(0)
     })
@@ -831,11 +832,14 @@ describe('UFragmentsPolicy:Rebase', async function () {
     it('should increment epoch', async function () {
       await uFragmentsPolicy.connect(orchestrator).rebase()
       expect(await uFragmentsPolicy.epoch()).to.eq(prevEpoch.add(1))
+      expect(await uFragmentsPolicy.globalAmpleforthEpoch()).to.eq(
+        prevEpoch.add(1),
+      )
     })
 
-    it('should update getGlobalAmpleforthEpochAndAMPLSupply', async function () {
+    it('should update globalAmpleforthEpochAndAMPLSupply', async function () {
       await uFragmentsPolicy.connect(orchestrator).rebase()
-      const r = await uFragmentsPolicy.getGlobalAmpleforthEpochAndAMPLSupply()
+      const r = await uFragmentsPolicy.globalAmpleforthEpochAndAMPLSupply()
       expect(r[0]).to.eq(prevEpoch.add(1))
       expect(r[1]).to.eq('1010')
     })