@avalabs/core-paraswap-sdk 2.8.0-alpha.197

package/LICENSE

@@ -0,0 +1,9 @@
+Copyright (C) 2021, Ava Labs, Inc. All rights reserved.
+
+Subject to the limited license below (**”License””), you may not, and you may not permit anyone else to, copy, reproduce, aggregate, republish, download, post, distribute, license, sublicense, reverse engineer, modify, or create derivative works based on this software (collectively, **“Software”**). 
+
+You are hereby granted a limited, non-exclusive, non-sublicensable and non-transferable license to download and use the Software as-is solely (i) for use in connection with the Avalanche Public Blockchain platform, having a NetworkID of 1 (Mainnet) or 5 (Fuji), and associated blockchains, comprised exclusively of the Avalanche X-Chain, C-Chain, P-Chain and any subnets linked to the P-Chain (**“Avalanche Authorized Platform”**) or (ii) for non-production, testing or research purposes without any commercial application within the Avalanche ecosystem (**“Non-Commercial Use”**); provided that, in each case, you may not use or allow use of the Software (a) in connection with any forks of the Avalanche Authorized Platform, (b) in any manner not operationally connected to the Avalanche Authorized Platform other than for Non-Commercial Use, or (c) to the extent the number of monthly active users or the number of total installs of any software that uses the Software across all versions thereof exceeds 10,000 at any time. You may not modify or alter the Software in any way.
+
+You hereby acknowledge and agree to the terms set forth at www.avalabs.org/important-notice.
+
+**TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED ON AN “AS IS” BASIS, AND AVA LABS EXPRESSLY DISCLAIMS AND EXCLUDES ALL REPRESENTATIONS, WARRANTIES AND OTHER TERMS AND CONDITIONS, WHETHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION BY OPERATION OF LAW OR BY CUSTOM, STATUTE OR OTHERWISE, AND INCLUDING, BUT NOT LIMITED TO, ANY IMPLIED WARRANTY, TERM, OR CONDITION OF NON-INFRINGEMENT, MERCHANTABILITY, TITLE, OR FITNESS FOR PARTICULAR PURPOSE. YOU USE THE SOFTWARE AT YOUR OWN RISK. AVA LABS EXPRESSLY DISCLAIMS ALL LIABILITY (INCLUDING FOR ALL DIRECT, CONSEQUENTIAL OR OTHER DAMAGES OR LOSSES) RELATED TO ANY USE OF THE SOFTWARE.**

package/README.md

@@ -0,0 +1,5 @@
+# Parawap SDK
+
+This SDK enables you to use `performSwap` function which encapsulates whole swap process using Paraswap api.
+This includes checking input values, computing necessary parameters, getting spend allowance on ERC-20 tokens, building,
+signing and sending transaction to blockchain.

package/dist/index.d.ts

