@ref-finance/ref-sdk 1.4.9 → 1.5.0

package/README.md

@@ -6,11 +6,6 @@ Our SDK is provided by a third party, and we do not take any responsibility for
 This SDK is designed to assist developers when interacting with the main functions of the protocol. Main functions that can be defined as:
 
 - Trade: Swap tokens with our Automated Market Maker (AMM).
-- Pool: Add/Remove liquidity and earn revenue from swap fee (Coming soon)
-- Farm: Stale LP tokens into farms and earn liquidity incentives (Coming soon)
-- Boost Farm: Stake LOVE tokens to get boosted liquidity incentives (Coming soon)
-- Stake: Stake REF tokens to earn fees generated by the protocol (Coming soon)
-- Vote: Lock REF<>NEAR LP tokens to get veTokens and participate in the governance of the protocol and the allocation of liquidity incentives (Coming soon)
 
 ## Install
 
@@ -20,7 +15,7 @@ npm: `npm install @ref-finance/ref-sdk`
 
 ## Initialization
 
-Ref SDK identifies env variable NEAR_ENV or REACT_APP_REF_SDK_ENV to get global configuration.
+Rhea SDK identifies env variable NEAR_ENV or REACT_APP_REF_SDK_ENV to get global configuration.
 
 ```plain
 export function getConfig(
@@ -90,7 +85,7 @@ init_env('mainnet', '', 'https://beta.rpc.mainnet.near.org');
 
 
 
-## Ref V1 Swap
+## Rhea V1 Swap
 
 ### Tokens
 
@@ -750,11 +745,11 @@ Response
 
 
 
-## Ref Swap Widget
+## Rhea Swap Widget
 
 ### Description
 
-The Ref Swap Widget is a useful tool, allowing any third party service to access Ref's liquidity. Users of ecosystem dapps have the ability to swap via the Widget, without the need to go to Ref app, thus improving the user experience.
+The Rhea Swap Widget is a useful tool, allowing any third party service to access Rhea's liquidity. Users of ecosystem dapps have the ability to swap via the Widget, without the need to go to Rhea app, thus improving the user experience.
 
 Here are some use cases:
 
@@ -762,18 +757,18 @@ Here are some use cases:
 - Swapping tokens to lend, farm or stake
 - Swapping one token for a specific token, which can be used to buy a NFT in the associated marketplace
 
-Using the Ref Swap Widget, with a few customizations, developers can integrate the Swap funtion directly into their dapps. Both mobile and/or website version are available.
+Using the Rhea Swap Widget, with a few customizations, developers can integrate the Swap funtion directly into their dapps. Both mobile and/or website version are available.
 ![图片](https://user-images.githubusercontent.com/50706666/199178215-f2b184dc-f683-4740-af9f-fd67efd41503.png)
 
 For the default theme, developers can chose between the light mode and dark mode.
 
 More themes can be selected: [Click here to check them on figma](https://www.figma.com/file/v069nTXfE8pXDJQcDcC5wl/Swap-Widget?node-id=0%3A1).
 
-To integrate the Ref Swap Widget, please follow this guide.
+To integrate the Rhea Swap Widget, please follow this guide.
 
 ### Getting started
 
-A QuickStart of Ref Swap component.
+A QuickStart of Rhea Swap component.
 
 #### Props
 
@@ -807,7 +802,7 @@ export interface SwapWidgetProps {
 ```
 
 - theme: widget theme for customization.
-- defaultTokenList: default tokens with ref whitelist into  token list in the widget.
+- defaultTokenList: default tokens with Rhea whitelist into  token list in the widget.
 - onSwap: Swap button triggers this function.
 - width: width of widget component.
 - height: height of widget component.
@@ -817,7 +812,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 . 
+- 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.
@@ -967,7 +962,7 @@ export const Widget = ()=>{
 }
 ```
 
-### Integrating Ref Swap function using the SDK
+### Integrating Rhea Swap function using the SDK
 
 The SDK provides more flexibility/options.
 
@@ -983,11 +978,11 @@ SDK integration tips:
 - For a better user experience, before the execution of the swap, you can show more details about the swap (ex: fee, rate, route, etc.), allowing users to take better data-driven decisions.
 - You can redirect the user to the NEAR Explorer, once the transaction is confirmed.
 
-## Ref V2(DCL) Swap
+## Rhea V2(DCL) Swap
 
-#### An overview of Ref V2
+#### An overview of Rhea V2
 
-The launch of concentrated liquidity AMM is an achievement for Ref Finance. In collaboration with Izumi Finance and Arctic, Ref is glad to introduce discretized concentrated liquidity and limit order two new key features to the NEAR ecosystem. Using REF SDK, developers can dig more opportunities and implement various trading strategies.Before introducing SDK details, let's have an overview of V2 exciting features.
+The launch of concentrated liquidity AMM is an achievement for Rhea Finance. In collaboration with Izumi Finance and Arctic, Rhea is glad to introduce discretized concentrated liquidity and limit order two new key features to the NEAR ecosystem. Using Rhea SDK, developers can dig more opportunities and implement various trading strategies.Before introducing SDK details, let's have an overview of V2 exciting features.
 
 #### Discretized concentrated liquidity
 
@@ -1291,6 +1286,7 @@ interface DCLSwapProps {
     skip_unwrap_near: boolean;
   };
   AccountId: string;
+  referralId?: string;
 }
 ```
 
