@aurigami/sdk 1.3.4 → 1.3.5

package/README.md

@@ -1 +1,7 @@
 # Aurigami SDK
+
+# Testing
+
+For test that does not require hardhat, run `yarn test test/path_to_test`.
+
+For test that requires hardhat, run `yarn test-hardhat test-hardhat/path_to_test`.

package/dist/airdrop-lottery.d.ts

@@ -1,14 +1,24 @@
+import { TransactionResponse } from '@ethersproject/abstract-provider';
 import { BlockchainEntity, BlockchainEntityRead } from "./BlockchainEntity";
-import { NetworkConnection } from "./types";
+import { Address, NetworkConnection } from "./types";
+import { AuriAirdrop } from "@aurigami/contracts/typechain";
+import { TokenAmount } from "./tokenAmount";
 export declare class AirdropRead extends BlockchainEntityRead {
+    protected _airDrop: AuriAirdrop;
     private _whitelistedAddresses;
     private keepTrackers;
     constructor(networkConnection: NetworkConnection);
     countWhitelistedAddresses(): number;
     isWhitelisted(user: string): boolean;
     hasCompletedChallenge(user: string): Promise<boolean>;
+    getRedeemableReward(campaign: string, token: Address, user: Address): Promise<TokenAmount>;
+}
+export declare class AirdropReadWrite extends AirdropRead {
+    redeemMultiple(campaigns: string[], tokens: Address[]): Promise<TransactionResponse>;
+    redeemSingle(campaign: string, token: Address): Promise<TransactionResponse>;
 }
 export declare class Airdrop extends BlockchainEntity {
     constructor();
     read(networkConnection: NetworkConnection): AirdropRead;
+    readWrite(networkConnection: NetworkConnection): AirdropReadWrite;
 }

package/dist/helpers.d.ts

@@ -7,6 +7,7 @@ export declare const isSameAddress: (address1: Address, address2: Address) => bo
 export declare const getCurrentTimestamp: () => number;
 export declare function validateAndParseAddress(address: Address): Address;
 export declare function getDecimal(address: Address): number;
+export declare function getDecimalsViaContract(address: Address, provider: Provider): Promise<number>;
 export declare function calcLMRewardApr(rewardsValue: BigNumber, totalStakeValue: BigNumber, frequencyPerYear: number): BigNumber;
 export declare function getBlockTimestamp(provider: Provider, blockNumber: number): Promise<number>;
 export declare function getBlockBeforeTimestamp(provider: Provider, timestamp: number, startBlock?: number): Promise<number>;

package/dist/sdk.cjs.development.js

@@ -8,6 +8,7 @@ var BigNumber = _interopDefault(require('bignumber.js'));
 var ethers = require('ethers');
 var utils = require('ethers/lib/utils');
 var abstractSigner = require('@ethersproject/abstract-signer');
+var EIP20InterfaceABI = _interopDefault(require('@aurigami/contracts/artifacts/contracts/interfaces/EIP20Interface.sol/EIP20Interface.json'));
 var AuErc20ABI = _interopDefault(require('@aurigami/contracts/artifacts/contracts/AuErc20.sol/AuErc20.json'));
 var AuETHABI = _interopDefault(require('@aurigami/contracts/artifacts/contracts/AuETH.sol/AuETH.json'));
 var ComptrollerABI = _interopDefault(require('@aurigami/contracts/artifacts/contracts/Comptroller.sol/Comptroller.json'));