@@ -0,0 +1,62 @@
+import { OptimalRate } from 'paraswap-core';
+import { BitcoinInputUTXO, BitcoinOutputUTXO, JsonRpcBatchInternal } from '@avalabs/core-wallets-sdk';
+import { TransactionRequest } from 'ethers';
+import { Network } from '@avalabs/chains-sdk';
+
+/**
+ * Paraswap may return both data and an error sometimes.
+ * @see https://app.swaggerhub.com/apis/paraswapv5/api/1.0#/PriceRouteWithError
+ */
+type ParaswapPricesResponseWithError = {
+    error: string;
+    priceRoute?: OptimalRate;
+};
+type ParaswapPricesSuccessResponse = {
+    error: never;
+    priceRoute: OptimalRate;
+};
+type ParaswapPricesResponse = ParaswapPricesSuccessResponse | ParaswapPricesResponseWithError;
+/**
+ * Paraswap API errors after which it may be useful to retry the request.
+ *
+ * @see https://app.swaggerhub.com/apis/paraswapv5/api/1.0#/PriceErrorMessage
+ */
+declare const PARASWAP_RETRYABLE_ERRORS: string[];
+declare const hasParaswapError: (response: ParaswapPricesResponse) => response is ParaswapPricesResponseWithError;
+type SignTransactionRequest = TransactionRequest | BtcTransactionRequest | AvalancheTransactionRequest;
+interface BtcTransactionRequest {
+    inputs: BitcoinInputUTXO[];
+    outputs: BitcoinOutputUTXO[];
+}
+interface AvalancheTransactionRequest {
+    tx: Buffer;
+    chain: 'X' | 'P' | 'C';
+}
+
+type TransactionSender = (signedTx: string) => Promise<string>;
+
+type TransactionSigner = (tx: TransactionRequest) => Promise<string>;
+
+type PerformSwapParams = {
+    srcTokenAddress: string | undefined;
+    isSrcTokenNative: boolean;
+    destTokenAddress: string | undefined;
+    isDestTokenNative: boolean;
+    priceRoute: OptimalRate | undefined;
+    gasLimit: number | undefined;
+    slippage: number;
+    activeNetwork: Network | undefined;
+    provider: JsonRpcBatchInternal;
+    transactionSend: TransactionSender;
+    transactionSign: TransactionSigner;
+    userAddress: string | undefined;
+    networkGasPrice: bigint;
+    maxFeePerGas?: bigint;
+    maxPriorityFeePerGas?: bigint;
+};
+declare function performSwap({ srcTokenAddress, isSrcTokenNative, destTokenAddress, isDestTokenNative, priceRoute, gasLimit, maxFeePerGas, maxPriorityFeePerGas, slippage, activeNetwork, provider, transactionSend, transactionSign, userAddress, networkGasPrice, }: PerformSwapParams): Promise<{
+    swapTxHash: string;
+    approveTxHash: string | undefined;
+}>;
+
+export { AvalancheTransactionRequest, BtcTransactionRequest, PARASWAP_RETRYABLE_ERRORS, ParaswapPricesResponse, ParaswapPricesResponseWithError, ParaswapPricesSuccessResponse, PerformSwapParams, SignTransactionRequest, TransactionSender, TransactionSigner, hasParaswapError, performSwap };

package/dist/index.js

@@ -0,0 +1 @@
+"use strict";var e=require("@openzeppelin/contracts/build/contracts/ERC20.json"),r=require("big.js"),t=require("bn.js"),s=require("paraswap"),a=require("@avalabs/core-utils-sdk"),n=require("@avalabs/chains-sdk"),o=require("web3"),i=require("assert"),c=require("ethers");const d=new s.ParaSwap(n.ChainId.AVALANCHE_MAINNET_ID,void 0,new o);exports.PARASWAP_RETRYABLE_ERRORS=["Price Timeout","An error has occurred, please try again later or contact our support"],exports.hasParaswapError=e=>"string"==typeof e.error,exports.performSwap=async function({srcTokenAddress:o,isSrcTokenNative:p,destTokenAddress:u,isDestTokenNative:w,priceRoute:m,gasLimit:l,maxFeePerGas:A,maxPriorityFeePerGas:h,slippage:E,activeNetwork:f,provider:v,transactionSend:T,transactionSign:k,userAddress:g,networkGasPrice:R}){i(o,"no source token on request"),i(u,"no destination token on request"),i(m,"request requires the paraswap priceRoute"),i(l,"request requires gas limit from paraswap response"),i(g,"Wallet Error: address not defined"),i(R,"network gas price not defined"),i(f,"Network Init Error: Wrong network"),i(!f.isTestnet,"Network Init Error: Wrong network");const S=await async function(){const e=await fetch(`${d.apiURL}/adapters/contracts?network=${n.ChainId.AVALANCHE_MAINNET_ID}`);return(await e.json()).TokenTransferProxy}(),x=p?s.ETHER_ADDRESS:o,P=w?s.ETHER_ADDRESS:u,D=R;let q;const I=new r(m.destAmount).times(1-E/100).toFixed(0),y=new r(m.srcAmount).times(1+E/100).toFixed(0),N="SELL"===m.side?m.srcAmount:y,L="SELL"===m.side?I:m.destAmount;let $=await v.getTransactionCount(g);if(!p){const r=new c.Contract(x,e.abi,v),[t,s]=await a.resolve(r.allowance(g,S));if(s||null===t)throw new Error(`Allowance Error: ${s}`);if(t<BigInt(N)){const[e]=await a.resolve(r.approve.estimateGas(S,N)),{data:t}=await r.approve.populateTransaction(S,N),[s,n]=await a.resolve(k({nonce:$,chainId:f.chainId,maxFeePerGas:D,gasPrice:D,gasLimit:e||BigInt(l),data:t,to:x}));if(!s||n)throw new Error(`Approve Error: ${n}`);const[o,c]=await a.resolve(T(s));if(c)throw new Error(`Approve Error: ${c}`);i(o,"Tx hash empty"),$++,q=o}else q=void 0}const[b,F]=await a.resolve(a.promiseResolveWithBackoff((()=>async function({network:e,srcToken:r,destToken:t,srcAmount:s,destAmount:a,priceRoute:n,userAddress:o,partner:i,partnerAddress:c,partnerFeeBps:p,receiver:u,options:w,srcDecimals:m,destDecimals:l,permit:A,deadline:h}){const E=new URLSearchParams(w),f=`${d.apiURL}/transactions/${e}/?${E.toString()}`,v={priceRoute:n,srcToken:r,destToken:t,srcAmount:s,destAmount:a,userAddress:o,partner:i,partnerAddress:c,partnerFeeBps:p,receiver:u,srcDecimals:m,destDecimals:l,permit:A,deadline:h},T=await fetch(f,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify(v)});return await T.json()}({network:f.chainId.toString(),srcToken:x,destToken:P,srcAmount:N,destAmount:L,priceRoute:m,userAddress:g,partner:"Avalanche",partnerAddress:undefined,partnerFeeBps:undefined,receiver:undefined,options:undefined,srcDecimals:m.srcDecimals,destDecimals:m.destDecimals,permit:undefined,deadline:undefined})),(function(e){return"Server too busy"===e.message||e.error}),0,10));if(!b||F||"message"in b)throw new Error(`Data Error: ${F}`);const[B,C]=await a.resolve(k({nonce:$,chainId:f.chainId,maxFeePerGas:A??D,maxPriorityFeePerGas:h,gasLimit:Number(b.gas),data:b.data,to:b.to,value:p?`0x${new t.BN(N).toString("hex")}`:void 0}));if(!B||C)throw new Error(`Tx Error: ${C}`);const[_,G]=await a.resolve(T(B));if(G)throw new Error(`Tx Error: ${G}`);return i(_,"Tx hash empty"),{swapTxHash:_,approveTxHash:q}};

