@ref-finance/ref-sdk 1.1.7 → 1.1.8

package/README.md

@@ -596,6 +596,7 @@ Parameters
   slippageTolerance: number;
   swapTodos: EstimateSwapView[];
   AccountId: string;
+  referralId?: string;
 }
 ```
 
@@ -608,7 +609,8 @@ const transactionsRef: Transaction[] = await instantSwap({
   amountIn: '1',
   swapTodos,
   slippageTolerance = 0.01,
-  AccountId: 'your-account-id.testnet'
+  AccountId: 'your-account-id.testnet',
+  referralId: 'ref-fee.testnet'
 });
 ```
 
@@ -623,7 +625,7 @@ Response
         args: {
           amount: '1000000000000000000',
           msg:
-            '{"force":0,"actions":[{"pool_id":38,"token_in":"ref.fakes.testnet","token_out":"wrap.testnet","amount_in":"1000000000000000000","min_amount_out":"730191122546589600000000"}]}',
+            '{"force":0,"referral_id":"ref-fee.testnet" ,"actions":[{"pool_id":38,"token_in":"ref.fakes.testnet","token_out":"wrap.testnet","amount_in":"1000000000000000000","min_amount_out":"730191122546589600000000"}]}',
           receiver_id: 'ref-finance-101.testnet',
         },
         gas: '180000000000000',
@@ -656,7 +658,7 @@ Parameters
 Example
 
 ```plain
-const signedTransactions:nearTransactions.SignedTransaction[] = getSignedTransactionsByMemoryKey({
+const signedTransactions:nearTransactions.SignedTransaction[] = await getSignedTransactionsByMemoryKey({
   transactionsRef;
   AccountId: "your-account-id.testnet",
   keyPath: "/.near-credentials/testnet/your-account-id.testnet.json"
@@ -781,6 +783,7 @@ export interface SwapWidgetProps {
     };
     defaultTokenIn?: string;
     defaultTokenOut?: string;
+    referralId?:string;
     transactionState?: {
         state: 'success' | 'fail' | null;
         tx?: string;
@@ -801,6 +804,7 @@ export interface SwapWidgetProps {
 - connection: connection to wallets, input { AccountId:"", isSignedIn:false } if wallet not connected.
 - defaultTokenIn: default token-in.
 - defaultTokenOut: default token-out.
+- referralId: You can get referral fee from every swap routed by your app. But make sure that your referral_id is in Ref's referral list. For the details, please check https://gov.ref.finance/t/contract-upgrade-1-7-0-referral-fee/823 . 
 - transactionState: entry to input transaction states after you send transactions.
   - state: denote if last transaction is failed or successfull.
   - setState: used to change setState to interact with pop-up.
@@ -1166,11 +1170,16 @@ const fee = 10000
 
 const pool_ids = [getDCLPoolId(tokenA, tokenB, fee)];
 
+const tokenAMetadata = await ftGetTokenMetadata(tokenA)
+
+const tokenBMetadata = await ftGetTokenMetadata(tokenB)
+
+
 const res = await quote({
         pool_ids,
         input_amount,
-        input_token: tokenA,
-        output_token: tokenB,
+        input_token: tokenAMetadata,
+        output_token: tokenBMetadata,
     });
 ```
 
@@ -1209,11 +1218,17 @@ const fee = 10000
 
 const pool_ids = [getDCLPoolId(tokenA, tokenB, fee)];
 
