@wardenswap/bestrate-sdk-beta 2.3.0

package/package.json

@@ -0,0 +1,89 @@
+{
+  "name": "@wardenswap/bestrate-sdk-beta",
+  "version": "2.3.0",
+  "main": "dist/index.js",
+  "module": "dist/index.es.js",
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "wardenswap",
+    "defi",
+    "bestrate"
+  ],
+  "types": "dist/index.d.ts",
+  "author": "Wardenswap",
+  "scripts": {
+    "watch": "rimraf dist && rollup -cw --bundleConfigAsCjs",
+    "build-dev": "rimraf dist && rollup -c --bundleConfigAsCjs",
+    "build": "rimraf dist && rollup -c --environment LOGGING,MINIFY --bundleConfigAsCjs",
+    "postbuild": "yarn run delDtsFiles",
+    "build-public": "rimraf dist && rollup -c --environment MINIFY --bundleConfigAsCjs",
+    "postbuild-public": "yarn run delDtsFiles",
+    "delDtsFiles": "rimraf dist/dts",
+    "coverage": "ts-node -O '{\"module\": \"commonjs\"}' src/coverage/index.ts",
+    "example": "ts-node -O '{\"module\": \"commonjs\"}' src/example.ts",
+    "test": "jest",
+    "typechain": "typechain --target=ethers-v5 src/abi/*.json && typechain --target=ethers-v5 --out-dir types/ethers-contracts/dexes src/abi/dexes/*.json",
+    "doc": "typedoc --plugin typedoc-plugin-markdown --disableSources --hideInPageTOC --hideBreadcrumbs --excludePrivate --excludeProtected --out docs src/index.ts"
+  },
+  "dependencies": {
+    "ethers": "^5.7.2"
+  },
+  "devDependencies": {
+    "@rollup/plugin-strip": "^3.0.4",
+    "@rollup/plugin-terser": "^0.4.4",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@typechain/ethers-v5": "^11.1.2",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.12.5",
+    "csv-writer": "^1.6.0",
+    "decimal.js": "^10.4.3",
+    "dotenv": "^16.4.5",
+    "jest": "^29.7.0",
+    "jest-mock-extended": "^3.0.5",
+    "rimraf": "^5.0.5",
+    "rollup": "^4.14.0",
+    "rollup-plugin-dts": "^6.1.0",
+    "ts-jest": "^29.1.2",
+    "ts-node": "^10.9.2",
+    "tslib": "^2.6.2",
+    "typechain": "^8.3.2",
+    "typedoc": "^0.25.12",
+    "typedoc-plugin-markdown": "^3.17.1",
+    "typescript": "^5.4.4"
+  },
+  "jest": {
+    "setupFiles": [
+      "<rootDir>/.jest/setEnvVars.js"
+    ],
+    "transform": {
+      ".(ts|tsx)": "ts-jest"
+    },
+    "testTimeout": 60000,
+    "testEnvironment": "node",
+    "testRegex": "(/tests/.*|\\.(test|spec))\\.(ts|tsx|js)$",
+    "moduleFileExtensions": [
+      "ts",
+      "tsx",
+      "js",
+      "jsx",
+      "json",
+      "node"
+    ]
+  },
+  "description": "- Update src/config.ts to add more tables",
+  "directories": {
+    "test": "tests"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Wardenswap/warden-bestrate-api.git"
+  },
+  "license": "UNLICENSED",
+  "bugs": {
+    "url": "https://github.com/Wardenswap/warden-bestrate-api/issues"
+  },
+  "homepage": "https://docs.wardenswap.finance/warden/wardenswap-sdk/overview",
+  "packageManager": "yarn@1.22.19+sha1.4ba7fc5c6e704fce2066ecbfb0b0d8976fe62447"
+}

package/readme.md

@@ -0,0 +1,79 @@
+# WardenSwap Best Rate Query SDK
+
+An JavaScript/TypeScript SDK library for querying trading quotes from WardenSwap platform. In order to begin trading on WardenSwap, we need the trading path that provide the best rate. The SDK help finding the path with ease!
+
+For more information, check out our documentation here: <https://docs.wardenswap.finance/warden/wardenswap-sdk/overview>
+
+## Installation
+
+```sh
+# For NPM
+npm install @wardenswap/bestrate-sdk-private
+
+# For Yarn
+yarn add @wardenswap/bestrate-sdk-private
+```
+
+## Example
+
+Here is the example if JavaScript code for querying best rate and perform a simple swap via WardenSwap SDK.
+
+```js
+// npm install @wardenswap/bestrate-sdk-private ethers
+const { WardenBestRate } = require('@wardenswap/bestrate-sdk-private')
+const { ethers } = require('ethers')
+
+// WardenRouter_2_0.abi.json can be found here: https://gist.github.com/AncientWarden/4aeae54509dd21020ab29a13c804cb57
+// or BSCScan: https://bscscan.com/address/0x451ef8D6B645a60115EB8b8bEa76B39C0C761004#code
+const wardenRouterAbi = require('./WardenRouter_2_0.abi.json')
+
+const WARDEN_ROUTER_ADDRESS = '0x451ef8D6B645a60115EB8b8bEa76B39C0C761004'
+
+const src = '0xe9e7cea3dedca5984780bafc599bd69add087d56' // source Token Address: BUSD
+const dest = '0x0feadcc3824e7f3c12f40e324a60c23ca51627fc' // destination Token Address: WAD
+const amountIn = ethers.utils.parseUnits('10', 18) // 10 BUSD in BigNumber
+const gasFee = ethers.BigNumber.from('5000000000') // default BSC gas fee for rate calculation
+const options = { enableSplit: false } // calculate without using split trades
+
+// initialize provider, requires version of ether.js >= 5.4.0
+const provider = new ethers.providers.JsonRpcProvider('https://bsc-dataseed.binance.org')
+
+async function getQuote() {
+    // initialize the warden client
+    const wardenClient = new WardenBestRate(provider, 'bsc')
+
+    // get the quote detail with warden client
+    const quote = await wardenClient.getQuote(src, dest, amountIn, gasFee, options)
+    console.log('quote:', quote)
+
+    return quote
+}
+
+async function swap(quote) {
+    // add the acceptable slippage of 1% to amountOut
+    // since the actual amount can be lower or higher.
+    const minAmountOut = ethers.BigNumber.from(quote.amountOut).mul(99).div(100)
+
+    // Get the signer with private key
+    // For using with Metamask, see: https://docs.ethers.io/v5/getting-started/#getting-started--connecting
+    const signer = new ethers.Wallet(YOUR_PRIVATE_KEY, provider)
+    const wardenContract = new ethers.Contract(WARDEN_ROUTER_ADDRESS, wardenRouterAbi, signer)
+
+    // send a swap transaction to warden contract
+    const swapTx = await wardenContract.swap(
+        quote.swapAddress,
+        quote.data,
+        quote.depositAddress,
+        src,
+        amountIn,
+        dest,
+        minAmountOut,
+        signer.address, // dest token receiver
+        0, // Partner ID for profit sharing, default to 0
+        0) // metadata, reserved for future use
+
+    console.log(`swap tx successfully submitted, tx hash: ${swapTx.hash}`)
+}
+
+getQuote().then(quote => swap(quote))
+```