package/esm/index.d.ts

@@ -0,0 +1,4 @@
+export { AvalancheTransactionRequest, BtcTransactionRequest, PARASWAP_RETRYABLE_ERRORS, ParaswapPricesResponse, ParaswapPricesResponseWithError, ParaswapPricesSuccessResponse, SignTransactionRequest, hasParaswapError } from './models.js';
+export { PerformSwapParams, performSwap } from './performSwap.js';
+export { TransactionSender } from './types/TransactionSender.js';
+export { TransactionSigner } from './types/TransactionSigner.js';

package/esm/index.js

@@ -0,0 +1 @@
+export{PARASWAP_RETRYABLE_ERRORS,hasParaswapError}from"./models.js";export{performSwap}from"./performSwap.js";

package/esm/models.d.ts

@@ -0,0 +1,35 @@
+import { OptimalRate } from 'paraswap-core';
+import { BitcoinInputUTXO, BitcoinOutputUTXO } from '@avalabs/core-wallets-sdk';
+import { TransactionRequest } from 'ethers';
+
+/**
+ * Paraswap may return both data and an error sometimes.
+ * @see https://app.swaggerhub.com/apis/paraswapv5/api/1.0#/PriceRouteWithError
+ */
+type ParaswapPricesResponseWithError = {
+    error: string;
+    priceRoute?: OptimalRate;
+};
+type ParaswapPricesSuccessResponse = {
+    error: never;
+    priceRoute: OptimalRate;
+};
+type ParaswapPricesResponse = ParaswapPricesSuccessResponse | ParaswapPricesResponseWithError;
+/**
+ * Paraswap API errors after which it may be useful to retry the request.
+ *
+ * @see https://app.swaggerhub.com/apis/paraswapv5/api/1.0#/PriceErrorMessage
+ */
+declare const PARASWAP_RETRYABLE_ERRORS: string[];
+declare const hasParaswapError: (response: ParaswapPricesResponse) => response is ParaswapPricesResponseWithError;
+type SignTransactionRequest = TransactionRequest | BtcTransactionRequest | AvalancheTransactionRequest;
+interface BtcTransactionRequest {
+    inputs: BitcoinInputUTXO[];
+    outputs: BitcoinOutputUTXO[];
+}
+interface AvalancheTransactionRequest {
+    tx: Buffer;
+    chain: 'X' | 'P' | 'C';
+}
+
+export { AvalancheTransactionRequest, BtcTransactionRequest, PARASWAP_RETRYABLE_ERRORS, ParaswapPricesResponse, ParaswapPricesResponseWithError, ParaswapPricesSuccessResponse, SignTransactionRequest, hasParaswapError };

