@minswap/sdk
v0.3.4
Published
Query Minswap data and build transactions
Downloads
569
Readme
Minswap SDK
Features
- [x] Get current pair price
- [x] Get historical pair price
- [x] Calculate trade price
- [x] Calculate price impact
- [x] Create orders and submit with Lucid
Install
- NPM:
npm install @minswap/sdk
- Yarn:
yarn add @minswap/sdk
ES Module Requirement
This package depends on lucid-cardano
, which is an ESM package, so it's also an ESM package. To import from ESM package, you need to specify "type": "module"
in package.json
and configure other build flags accordingly.
Examples
Example 1: Get current price of MIN/ADA pool
import { BlockFrostAPI } from "@blockfrost/blockfrost-js";
import { BlockfrostAdapter } from "@minswap/sdk";
const api = new BlockfrostAdapter({
blockFrost: new BlockFrostAPI({
projectId: "<your_project_id>",
network: "mainnet",
}),
});
for (let i = 1; ; i++) {
const pools = await api.getPools({
page: i,
});
if (pools.length === 0) {
// last page
break;
}
const minADAPool = pools.find(
(p) =>
p.assetA === "lovelace" &&
p.assetB ===
"29d222ce763455e3d7a09a665ce554f00ac89d2e99a1a83d267170c64d494e"
);
if (minADAPool) {
const [a, b] = await api.getPoolPrice({ pool: minADAPool });
console.log(
`ADA/MIN price: ${a.toString()}; MIN/ADA price: ${b.toString()}`
);
// we can later use this ID to call getPoolById
console.log(`ADA/MIN pool ID: ${minADAPool.id}`);
break;
}
}
Example 2: Get historical prices of MIN/ADA pool
import { BlockFrostAPI } from "@blockfrost/blockfrost-js";
import { BlockfrostAdapter, NetworkId } from "@minswap/sdk";
const MIN_ADA_POOL_ID =
"6aa2153e1ae896a95539c9d62f76cedcdabdcdf144e564b8955f609d660cf6a2";
const api = new BlockfrostAdapter({
blockFrost: new BlockFrostAPI({
projectId: "<your_project_id>",
network: "mainnet",
}),
});
const history = await api.getPoolHistory({ id: MIN_ADA_POOL_ID });
for (const historyPoint of history) {
const pool = await api.getPoolInTx({ txHash: historyPoint.txHash });
if (!pool) {
throw new Error("pool not found");
}
const [price0, price1] = await api.getPoolPrice({
pool,
decimalsA: 6,
decimalsB: 6,
});
console.log(`${historyPoint.time}: ${price0} ADA/MIN, ${price1} MIN/ADA`);
}
Example 3: Build Order transaction and submit
See examples/
for more details. You can run a single file like npm run exec examples/example.ts
.