@aurigami/sdk 1.6.0 → 1.6.2

package/dist/sdk.cjs.development.js

@@ -21,7 +21,9 @@ var EthRepayHelperABI = _interopDefault(require('@aurigami/contracts/artifacts/c
 var AuriFairLaunchABI = _interopDefault(require('@aurigami/contracts/artifacts/contracts/AuriFairLaunch.sol/AuriFairLaunch.json'));
 var EIP20InterfaceABI = _interopDefault(require('@aurigami/contracts/artifacts/contracts/interfaces/EIP20Interface.sol/EIP20Interface.json'));
 var PulpABI = _interopDefault(require('@aurigami/contracts/artifacts/contracts/PULP.sol/PULP.json'));
+var ReferralDirectoryABI = _interopDefault(require('@aurigami/contracts/artifacts/contracts/ReferralDirectory.sol/ReferralDirectory.json'));
 var FaucetABI = _interopDefault(require('@aurigami/contracts/artifacts/contracts/mock/Faucet.sol/Faucet.json'));
+var Multicall2ABI = _interopDefault(require('@aurigami/contracts/artifacts/contracts/mock/Multicall2.sol/Multicall2.json'));
 
 var dummyAddress = '0xDEADbeEfEEeEEEeEEEeEEeeeeeEeEEeeeeEEEEeE';
 var ETHAddress = '0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE';
@@ -75,7 +77,11 @@ var networkAddresses = {
     AURIFAIRLAUNCH: /*#__PURE__*/MAINNET_ADDRESSES.fairLaunch.toLowerCase(),
     AURILENS: /*#__PURE__*/MAINNET_ADDRESSES.auriLens.toLowerCase(),
     ETHREPAYHELPER: /*#__PURE__*/MAINNET_ADDRESSES.ethRepayHelper.toLowerCase(),
-    AURI_AIRDROP: /*#__PURE__*/MAINNET_ADDRESSES.auriAirdrop.toLowerCase()
+    AURI_AIRDROP: /*#__PURE__*/MAINNET_ADDRESSES.auriAirdrop.toLowerCase(),
+    MULTICALL: /*#__PURE__*/MAINNET_ADDRESSES.multicall.toLowerCase(),
+    TEAM_MULTISIG: /*#__PURE__*/'0x2D05FfFE70CE64c5954710D4C308dB31C8dBd8dE'.toLowerCase(),
+    PLY_TOKEN_LOCK: /*#__PURE__*/MAINNET_ADDRESSES.plyTokenLock.toLowerCase(),
+    REFERRAL: /*#__PURE__*/MAINNET_ADDRESSES.referralDirectory.toLocaleLowerCase()
   },
   tokens: {
     AURORA: /*#__PURE__*/'0x8bec47865ade3b172a928df8f990bc7f2a3b9f79'.toLowerCase(),
@@ -107020,7 +107026,20 @@ var PapermillRead = /*#__PURE__*/function (_BlockchainEntityRead) {
     }
 
     return getTimestampToUnlock;
-  }();
+  }()
+  /**
+   * Get the start timestamp of next week of the papermill contract.
+   *
+   * This is a sync function!
+   *
+   * @returns the timestamp in seconds
+   */
+  ;
+
+  _proto.getNextWeekTimestamp = function getNextWeekTimestamp() {
+    var nextWeek = this.getWeek(getCurrentTimestamp()) + 1;
+    return REWARD_CLAIM_START + ONE_WEEK * nextWeek;
+  };
 
   _proto.getUnlockPortionAt = /*#__PURE__*/function () {
     var _getUnlockPortionAt = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee6(userAddress, timestamp) {
@@ -107154,6 +107173,236 @@ var Papermill = /*#__PURE__*/function (_BlockchainEntity) {
   return Papermill;
 }(BlockchainEntity);
 
+var ReferralRead = /*#__PURE__*/function (_BlockchainEntityRead) {
+  _inheritsLoose(ReferralRead, _BlockchainEntityRead);
+
+  function ReferralRead(networkConnection) {
+    var _this;
+
+    _this = _BlockchainEntityRead.call(this, networkConnection) || this;
+    _this._referral = new ethers.Contract(networkAddresses.misc.REFERRAL, ReferralDirectoryABI.abi, networkConnection.provider);
+    return _this;
+  }
+  /**
+   * Generate a 10-character referral code
+   * containing alphanumeric characters.
+   */
+
+
+  var _proto = ReferralRead.prototype;
+
+  _proto.generateReferralCode = function generateReferralCode() {
+    var letters = 'abcdefghijklmnopqrstuvwxyz';
+    var numbers = '1234567890';
+    var charset = letters + letters.toUpperCase() + numbers;
+    var R = '';
+
+    for (var i = 0; i < 10; i++) {
+      R += charset[Math.floor(Math.random() * charset.length)];
+    }
+
+    return R;
+  }
+  /**
+   * Get the referral code for a given address, returns empty string if not found.
+   *
+   * Called to check if a user has a referral code.
+   */
+  ;
+
+  _proto.getUserReferralCode =
+  /*#__PURE__*/
+  function () {
+    var _getUserReferralCode = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee(userAddr) {
+      var result;
+      return runtime_1.wrap(function _callee$(_context) {
+        while (1) {
+          switch (_context.prev = _context.next) {
+            case 0:
+              _context.next = 2;
+              return this._referral.userReferralCode(userAddr);
+
+            case 2:
+              result = _context.sent;
+              return _context.abrupt("return", ethers.ethers.utils.parseBytes32String(result));
+
+            case 4:
+            case "end":
+              return _context.stop();
+          }
+        }
+      }, _callee, this);
+    }));
+
+    function getUserReferralCode(_x) {
+      return _getUserReferralCode.apply(this, arguments);
+    }
+
+    return getUserReferralCode;
+  }()
+  /**
+   * Get referral code that a user was referred by, returns empty string if not found.
+   */
+  ;
+
+  _proto.getReferralCodeUsed =
+  /*#__PURE__*/
+  function () {
+    var _getReferralCodeUsed = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee2(userAddr) {
+      var result;
+      return runtime_1.wrap(function _callee2$(_context2) {
+        while (1) {
+          switch (_context2.prev = _context2.next) {
+            case 0:
+              _context2.next = 2;
+              return this._referral.referralCodeUsed(userAddr);
+
+            case 2:
+              result = _context2.sent;
+              return _context2.abrupt("return", ethers.ethers.utils.parseBytes32String(result));
+
+            case 4:
+            case "end":
+              return _context2.stop();
+          }
+        }
+      }, _callee2, this);
+    }));
+
+    function getReferralCodeUsed(_x2) {
+      return _getReferralCodeUsed.apply(this, arguments);
+    }
+
+    return getReferralCodeUsed;
+  }()
+  /**
+   * Get owner of a referral code, returns zero address if not found.
+   */
+  ;
+
+  _proto.getReferralCodeOwner =
+  /*#__PURE__*/
+  function () {
+    var _getReferralCodeOwner = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee3(code) {
+      var referralCode;
+      return runtime_1.wrap(function _callee3$(_context3) {
+        while (1) {
+          switch (_context3.prev = _context3.next) {
+            case 0:
+              referralCode = ethers.ethers.utils.formatBytes32String(code);
+              return _context3.abrupt("return", this._referral.referralCodeOwner(referralCode));
+
+            case 2:
+            case "end":
+              return _context3.stop();
+          }
+        }
+      }, _callee3, this);
+    }));
+
+    function getReferralCodeOwner(_x3) {
+      return _getReferralCodeOwner.apply(this, arguments);
+    }
+
+    return getReferralCodeOwner;
+  }();
+
+  return ReferralRead;
+}(BlockchainEntityRead);
+var ReferralReadWrite = /*#__PURE__*/function (_ReferralRead) {
+  _inheritsLoose(ReferralReadWrite, _ReferralRead);
+
+  function ReferralReadWrite() {
+    return _ReferralRead.apply(this, arguments) || this;
+  }
+
+  var _proto2 = ReferralReadWrite.prototype;
+
+  /**
+   * Generate a referral code for a given address.
+   *
+   * Called when an user want to creates his own referral code
+   */
+  _proto2.registerNewReferralCode =
+  /*#__PURE__*/
+  function () {
+    var _registerNewReferralCode = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee4() {
+      var referralCode;
+      return runtime_1.wrap(function _callee4$(_context4) {
+        while (1) {
+          switch (_context4.prev = _context4.next) {
+            case 0:
+              referralCode = ethers.ethers.utils.formatBytes32String(this.generateReferralCode());
+              return _context4.abrupt("return", this._referral.connect(this._networkConnection.signer).registerNewUserReferralCode(referralCode));
+
+            case 2:
+            case "end":
+              return _context4.stop();
+          }
+        }
+      }, _callee4, this);
+    }));
+
+    function registerNewReferralCode() {
+      return _registerNewReferralCode.apply(this, arguments);
+    }
+
+    return registerNewReferralCode;
+  }()
+  /**
+   * Called when an user confirms he is referred by a specified code
+   */
+  ;
+
+  _proto2.useReferralCode =
+  /*#__PURE__*/
+  function () {
+    var _useReferralCode = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee5(code) {
+      var referralCode;
+      return runtime_1.wrap(function _callee5$(_context5) {
+        while (1) {
+          switch (_context5.prev = _context5.next) {
+            case 0:
+              referralCode = ethers.ethers.utils.formatBytes32String(code);
+              return _context5.abrupt("return", this._referral.connect(this._networkConnection.signer).registerReferralCodeUsed(referralCode));
+
+            case 2:
+            case "end":
+              return _context5.stop();
+          }
+        }
+      }, _callee5, this);
+    }));
+
+    function useReferralCode(_x4) {
+      return _useReferralCode.apply(this, arguments);
+    }
+
+    return useReferralCode;
+  }();
+
+  return ReferralReadWrite;
+}(ReferralRead);
+var Referral = /*#__PURE__*/function (_BlockchainEntity) {
+  _inheritsLoose(Referral, _BlockchainEntity);
+
+  function Referral() {
+    return _BlockchainEntity.call(this) || this;
+  }
+
+  var _proto3 = Referral.prototype;
+
+  _proto3.read = function read(networkConnection) {
+    return new ReferralRead(networkConnection);
+  };
+
+  _proto3.readWrite = function readWrite(networkConnection) {
+    return new ReferralReadWrite(networkConnection);
+  };
+
+  return Referral;
+}(BlockchainEntity);
+
 var StakingRead = /*#__PURE__*/function (_BlockchainEntityRead) {
   _inheritsLoose(StakingRead, _BlockchainEntityRead);
 
@@ -107432,6 +107681,92 @@ var Staking = /*#__PURE__*/function (_BlockchainEntity) {
   return Staking;
 }(BlockchainEntity);
 
+var MulticallRead = /*#__PURE__*/function (_BlockchainEntityRead) {
+  _inheritsLoose(MulticallRead, _BlockchainEntityRead);
+
+  function MulticallRead(networkConnection) {
+    var _this;
+
+    _this = _BlockchainEntityRead.call(this, networkConnection) || this;
+    _this._multicall = new ethers.Contract(networkAddresses.misc.MULTICALL, Multicall2ABI.abi, networkConnection.provider);
+    return _this;
+  }
+  /**
+   * Run multiple calls via multicall contract
+   */
+
+
+  var _proto = MulticallRead.prototype;
+
+  _proto.aggregate =
+  /*#__PURE__*/
+  function () {
+    var _aggregate = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee(calls) {
+      var txns, i, _call$contract$popula, call, txn, response, decodedReturn, _i;
+
+      return runtime_1.wrap(function _callee$(_context) {
+        while (1) {
+          switch (_context.prev = _context.next) {
+            case 0:
+              txns = []; // prepare transactions
+
+              i = 0;
+
+            case 2:
+              if (!(i < calls.length)) {
+                _context.next = 11;
+                break;
+              }
+
+              call = calls[i];
+              _context.next = 6;
+              return (_call$contract$popula = call.contract.populateTransaction)[call.method].apply(_call$contract$popula, call.args);
+
+            case 6:
+              txn = _context.sent;
+              txns.push({
+                target: txn.to,
+                callData: txn.data
+              });
+
+            case 8:
+              i++;
+              _context.next = 2;
+              break;
+
+            case 11:
+              _context.next = 13;
+              return this._multicall.callStatic.aggregate(txns);
+
+            case 13:
+              response = _context.sent;
+              // parse results
+              decodedReturn = [];
+
+              for (_i = 0; _i < calls.length; _i++) {
+                decodedReturn.push(ethers.ethers.utils.defaultAbiCoder.decode(calls[_i].returnTypes, response.returnData[_i]));
+              }
+
+              return _context.abrupt("return", decodedReturn);
+
+            case 17:
+            case "end":
+              return _context.stop();
+          }
+        }
+      }, _callee, this);
+    }));
+
+    function aggregate(_x) {
+      return _aggregate.apply(this, arguments);
+    }
+
+    return aggregate;
+  }();
+
+  return MulticallRead;
+}(BlockchainEntityRead);
+
 var SdkRead = /*#__PURE__*/function (_BlockchainEntityRead) {
   _inheritsLoose(SdkRead, _BlockchainEntityRead);
 
@@ -107762,7 +108097,78 @@ var SdkRead = /*#__PURE__*/function (_BlockchainEntityRead) {
       },
       newBorrowUtilization: newBorrowLimit.eq(0) ? newBorrowValuation.eq(0) ? 0 : 9999.99 : newBorrowValuation.div(newBorrowLimit).toNumber()
     };