package/esm/models.js

@@ -0,0 +1 @@
+const r=["Price Timeout","An error has occurred, please try again later or contact our support"],o=r=>"string"==typeof r.error;export{r as PARASWAP_RETRYABLE_ERRORS,o as hasParaswapError};

package/esm/paraswapUtils.js

@@ -0,0 +1 @@
+import{ParaSwap as e}from"paraswap";import{ChainId as r}from"@avalabs/chains-sdk";import t from"web3";const s=new e(r.AVALANCHE_MAINNET_ID,void 0,new t);async function n({network:e,srcToken:r,destToken:t,srcAmount:n,destAmount:a,priceRoute:o,userAddress:i,partner:c,partnerAddress:p,partnerFeeBps:d,receiver:m,options:A,srcDecimals:u,destDecimals:w,permit:T,deadline:f}){const k=new URLSearchParams(A),l=`${s.apiURL}/transactions/${e}/?${k.toString()}`,N={priceRoute:o,srcToken:r,destToken:t,srcAmount:n,destAmount:a,userAddress:i,partner:c,partnerAddress:p,partnerFeeBps:d,receiver:m,srcDecimals:u,destDecimals:w,permit:T,deadline:f},h=await fetch(l,{method:"POST",headers:{"Content-Type":"application/json"},body:JSON.stringify(N)});return await h.json()}async function a(){const e=await fetch(`${s.apiURL}/adapters/contracts?network=${r.AVALANCHE_MAINNET_ID}`);return(await e.json()).TokenTransferProxy}export{n as buildTx,a as getParaswapSpender};

package/esm/performSwap.d.ts

@@ -0,0 +1,29 @@
+import { Network } from '@avalabs/chains-sdk';
+import { JsonRpcBatchInternal } from '@avalabs/core-wallets-sdk';
+import { OptimalRate } from 'paraswap-core';
+import { TransactionSender } from './types/TransactionSender.js';
+import { TransactionSigner } from './types/TransactionSigner.js';
+
+type PerformSwapParams = {
+    srcTokenAddress: string | undefined;
+    isSrcTokenNative: boolean;
+    destTokenAddress: string | undefined;
+    isDestTokenNative: boolean;
+    priceRoute: OptimalRate | undefined;
+    gasLimit: number | undefined;
+    slippage: number;
+    activeNetwork: Network | undefined;
+    provider: JsonRpcBatchInternal;
+    transactionSend: TransactionSender;
+    transactionSign: TransactionSigner;
+    userAddress: string | undefined;
+    networkGasPrice: bigint;
+    maxFeePerGas?: bigint;
+    maxPriorityFeePerGas?: bigint;
+};
+declare function performSwap({ srcTokenAddress, isSrcTokenNative, destTokenAddress, isDestTokenNative, priceRoute, gasLimit, maxFeePerGas, maxPriorityFeePerGas, slippage, activeNetwork, provider, transactionSend, transactionSign, userAddress, networkGasPrice, }: PerformSwapParams): Promise<{
+    swapTxHash: string;
+    approveTxHash: string | undefined;
+}>;
+
+export { PerformSwapParams, performSwap };

package/esm/performSwap.js