+const tokenAMetadata = await ftGetTokenMetadata(tokenA)
+
+const tokenBMetadata = await ftGetTokenMetadata(tokenB)
+
+
+
 const res = await quote_by_output({
         pool_ids,
         output_amount: "0.1",
-        input_token: tokenA,
-        output_token: tokenB,
+        input_token: tokenAMetadata,
+        output_token: tokenBMetadata,
     });
 ```
 
@@ -1271,11 +1286,16 @@ const fee = 2000
 
 const pool_ids = [getDCLPoolId(tokenA, tokenB, fee)];
 
+const tokenAMetadata = await ftGetTokenMetadata(tokenA)
+
+const tokenBMetadata = await ftGetTokenMetadata(tokenB)
+
+
 const res = await DCLSwap({
   swapInfo: {
     amountA: input_amount,
-    tokenA: tokenA,
-    tokenB: tokenB,
+    tokenA: tokenAMetadata,
+    tokenB: tokenBMetadata,
   },
   Swap: {
     min_output_amount: "0",
@@ -1317,13 +1337,19 @@ const tokenB = "wrap.testnet";
 
 const fee = 2000
 
+
+const tokenAMetadata = await ftGetTokenMetadata(tokenA)
+
+const tokenBMetadata = await ftGetTokenMetadata(tokenB)
+
+
 const pool_ids = [getDCLPoolId(tokenA, tokenB, fee)];
 
 const res = await DCLSwap({
   swapInfo: {
     amountA: input_amount,
-    tokenA: tokenA,
-    tokenB: tokenB,
+    tokenA: tokenAMetadata,
+    tokenB: tokenBMetadata,
   },
   SwapByOutput: {
   	pool_ids,
@@ -1367,11 +1393,17 @@ const fee = 2000
 
 const pool_ids = [getDCLPoolId(tokenA, tokenB, fee)];
 
+
+const tokenAMetadata = await ftGetTokenMetadata(tokenA)
+
+const tokenBMetadata = await ftGetTokenMetadata(tokenB)
+
+
 const res = await DCLSwap({
   swapInfo: {
     amountA: input_amount,
-    tokenA: tokenA,
-    tokenB: tokenB,
+    tokenA: tokenAMetadata,
+    tokenB: tokenBMetadata,
   },
   LimitOrderWithSwap: {
   	pool_id,
@@ -1430,9 +1462,14 @@ const tokenA = "usdt.fakes.testnet";
 
 const tokenB = "wrap.testnet";
 
+const tokenAMetadata = await ftGetTokenMetadata(tokenA)
+
+const tokenBMetadata = await ftGetTokenMetadata(tokenB)
+
+
 const res = await DCLSwapByInputOnBestPool({
-        tokenA,
-        tokenB,
+        tokenA:tokenAMetadata,
+        tokenB:tokenBMetadata,
         amountA: "1",
         slippageTolerance: 0.1,
         AccountId,

package/dist/ref-sdk.cjs.development.js

@@ -7,7 +7,6 @@ function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'defau
 var nearApiJs = require('near-api-js');
 var BN = _interopDefault(require('bn.js'));
 var fs = _interopDefault(require('fs'));
-var os = _interopDefault(require('os'));
 var _ = require('lodash');
 var ___default = _interopDefault(_);
 var math = require('mathjs');
@@ -52,7 +51,7 @@ function getConfig(env) {
         REF_TOKEN_ID: 'token.v2.ref-finance.near',
         indexerUrl: 'https://indexer.ref.finance',
         explorerUrl: 'https://testnet.nearblocks.io',
-        REF_DCL_SWAP_CONTRACT_ID: ''
+        REF_DCL_SWAP_CONTRACT_ID: 'dcl.ref-labs.near'
       };
     case 'testnet':
       return {
@@ -64,7 +63,7 @@ function getConfig(env) {
         REF_FI_CONTRACT_ID: 'ref-finance-101.testnet',
         REF_TOKEN_ID: 'ref.fakes.testnet',
         explorerUrl: 'https://testnet.nearblocks.io',
-        REF_DCL_SWAP_CONTRACT_ID: 'dcl.ref-dev.testnet'
+        REF_DCL_SWAP_CONTRACT_ID: 'dclv1.ref-dev.testnet'
       };
     default:
       return {
@@ -76,7 +75,7 @@ function getConfig(env) {
         REF_TOKEN_ID: 'token.v2.ref-finance.near',
         indexerUrl: 'https://indexer.ref.finance',
         explorerUrl: 'https://nearblocks.io',
-        REF_DCL_SWAP_CONTRACT_ID: ''
+        REF_DCL_SWAP_CONTRACT_ID: 'dcl.ref-labs.near'
       };
   }
 }
@@ -3661,42 +3660,42 @@ var provider = /*#__PURE__*/new nearApiJs.providers.JsonRpcProvider({
 });
 var getMemorySigner = /*#__PURE__*/function () {
   var _ref2 = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(_ref) {
-    var AccountId, keyPath, homedir, credentials, credentialAccountId, myKeyStore, signer;
+    var AccountId, keyPath, credentials, credentialAccountId, myKeyStore, signer;
     return _regeneratorRuntime().wrap(function _callee$(_context) {
       while (1) {
         switch (_context.prev = _context.next) {
           case 0:
             AccountId = _ref.AccountId, keyPath = _ref.keyPath;
             _context.prev = 1;
-            homedir = os.homedir();
-            credentials = JSON.parse(fs.readFileSync(homedir + keyPath).toString());
+            // const homedir = os.homedir();
+            credentials = JSON.parse(fs.readFileSync(keyPath).toString());
             credentialAccountId = credentials == null ? void 0 : credentials.account_id;
             if (credentialAccountId) {
-              _context.next = 7;
+              _context.next = 6;
               break;
             }
             throw NoCredential;
-          case 7:
+          case 6:
             if (!(credentialAccountId !== AccountId)) {
-              _context.next = 9;
+              _context.next = 8;
               break;
             }
             throw AccountIdMisMatch;
-          case 9:
+          case 8:
             myKeyStore = new nearApiJs.keyStores.InMemoryKeyStore();
             myKeyStore.setKey(getConfig().networkId, AccountId, nearApiJs.KeyPair.fromString(credentials.private_key));
             signer = new nearApiJs.InMemorySigner(myKeyStore);
             return _context.abrupt("return", signer);
-          case 15:
-            _context.prev = 15;
+          case 14:
+            _context.prev = 14;
             _context.t0 = _context["catch"](1);
             throw _context.t0;
-          case 18:
+          case 17:
           case "end":
             return _context.stop();
         }
       }
-    }, _callee, null, [[1, 15]]);
+    }, _callee, null, [[1, 14]]);
   }));
   return function getMemorySigner(_x) {
     return _ref2.apply(this, arguments);
@@ -4295,12 +4294,12 @@ var OrderNoRemainedAmount = /*#__PURE__*/formatError('No remained amount on this
 var instantSwap = /*#__PURE__*/function () {
   var _ref2 = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee2(_ref) {
     var _swapTodos;
-    var tokenIn, tokenOut, amountIn, slippageTolerance, swapTodos, AccountId, transactions, registerToken, registered, actionsList, allSwapsTokens, i, swapTokens;
+    var tokenIn, tokenOut, amountIn, slippageTolerance, swapTodos, AccountId, referralId, transactions, registerToken, registered, actionsList, allSwapsTokens, i, swapTokens;
     return _regeneratorRuntime().wrap(function _callee2$(_context2) {
       while (1) {
         switch (_context2.prev = _context2.next) {
           case 0:
-            tokenIn = _ref.tokenIn, tokenOut = _ref.tokenOut, amountIn = _ref.amountIn, slippageTolerance = _ref.slippageTolerance, swapTodos = _ref.swapTodos, AccountId = _ref.AccountId;
+            tokenIn = _ref.tokenIn, tokenOut = _ref.tokenOut, amountIn = _ref.amountIn, slippageTolerance = _ref.slippageTolerance, swapTodos = _ref.swapTodos, AccountId = _ref.AccountId, referralId = _ref.referralId;
             transactions = [];
             if (!((swapTodos == null ? void 0 : (_swapTodos = swapTodos[(swapTodos == null ? void 0 : swapTodos.length) - 1]) == null ? void 0 : _swapTodos.outputToken) !== tokenOut.id)) {
               _context2.next = 4;
@@ -4407,7 +4406,11 @@ var instantSwap = /*#__PURE__*/function () {
                 args: {
                   receiver_id: exports.REF_FI_CONTRACT_ID,
                   amount: toNonDivisibleNumber(tokenIn.decimals, amountIn),
-                  msg: JSON.stringify({
+                  msg: !!referralId ? JSON.stringify({
+                    force: 0,
+                    actions: actionsList,
+                    referral_id: referralId
+                  }) : JSON.stringify({
                     force: 0,
                     actions: actionsList
                   })
@@ -4657,7 +4660,7 @@ var fetchAllPools = /*#__PURE__*/function () {
   };
 }();
 
-var _excluded = ["slippageTolerance", "refreshTrigger", "onSwap", "AccountId", "poolFetchingState"];
+var _excluded = ["slippageTolerance", "refreshTrigger", "onSwap", "AccountId", "poolFetchingState", "referralId"];
 var ThemeContext = /*#__PURE__*/React.createContext(defaultTheme);
 var ThemeContextProvider = function ThemeContextProvider(_ref) {
   var customTheme = _ref.customTheme,
@@ -4835,6 +4838,7 @@ var useSwap = function useSwap(params) {
     onSwap = params.onSwap,
     AccountId = params.AccountId,
     poolFetchingState = params.poolFetchingState,
+    referralId = params.referralId,
     swapParams = _objectWithoutPropertiesLoose(params, _excluded);
   var tokenIn = params.tokenIn,
     tokenOut = params.tokenOut,
@@ -4880,7 +4884,8 @@ var useSwap = function useSwap(params) {
                 amountIn: params.amountIn,
                 swapTodos: estimates,
                 slippageTolerance: slippageTolerance,
-                AccountId: AccountId || ''
+                AccountId: AccountId || '',
+                referralId: referralId
               });
             case 4:
               transactionsRef = _context3.sent;
@@ -6261,7 +6266,8 @@ var SwapWidget = function SwapWidget(props) {
     defaultTokenIn = props.defaultTokenIn,
     defaultTokenOut = props.defaultTokenOut,
     onDisConnect = props.onDisConnect,
-    darkMode = props.darkMode;
+    darkMode = props.darkMode,
+    referralId = props.referralId;
   var curTheme = theme || (darkMode ? defaultDarkModeTheme : defaultTheme);
   var STORAGED_TOKEN_IN = localStorage.getItem(REF_WIDGET_SWAP_IN_KEY);
   var STORAGED_TOKEN_OUT = localStorage.getItem(REF_WIDGET_SWAP_OUT_KEY);
@@ -6414,7 +6420,8 @@ var SwapWidget = function SwapWidget(props) {
       onSwap: onSwap,
       AccountId: AccountId,
       refreshTrigger: refreshTrigger,
-      poolFetchingState: poolFetchingState
+      poolFetchingState: poolFetchingState,
+      referralId: referralId
     }),
     amountOut = _useSwap.amountOut,
     minAmountOut = _useSwap.minAmountOut,