-  };
+  }
+  /**
+   * Get ply circulating supply.
+   * It is calculated by the total supply, minus:
+   *  - Ply in team multisig contract
+   *  - Ply in comptroller contract
+   *  - Ply in fairlaunch contract
+   *  - Ply in vesting contract
+   */
+  ;
+
+  _proto.getPlyCirculatingSupply =
+  /*#__PURE__*/
+  function () {
+    var _getPlyCirculatingSupply = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee7() {
+      var plyContract, multicallRead, baseBalanceOfCall, callResults, circulatingSupply;
+      return runtime_1.wrap(function _callee7$(_context7) {
+        while (1) {
+          switch (_context7.prev = _context7.next) {
+            case 0:
+              plyContract = new ethers.Contract(networkAddresses.tokens.PLY, EIP20InterfaceABI.abi, this._networkConnection.provider);
+              multicallRead = new MulticallRead(this._networkConnection);
+              baseBalanceOfCall = {
+                contract: plyContract,
+                method: 'balanceOf',
+                returnTypes: ['uint256']
+              };
+              _context7.next = 5;
+              return multicallRead.aggregate([// Get total supply
+              _extends({}, baseBalanceOfCall, {
+                method: 'totalSupply',
+                args: []
+              }), // balance in team multisig
+              _extends({}, baseBalanceOfCall, {
+                args: [networkAddresses.misc.TEAM_MULTISIG]
+              }), // balance in comptroller
+              _extends({}, baseBalanceOfCall, {
+                args: [networkAddresses.misc.COMPTROLLER]
+              }), // balance in fair launch
+              _extends({}, baseBalanceOfCall, {
+                args: [networkAddresses.misc.AURIFAIRLAUNCH]
+              }), // balance in vesting contract
+              _extends({}, baseBalanceOfCall, {
+                args: [networkAddresses.misc.PLY_TOKEN_LOCK]
+              })]);
+
+            case 5:
+              callResults = _context7.sent;
+              circulatingSupply = ethers.BigNumber.from(0);
+              callResults.forEach(function (result, i) {
+                if (i === 0) {
+                  circulatingSupply = result[0];
+                } else {
+                  circulatingSupply = circulatingSupply.sub(result[0]);
+                }
+              });
+              return _context7.abrupt("return", new TokenAmount(PLYToken, circulatingSupply.toString()));
+
+            case 9:
+            case "end":
+              return _context7.stop();
+          }
+        }
+      }, _callee7, this);
+    }));
+
+    function getPlyCirculatingSupply() {
+      return _getPlyCirculatingSupply.apply(this, arguments);
+    }
+
+    return getPlyCirculatingSupply;
+  }();
 
   return SdkRead;
 }(BlockchainEntityRead);