@@ -0,0 +1 @@
+import e from"@openzeppelin/contracts/build/contracts/ERC20.json";import r from"big.js";import{BN as t}from"bn.js";import{ETHER_ADDRESS as o}from"paraswap";import{resolve as a,promiseResolveWithBackoff as n}from"@avalabs/core-utils-sdk";import{getParaswapSpender as s,buildTx as i}from"./paraswapUtils.js";import d from"assert";import{Contract as c}from"ethers";async function p({srcTokenAddress:p,isSrcTokenNative:m,destTokenAddress:w,isDestTokenNative:u,priceRoute:f,gasLimit:l,maxFeePerGas:h,maxPriorityFeePerGas:g,slippage:E,activeNetwork:k,provider:v,transactionSend:x,transactionSign:A,userAddress:T,networkGasPrice:I}){d(p,"no source token on request"),d(w,"no destination token on request"),d(f,"request requires the paraswap priceRoute"),d(l,"request requires gas limit from paraswap response"),d(T,"Wallet Error: address not defined"),d(I,"network gas price not defined"),d(k,"Network Init Error: Wrong network"),d(!k.isTestnet,"Network Init Error: Wrong network");const P=await s(),F=m?o:p,S=u?o:w,b=I;let G;const L=new r(f.destAmount).times(1-E/100).toFixed(0),$=new r(f.srcAmount).times(1+E/100).toFixed(0),q="SELL"===f.side?f.srcAmount:$,y="SELL"===f.side?L:f.destAmount;let D=await v.getTransactionCount(T);if(!m){const r=new c(F,e.abi,v),[t,o]=await a(r.allowance(T,P));if(o||null===t)throw new Error(`Allowance Error: ${o}`);if(t<BigInt(q)){const[e]=await a(r.approve.estimateGas(P,q)),{data:t}=await r.approve.populateTransaction(P,q),[o,n]=await a(A({nonce:D,chainId:k.chainId,maxFeePerGas:b,gasPrice:b,gasLimit:e||BigInt(l),data:t,to:F}));if(!o||n)throw new Error(`Approve Error: ${n}`);const[s,i]=await a(x(o));if(i)throw new Error(`Approve Error: ${i}`);d(s,"Tx hash empty"),D++,G=s}else G=void 0}const[N,j]=await a(n((()=>i({network:k.chainId.toString(),srcToken:F,destToken:S,srcAmount:q,destAmount:y,priceRoute:f,userAddress:T,partner:"Avalanche",partnerAddress:undefined,partnerFeeBps:undefined,receiver:undefined,options:undefined,srcDecimals:f.srcDecimals,destDecimals:f.destDecimals,permit:undefined,deadline:undefined})),(function(e){return"Server too busy"===e.message||e.error}),0,10));if(!N||j||"message"in N)throw new Error(`Data Error: ${j}`);const[R,B]=await a(A({nonce:D,chainId:k.chainId,maxFeePerGas:h??b,maxPriorityFeePerGas:g,gasLimit:Number(N.gas),data:N.data,to:N.to,value:m?`0x${new t(q).toString("hex")}`:void 0}));if(!R||B)throw new Error(`Tx Error: ${B}`);const[W,C]=await a(x(R));if(C)throw new Error(`Tx Error: ${C}`);return d(W,"Tx hash empty"),{swapTxHash:W,approveTxHash:G}}export{p as performSwap};

package/esm/types/TransactionSender.d.ts

@@ -0,0 +1,3 @@
+type TransactionSender = (signedTx: string) => Promise<string>;
+
+export { TransactionSender };

package/esm/types/TransactionSigner.d.ts

@@ -0,0 +1,5 @@
+import { TransactionRequest } from 'ethers';
+
+type TransactionSigner = (tx: TransactionRequest) => Promise<string>;
+
+export { TransactionSigner };

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@avalabs/core-paraswap-sdk",
+  "version": "2.8.0-alpha.197",
+  "license": "Limited Ecosystem License",
+  "private": false,
+  "publishConfig": {
+    "access": "restricted"
+  },
+  "main": "dist/index.js",
+  "module": "esm/index.js",
+  "typings": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "esm"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "start": "rollup -c --watch",
+    "build": "rollup -c",
+    "lint": "eslint --fix -c ./.eslintrc.js \"src/**/*.ts*\""
+  },
+  "devDependencies": {
+    "@types/big.js": "6.1.6",
+    "@types/jest": "29.5.12",
+    "@types/lodash": "4.14.191",
+    "@types/react": "18.0.26",
+    "big.js": "6.2.1",
+    "bitcoinjs-lib": "5.2.0",
+    "coinselect": "3.1.13",
+    "ethers": "6.7.1",
+    "jest": "29.7.0",
+    "lodash": "4.17.21",
+    "paraswap": "5.2.0",
+    "react": "17.0.2",
+    "ts-jest": "29.0.5"
+  },
+  "dependencies": {
+    "@avalabs/core-utils-sdk": "2.8.0-alpha.197",
+    "@avalabs/core-wallets-sdk": "2.8.0-alpha.197"
+  },
+  "peerDependencies": {
+    "big.js": "^6.2.1",
+    "bitcoinjs-lib": "^5.2.0",
+    "coinselect": "^3.1.12",
+    "ethers": "^6.7.1",
+    "paraswap": "5.2.0",
+    "react": "^17.0.2"
+  },
+  "volta": {
+    "node": "16.13.1",
+    "yarn": "1.22.17"
+  }
+}