@@ -18,6 +19,8 @@ var TokenLockABI = _interopDefault(require('@aurigami/contracts/artifacts/contra
 var AuriFairLaunchABI = _interopDefault(require('@aurigami/contracts/artifacts/contracts/AuriFairLaunch.sol/AuriFairLaunch.json'));
 var FaucetABI = _interopDefault(require('@aurigami/contracts/artifacts/contracts/mock/Faucet.sol/Faucet.json'));
 var AuTokenABI = _interopDefault(require('@aurigami/contracts/artifacts/contracts/AuToken.sol/AuToken.json'));
+var AuriAirdropABI = _interopDefault(require('@aurigami/contracts/artifacts/contracts/AuriAirdrop.sol/AuriAirdrop.json'));
+var assert = _interopDefault(require('assert'));
 
 function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
   try {
@@ -963,7 +966,8 @@ var networkAddresses = {
     AURIFAIRLAUNCH: /*#__PURE__*/"0x9F9ceE911509abC6Af899c12ED625B0A6580D6e6".toLowerCase(),
     AURILENS: /*#__PURE__*/'0xC41a5C1625d492436600789469c1CE2eA20CEA6B'.toLowerCase(),
     TOKENLOCK: /*#__PURE__*/'0xDACC02a4Ff16Ea3c1515AdbfdCeb7B1F448B79c8'.toLowerCase(),
-    ETHREPAYHELPER: /*#__PURE__*/"0xa308A5003fA1A25BFdD9418FcEE51d48Dbe441e6".toLowerCase()
+    ETHREPAYHELPER: /*#__PURE__*/"0xa308A5003fA1A25BFdD9418FcEE51d48Dbe441e6".toLowerCase(),
+    AURI_AIRDROP: /*#__PURE__*/"0x6C42aA5b128B62D6CCf357726D7d13F3888335EC".toLowerCase()
   },
   tokens: {
     AURORA: /*#__PURE__*/"0x8bec47865ade3b172a928df8f990bc7f2a3b9f79".toLowerCase(),
@@ -1004,7 +1008,8 @@ var decimalRecords = {
   '0x8888682e24dd4df7b7ff2b91fccb575737e433bf': 8,
   '0xae4fac24dcdae0132c6d04f564dcf059616e9423': 8,
   '0xce4166363e3a584dac84a47bcd3414b43efcdd1c': 8,
-  '0xf4eb217ba2454613b15dbdea6e5f22276410e89e': 8
+  '0xf4eb217ba2454613b15dbdea6e5f22276410e89e': 8,
+  '0xc21ff01229e982d7c8b8691163b0a3cb8f357453': 24
 };
 
 function formatObject(object) {
@@ -1029,6 +1034,40 @@ function validateAndParseAddress(address) {
 function getDecimal(address) {
   return decimalRecords[address.toLowerCase()];
 }
+function getDecimalsViaContract(_x, _x2) {
+  return _getDecimalsViaContract.apply(this, arguments);
+}
+
+function _getDecimalsViaContract() {
+  _getDecimalsViaContract = _asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee(address, provider) {
+    var result, token;
+    return runtime_1.wrap(function _callee$(_context) {
+      while (1) {
+        switch (_context.prev = _context.next) {
+          case 0:
+            result = getDecimal(address);
+
+            if (!result) {
+              _context.next = 3;
+              break;
+            }
+
+            return _context.abrupt("return", result);
+
+          case 3:
+            token = new ethers.Contract(address, EIP20InterfaceABI.abi, provider);
+            return _context.abrupt("return", token.decimals());
+
+          case 5:
+          case "end":
+            return _context.stop();
+        }
+      }
+    }, _callee);
+  }));
+  return _getDecimalsViaContract.apply(this, arguments);
+}
+
 function calcLMRewardApr(rewardsValue, totalStakeValue, frequencyPerYear) {
   if (totalStakeValue.lte(0)) {
     return new BigNumber('999999999');
@@ -1036,71 +1075,71 @@ function calcLMRewardApr(rewardsValue, totalStakeValue, frequencyPerYear) {
 
   return rewardsValue.multipliedBy(frequencyPerYear).dividedBy(totalStakeValue);
 }
-function getBlockTimestamp(_x, _x2) {
+function getBlockTimestamp(_x3, _x4) {
   return _getBlockTimestamp.apply(this, arguments);
 }
 
 function _getBlockTimestamp() {
-  _getBlockTimestamp = _asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee(provider, blockNumber) {
+  _getBlockTimestamp = _asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee2(provider, blockNumber) {
     var block;
-    return runtime_1.wrap(function _callee$(_context) {
+    return runtime_1.wrap(function _callee2$(_context2) {
       while (1) {
-        switch (_context.prev = _context.next) {
+        switch (_context2.prev = _context2.next) {
           case 0:
-            _context.next = 2;
+            _context2.next = 2;
             return provider.getBlock(blockNumber);
 
           case 2:
-            block = _context.sent;
-            return _context.abrupt("return", block.timestamp);
+            block = _context2.sent;
+            return _context2.abrupt("return", block.timestamp);
 
           case 4:
           case "end":
-            return _context.stop();
+            return _context2.stop();
         }
       }
-    }, _callee);
+    }, _callee2);
   }));
   return _getBlockTimestamp.apply(this, arguments);
 }
 
-function getBlockBeforeTimestamp(_x3, _x4, _x5) {
+function getBlockBeforeTimestamp(_x5, _x6, _x7) {
   return _getBlockBeforeTimestamp.apply(this, arguments);
 }
 
 function _getBlockBeforeTimestamp() {
-  _getBlockBeforeTimestamp = _asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee2(provider, timestamp, startBlock) {
+  _getBlockBeforeTimestamp = _asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee3(provider, timestamp, startBlock) {
     var blockThreshold, K, leftBlock, rightBlock, size, promises, i, blockTimestamps, nextLeftBlock, _i, _i2;
 
-    return runtime_1.wrap(function _callee2$(_context2) {
+    return runtime_1.wrap(function _callee3$(_context3) {
       while (1) {
-        switch (_context2.prev = _context2.next) {
+        switch (_context3.prev = _context3.next) {
           case 0:
             blockThreshold = 50 * 10;
             K = 8;
             leftBlock = startBlock || 1;
-            _context2.next = 5;
+            _context3.next = 5;
             return provider.getBlockNumber();
 
           case 5:
-            rightBlock = _context2.sent;
-            _context2.next = 8;
+            rightBlock = _context3.sent;
+            _context3.next = 8;
             return getBlockTimestamp(provider, rightBlock);
 
           case 8:
-            _context2.t0 = _context2.sent;
-            _context2.t1 = timestamp;
+            _context3.t0 = _context3.sent;
+            _context3.t1 = timestamp;
 
-            if (!(_context2.t0 < _context2.t1)) {
-              _context2.next = 12;
+            if (!(_context3.t0 < _context3.t1)) {
+              _context3.next = 12;
               break;
             }
 
-            return _context2.abrupt("return", rightBlock);
+            return _context3.abrupt("return", rightBlock);
 
           case 12:
             if (!(rightBlock - leftBlock >= blockThreshold)) {
-              _context2.next = 25;
+              _context3.next = 25;
               break;
             }
 
@@ -1111,11 +1150,11 @@ function _getBlockBeforeTimestamp() {
               promises.push(getBlockTimestamp(provider, leftBlock + i * size));
             }
 
-            _context2.next = 18;
+            _context3.next = 18;
             return Promise.all(promises);
 
           case 18:
-            blockTimestamps = _context2.sent;
+            blockTimestamps = _context3.sent;
             nextLeftBlock = leftBlock;
 
             for (_i = 1; _i < K; _i++) {
@@ -1131,18 +1170,18 @@ function _getBlockBeforeTimestamp() {
             }
 
             leftBlock = nextLeftBlock;
-            _context2.next = 12;
+            _context3.next = 12;
             break;
 
           case 25:
-            return _context2.abrupt("return", leftBlock);
+            return _context3.abrupt("return", leftBlock);
 
           case 26:
           case "end":
-            return _context2.stop();
+            return _context3.stop();
         }
       }
-    }, _callee2);
+    }, _callee3);
   }));
   return _getBlockBeforeTimestamp.apply(this, arguments);
 }
@@ -106621,6 +106660,7 @@ var AirdropRead = /*#__PURE__*/function (_BlockchainEntityRead2) {
 
     _this2 = _BlockchainEntityRead2.call(this, networkConnection) || this;
     _this2.keepTrackers = [];
+    _this2._airDrop = new ethers.Contract(networkAddresses.misc.AURI_AIRDROP, AuriAirdropABI.abi, networkConnection.provider);
     _this2._whitelistedAddresses = new Set(AIRDROP_WHITELIST_ADDRESSES.map(function (e) {
       return e.toLocaleLowerCase();
     }));
@@ -106726,8 +106766,106 @@ var AirdropRead = /*#__PURE__*/function (_BlockchainEntityRead2) {
     return hasCompletedChallenge;
   }();
 
+  _proto2.getRedeemableReward = /*#__PURE__*/function () {
+    var _getRedeemableReward = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee5(campaign, token, user) {
+      var tokenInstance, rewards;
+      return runtime_1.wrap(function _callee5$(_context5) {
+        while (1) {
+          switch (_context5.prev = _context5.next) {
+            case 0:
+              tokenInstance = new Token(token, getDecimal(token));
+              _context5.next = 3;
+              return this._airDrop.getRedeemableReward(ethers.utils.formatBytes32String(campaign), token, user);
+
+            case 3:
+              rewards = _context5.sent;
+              return _context5.abrupt("return", new TokenAmount(tokenInstance, rewards.toString()));
+
+            case 5:
+            case "end":
+              return _context5.stop();
+          }
+        }
+      }, _callee5, this);
+    }));
+
+    function getRedeemableReward(_x5, _x6, _x7) {
+      return _getRedeemableReward.apply(this, arguments);
+    }
+
+    return getRedeemableReward;
+  }();
+
   return AirdropRead;
 }(BlockchainEntityRead);
+var AirdropReadWrite = /*#__PURE__*/function (_AirdropRead) {
+  _inheritsLoose(AirdropReadWrite, _AirdropRead);
+
+  function AirdropReadWrite() {
+    return _AirdropRead.apply(this, arguments) || this;
+  }
+
+  var _proto3 = AirdropReadWrite.prototype;
+
+  _proto3.redeemMultiple = /*#__PURE__*/function () {
+    var _redeemMultiple = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee6(campaigns, tokens) {
+      return runtime_1.wrap(function _callee6$(_context6) {
+        while (1) {
+          switch (_context6.prev = _context6.next) {
+            case 0:
+              assert(campaigns.length == tokens.length, "campaigns and tokens must have the same length");
+              _context6.t0 = this._airDrop.connect(this._networkConnection.signer);
+              _context6.t1 = campaigns.map(function (e) {
+                return ethers.utils.formatBytes32String(e);
+              });
+              _context6.t2 = tokens;
+              _context6.next = 6;
+              return this._networkConnection.signer.getAddress();
+
+            case 6:
+              _context6.t3 = _context6.sent;
+              return _context6.abrupt("return", _context6.t0.redeem.call(_context6.t0, _context6.t1, _context6.t2, _context6.t3));
+
+            case 8:
+            case "end":
+              return _context6.stop();
+          }
+        }
+      }, _callee6, this);
+    }));
+
+    function redeemMultiple(_x8, _x9) {
+      return _redeemMultiple.apply(this, arguments);
+    }
+
+    return redeemMultiple;
+  }();
+
+  _proto3.redeemSingle = /*#__PURE__*/function () {
+    var _redeemSingle = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/runtime_1.mark(function _callee7(campaign, token) {
+      return runtime_1.wrap(function _callee7$(_context7) {
+        while (1) {
+          switch (_context7.prev = _context7.next) {
+            case 0:
+              return _context7.abrupt("return", this.redeemMultiple([campaign], [token]));
+
+            case 1:
+            case "end":
+              return _context7.stop();
+          }
+        }
+      }, _callee7, this);
+    }));
+
+    function redeemSingle(_x10, _x11) {
+      return _redeemSingle.apply(this, arguments);
+    }
+
+    return redeemSingle;
+  }();
+
+  return AirdropReadWrite;
+}(AirdropRead);
 var Airdrop = /*#__PURE__*/function (_BlockchainEntity) {
   _inheritsLoose(Airdrop, _BlockchainEntity);
 
@@ -106735,12 +106873,16 @@ var Airdrop = /*#__PURE__*/function (_BlockchainEntity) {
     return _BlockchainEntity.call(this) || this;
   }
 
-  var _proto3 = Airdrop.prototype;
+  var _proto4 = Airdrop.prototype;
 
-  _proto3.read = function read(networkConnection) {
+  _proto4.read = function read(networkConnection) {
     return new AirdropRead(networkConnection);
   };
 
+  _proto4.readWrite = function readWrite(networkConnection) {
+    return new AirdropReadWrite(networkConnection);
+  };
+
   return Airdrop;
 }(BlockchainEntity);
 
@@ -106756,6 +106898,7 @@ exports.AURORA_CHAINID = AURORA_CHAINID;
 exports.AURPLYToken = AURPLYToken;
 exports.Airdrop = Airdrop;
 exports.AirdropRead = AirdropRead;
+exports.AirdropReadWrite = AirdropReadWrite;
 exports.AurPlyPid = AurPlyPid;
 exports.BORROW_LIMIT_BUFFER = BORROW_LIMIT_BUFFER;
 exports.BlockchainEntity = BlockchainEntity;
@@ -106804,6 +106947,7 @@ exports.getBlockBeforeTimestamp = getBlockBeforeTimestamp;
 exports.getBlockTimestamp = getBlockTimestamp;
 exports.getCurrentTimestamp = getCurrentTimestamp;
 exports.getDecimal = getDecimal;
+exports.getDecimalsViaContract = getDecimalsViaContract;
 exports.isSameAddress = isSameAddress;
 exports.networkAddresses = networkAddresses;
 exports.validateAndParseAddress = validateAndParseAddress;