@@ -107781,25 +108187,25 @@ var SdkReadWrite = /*#__PURE__*/function (_SdkRead) {
   _proto2.claim =
   /*#__PURE__*/
   function () {
-    var _claim = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee7() {
-      return runtime_1.wrap(function _callee7$(_context7) {
+    var _claim = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee8() {
+      return runtime_1.wrap(function _callee8$(_context8) {
         while (1) {
-          switch (_context7.prev = _context7.next) {
+          switch (_context8.prev = _context8.next) {
             case 0:
-              _context7.t0 = this._comptroller.connect(this._networkConnection.signer);
-              _context7.next = 3;
+              _context8.t0 = this._comptroller.connect(this._networkConnection.signer);
+              _context8.next = 3;
               return this._networkConnection.signer.getAddress();
 
             case 3:
-              _context7.t1 = _context7.sent;
-              return _context7.abrupt("return", _context7.t0['claimReward(uint8,address)'].call(_context7.t0, 0, _context7.t1));
+              _context8.t1 = _context8.sent;
+              return _context8.abrupt("return", _context8.t0['claimReward(uint8,address)'].call(_context8.t0, 0, _context8.t1));
 
             case 5:
             case "end":
-              return _context7.stop();
+              return _context8.stop();
           }
         }
-      }, _callee7, this);
+      }, _callee8, this);
     }));
 
     function claim() {
@@ -107810,26 +108216,26 @@ var SdkReadWrite = /*#__PURE__*/function (_SdkRead) {
   }();
 
   _proto2.claimLpRewards = /*#__PURE__*/function () {
-    var _claimLpRewards = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee8() {
-      return runtime_1.wrap(function _callee8$(_context8) {
+    var _claimLpRewards = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee9() {
+      return runtime_1.wrap(function _callee9$(_context9) {
         while (1) {
-          switch (_context8.prev = _context8.next) {
+          switch (_context9.prev = _context9.next) {
             case 0:
-              _context8.t0 = this._auriFairLaunch.connect(this._networkConnection.signer);
-              _context8.next = 3;
+              _context9.t0 = this._auriFairLaunch.connect(this._networkConnection.signer);
+              _context9.next = 3;
               return this._networkConnection.signer.getAddress();
 
             case 3:
-              _context8.t1 = _context8.sent;
-              _context8.t2 = INF;
-              return _context8.abrupt("return", _context8.t0.harvest.call(_context8.t0, _context8.t1, 0, _context8.t2));
+              _context9.t1 = _context9.sent;
+              _context9.t2 = INF;
+              return _context9.abrupt("return", _context9.t0.harvest.call(_context9.t0, _context9.t1, 0, _context9.t2));
 
             case 6:
             case "end":
-              return _context8.stop();
+              return _context9.stop();
           }
         }
-      }, _callee8, this);
+      }, _callee9, this);
     }));
 
     function claimLpRewards() {
@@ -107840,19 +108246,19 @@ var SdkReadWrite = /*#__PURE__*/function (_SdkRead) {
   }();
 
   _proto2.stake = /*#__PURE__*/function () {
-    var _stake = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee9(amount) {
-      return runtime_1.wrap(function _callee9$(_context9) {
+    var _stake = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee10(amount) {
+      return runtime_1.wrap(function _callee10$(_context10) {
         while (1) {
-          switch (_context9.prev = _context9.next) {
+          switch (_context10.prev = _context10.next) {
             case 0:
-              return _context9.abrupt("return", new StakingReadWrite(this._networkConnection).stake(amount));
+              return _context10.abrupt("return", new StakingReadWrite(this._networkConnection).stake(amount));
 
             case 1:
             case "end":
-              return _context9.stop();
+              return _context10.stop();
           }
         }
-      }, _callee9, this);
+      }, _callee10, this);
     }));
 
     function stake(_x6) {
@@ -107863,19 +108269,19 @@ var SdkReadWrite = /*#__PURE__*/function (_SdkRead) {
   }();
 
   _proto2.unstake = /*#__PURE__*/function () {
-    var _unstake = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee10(amount) {
-      return runtime_1.wrap(function _callee10$(_context10) {
+    var _unstake = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee11(amount) {
+      return runtime_1.wrap(function _callee11$(_context11) {
         while (1) {
-          switch (_context10.prev = _context10.next) {
+          switch (_context11.prev = _context11.next) {
             case 0:
-              return _context10.abrupt("return", new StakingReadWrite(this._networkConnection).unstake(amount));
+              return _context11.abrupt("return", new StakingReadWrite(this._networkConnection).unstake(amount));
 
             case 1:
             case "end":
-              return _context10.stop();
+              return _context11.stop();
           }
         }
-      }, _callee10, this);
+      }, _callee11, this);
     }));
 
     function unstake(_x7) {
@@ -107886,21 +108292,21 @@ var SdkReadWrite = /*#__PURE__*/function (_SdkRead) {
   }();
 
   _proto2.faucetDrip = /*#__PURE__*/function () {
-    var _faucetDrip = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee11() {
+    var _faucetDrip = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee12() {
       var faucet;
-      return runtime_1.wrap(function _callee11$(_context11) {
+      return runtime_1.wrap(function _callee12$(_context12) {
         while (1) {
-          switch (_context11.prev = _context11.next) {
+          switch (_context12.prev = _context12.next) {
             case 0:
               faucet = new ethers.Contract(networkAddresses.misc.FAUCET, FaucetABI.abi, this._networkConnection.provider);
-              return _context11.abrupt("return", faucet.connect(this._networkConnection.signer).drip());
+              return _context12.abrupt("return", faucet.connect(this._networkConnection.signer).drip());
 
             case 2:
             case "end":
-              return _context11.stop();
+              return _context12.stop();
           }
         }
-      }, _callee11, this);
+      }, _callee12, this);
     }));
 
     function faucetDrip() {
@@ -107971,6 +108377,9 @@ exports.Papermill = Papermill;
 exports.PapermillRead = PapermillRead;
 exports.PapermillReadWrite = PapermillReadWrite;
 exports.REWARD_CLAIM_START = REWARD_CLAIM_START;
+exports.Referral = Referral;
+exports.ReferralRead = ReferralRead;
+exports.ReferralReadWrite = ReferralReadWrite;
 exports.SDK = SDK;
 exports.SdkRead = SdkRead;
 exports.SdkReadWrite = SdkReadWrite;