@@ -1321,6 +1317,7 @@ const res = await DCLSwap({
     pool_ids,
   },
 	AccountId,
+  referralId: 'ref-fee.testnet', // optional: referral ID to earn referral fees
 });
 ```
 
@@ -1375,6 +1372,7 @@ const res = await DCLSwap({
   	output_amount: "4.89454792",
   },
 	AccountId,
+  referralId: 'ref-fee.testnet', // optional: referral ID to earn referral fees
 });
 ```
 
@@ -1426,9 +1424,10 @@ const res = await DCLSwap({
   },
   LimitOrderWithSwap: {
   	pool_id,
- 		output_amount: "3217.929",
+		output_amount: "3217.929",
   },
 	AccountId,
+  referralId: 'ref-fee.testnet', // optional: referral ID to earn referral fees
 });
 ```
 
@@ -1484,6 +1483,7 @@ const res = await DCLSwap({
       stop_point: 405920,
    },
   AccountId,
+  referralId: 'ref-fee.testnet', // optional: referral ID to earn referral fees
 });
 ```
 
@@ -1526,6 +1526,7 @@ Parameters
   amountA: string;
   slippageTolerance: number;
   AccountId: string;
+  referralId?: string;
 }
 ```
 
@@ -1547,6 +1548,7 @@ const res = await DCLSwapByInputOnBestPool({
         amountA: "1",
         slippageTolerance: 0.1,
         AccountId,
+        referralId: 'ref-fee.testnet', // optional: referral ID to earn referral fees
     });
 ```
 

package/dist/dcl-swap/swap.d.ts

@@ -24,9 +24,10 @@ interface DCLSwapProps {
         skip_unwrap_near: boolean;
     };
     AccountId: string;
+    referralId?: string;
 }
 export declare const DCL_POOL_SPLITER = "|";
-export declare const DCLSwap: ({ Swap, SwapByOutput, LimitOrderWithSwap, SwapByStopPoint, AccountId, swapInfo, }: DCLSwapProps) => Promise<Transaction[]>;
+export declare const DCLSwap: ({ Swap, SwapByOutput, LimitOrderWithSwap, SwapByStopPoint, AccountId, swapInfo, referralId, }: DCLSwapProps) => Promise<Transaction[]>;
 export declare const quote: ({ pool_ids, input_amount, input_token, output_token, tag, }: {
     pool_ids: string[];
     input_token: TokenMetadata;
@@ -35,12 +36,13 @@ export declare const quote: ({ pool_ids, input_amount, input_token, output_token
     tag?: string | undefined;
 }) => Promise<any>;
 export declare const list_user_assets: (AccountId: string) => Promise<any>;
-export declare const DCLSwapByInputOnBestPool: ({ tokenA, tokenB, amountA, slippageTolerance, AccountId, }: {
+export declare const DCLSwapByInputOnBestPool: ({ tokenA, tokenB, amountA, slippageTolerance, AccountId, referralId, }: {
     tokenA: TokenMetadata;
     tokenB: TokenMetadata;
     amountA: string;
     slippageTolerance: number;
     AccountId: string;
+    referralId?: string | undefined;
 }) => Promise<Transaction[]>;
 export declare const quote_by_output: ({ pool_ids, output_amount, input_token, output_token, }: {
     pool_ids: string[];

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

@@ -7795,12 +7795,12 @@ function getDefaultTokenList() {
 var DCL_POOL_SPLITER = '|';
 var DCLSwap = /*#__PURE__*/function () {
   var _ref2 = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(_ref) {
-    var Swap, SwapByOutput, LimitOrderWithSwap, SwapByStopPoint, AccountId, swapInfo, transactions, tokenA, tokenB, amountA, pool_ids, tokenRegistered, output_token, min_output_amount, msg, _pool_ids, _output_token, output_amount, _msg, _tokenRegistered, pool_id, fee, buy_token, point, _tokenRegistered2, DCLRegistered, new_point, _msg2, _tokenRegistered3, _msg3, registered;
+    var Swap, SwapByOutput, LimitOrderWithSwap, SwapByStopPoint, AccountId, swapInfo, referralId, transactions, tokenA, tokenB, amountA, pool_ids, tokenRegistered, output_token, min_output_amount, msg, _pool_ids, _output_token, output_amount, _msg, _tokenRegistered, pool_id, fee, buy_token, point, _tokenRegistered2, DCLRegistered, new_point, _msg2, _tokenRegistered3, _msg3, registered;
     return _regeneratorRuntime().wrap(function _callee$(_context) {
       while (1) {
         switch (_context.prev = _context.next) {
           case 0:
-            Swap = _ref.Swap, SwapByOutput = _ref.SwapByOutput, LimitOrderWithSwap = _ref.LimitOrderWithSwap, SwapByStopPoint = _ref.SwapByStopPoint, AccountId = _ref.AccountId, swapInfo = _ref.swapInfo;
+            Swap = _ref.Swap, SwapByOutput = _ref.SwapByOutput, LimitOrderWithSwap = _ref.LimitOrderWithSwap, SwapByStopPoint = _ref.SwapByStopPoint, AccountId = _ref.AccountId, swapInfo = _ref.swapInfo, referralId = _ref.referralId;
             transactions = [];
             tokenA = swapInfo.tokenA, tokenB = swapInfo.tokenB, amountA = swapInfo.amountA;
             if (!Swap) {
@@ -7827,6 +7827,7 @@ var DCLSwap = /*#__PURE__*/function () {
                 pool_ids: pool_ids,
                 output_token: output_token,
                 min_output_amount: min_output_amount,
+                referral_id: referralId || '',
                 client_id: ''
               }
             });
@@ -7858,6 +7859,7 @@ var DCLSwap = /*#__PURE__*/function () {
                 pool_ids: _pool_ids,
                 output_token: _output_token,
                 output_amount: output_amount,
+                referral_id: referralId || '',
                 client_id: ''
               }
             });
@@ -7941,7 +7943,8 @@ var DCLSwap = /*#__PURE__*/function () {
                 pool_id: pool_id,
                 buy_token: buy_token,
                 point: new_point,
-                client_id: ''
+                client_id: '',
+                referral_id: referralId || ''
               }
             });
             transactions.push({
@@ -7977,7 +7980,9 @@ var DCLSwap = /*#__PURE__*/function () {
               });
             }
             _msg3 = JSON.stringify({
-              SwapByStopPoint: SwapByStopPoint
+              SwapByStopPoint: _extends({}, SwapByStopPoint, {
+                referral_id: referralId || ''
+              })
             });
             transactions.push({
               receiverId: tokenA.id,
@@ -8081,12 +8086,12 @@ var list_user_assets = /*#__PURE__*/function () {
 var DCLSwapByInputOnBestPool = /*#__PURE__*/function () {
   var _ref7 = /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee5(_ref6) {
     var _bestEstimate$tag, _bestEstimate$tag$spl, _bestEstimate$tag2, _bestEstimate$tag2$sp;
-    var tokenA, tokenB, amountA, slippageTolerance, AccountId, estimates, bestEstimate, bestFee;
+    var tokenA, tokenB, amountA, slippageTolerance, AccountId, referralId, estimates, bestEstimate, bestFee;
     return _regeneratorRuntime().wrap(function _callee5$(_context5) {
       while (1) {
         switch (_context5.prev = _context5.next) {
           case 0:
-            tokenA = _ref6.tokenA, tokenB = _ref6.tokenB, amountA = _ref6.amountA, slippageTolerance = _ref6.slippageTolerance, AccountId = _ref6.AccountId;
+            tokenA = _ref6.tokenA, tokenB = _ref6.tokenB, amountA = _ref6.amountA, slippageTolerance = _ref6.slippageTolerance, AccountId = _ref6.AccountId, referralId = _ref6.referralId;
             if (!(slippageTolerance <= 0 || slippageTolerance >= 100)) {
               _context5.next = 3;
               break;
@@ -8148,7 +8153,8 @@ var DCLSwapByInputOnBestPool = /*#__PURE__*/function () {
                 pool_ids: [getDCLPoolId(tokenA.id, tokenB.id, bestFee)],
                 min_output_amount: percentLess(slippageTolerance, bestEstimate.amount)
               },
-              AccountId: AccountId
+              AccountId: AccountId,
+              referralId: referralId
             }));
           case 11:
           case "end":