{"_id":"@mercurial-finance/farming-sdk","_rev":"40-3db999639246af7fce455f24ba77f68d","name":"@mercurial-finance/farming-sdk","dist-tags":{"latest":"1.0.18","next":"1.0.18-rc.0"},"versions":{"1.0.0":{"name":"@mercurial-finance/farming-sdk","version":"1.0.0","keywords":[],"author":{"name":"McSam"},"license":"ISC","_id":"@mercurial-finance/farming-sdk@1.0.0","maintainers":[{"name":"mcsam94","email":"mcsam1216@gmail.com"},{"name":"dicksonp","email":"dickson.pys@icloud.com"},{"name":"siong","email":"siong@mercurial.finance"},{"name":"zhengyutay","email":"tayzhengyu@gmail.com"}],"dist":{"shasum":"b72c82bc92b1b790a7c11608ae15a8117f21f81b","tarball":"https://registry.npmjs.org/@mercurial-finance/farming-sdk/-/farming-sdk-1.0.0.tgz","fileCount":7,"integrity":"sha512-ISRe8QSP7SoU/D+hMPQx+X0oGQvh+QcAfBrlJukx3695BbDHCVJmgcmRDy5Eq8FN/grh7/kJMadRU+6AbS9oTA==","signatures":[{"sig":"MEYCIQDdqKHyx/tqywbfE5XT6JENvtt0G5VkRC3Ra8kxy+bNKgIhANerWWMm9aj9erxcKrWoKmrTyFxYXYcs6sg2H9u/HwF7","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":213215},"main":"./dist/index.js","types":"./dist/index.d.ts","module":"./dist/index.mjs","source":"./src/index.ts","gitHead":"03ed625252ef7de3b5aa7b7aea35bce7caf72ffa","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"tsup"},"_npmUser":{"name":"mcsam94","email":"mcsam1216@gmail.com"},"_npmVersion":"9.1.3","description":"","directories":{},"_nodeVersion":"18.4.0","dependencies":{"@solana/web3.js":"^1.78.1","@coral-xyz/anchor":"0.28.1-beta.1","@solana/spl-token":"^0.1.8"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^7.1.0","typescript":"^5.0.4"},"_npmOperationalInternal":{"tmp":"tmp/farming-sdk_1.0.0_1690770756047_0.5250314667053178","host":"s3://npm-registry-packages"}},"1.0.1":{"name":"@mercurial-finance/farming-sdk","version":"1.0.1","keywords":[],"author":{"name":"McSam"},"license":"ISC","_id":"@mercurial-finance/farming-sdk@1.0.1","maintainers":[{"name":"mcsam94","email":"mcsam1216@gmail.com"},{"name":"dicksonp","email":"dickson.pys@icloud.com"},{"name":"siong","email":"siong@mercurial.finance"},{"name":"zhengyutay","email":"tayzhengyu@gmail.com"}],"dist":{"shasum":"f52a127d10b86daefcf91c5e9ad596a6a01475ae","tarball":"https://registry.npmjs.org/@mercurial-finance/farming-sdk/-/farming-sdk-1.0.1.tgz","fileCount":7,"integrity":"sha512-46+ZYbM5mFMQOG2Jp4cCBrvaZS0dNqMES4p8wB4+0SjKiOrmo6CBeIa94E47ik8+tUGFP2JL+ygUxfdOsfzqPg==","signatures":[{"sig":"MEUCIFqTUg4AAzNiBGlR88jrMeHq5JgINRuMFtfFmgsh8wkNAiEA1J5FGpggdweKzC6sOrNgWuVckTIroKch5Jz7xyhQ118=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":213208},"main":"./dist/index.js","types":"./dist/index.d.ts","module":"./dist/index.mjs","source":"./src/index.ts","gitHead":"03ed625252ef7de3b5aa7b7aea35bce7caf72ffa","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"tsup"},"_npmUser":{"name":"mcsam94","email":"mcsam1216@gmail.com"},"_npmVersion":"9.1.3","description":"","directories":{},"_nodeVersion":"18.4.0","dependencies":{"@solana/web3.js":"^1.78.1","@coral-xyz/anchor":"0.28.0","@solana/spl-token":"^0.1.8"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^7.1.0","typescript":"^5.0.4"},"_npmOperationalInternal":{"tmp":"tmp/farming-sdk_1.0.1_1690772267535_0.7873634264605702","host":"s3://npm-registry-packages"}},"1.0.2":{"name":"@mercurial-finance/farming-sdk","version":"1.0.2","keywords":[],"author":{"name":"McSam"},"license":"ISC","_id":"@mercurial-finance/farming-sdk@1.0.2","maintainers":[{"name":"mcsam94","email":"mcsam1216@gmail.com"},{"name":"dicksonp","email":"dickson.pys@icloud.com"},{"name":"siong","email":"siong@mercurial.finance"},{"name":"zhengyutay","email":"tayzhengyu@gmail.com"}],"dist":{"shasum":"8928971e7cb9b4b75698049721467c9faf23785d","tarball":"https://registry.npmjs.org/@mercurial-finance/farming-sdk/-/farming-sdk-1.0.2.tgz","fileCount":7,"integrity":"sha512-5+oB7NDzrDGkFF7PzEGRh+2sTSPJ49zLbEVZJNGNgKdyPaavfVoYiBtp0y2LaS1CLx+dzcRbiVI8HqZzS3oKYA==","signatures":[{"sig":"MEYCIQCJvgszBgGWaCnb9+gJgRGk76QWsG7WDaDjAb5a4abX4QIhAPpepof2CC9htPjLJOwTRn7rkMqNy3vql7gr4dC/HqKM","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":213208},"main":"./dist/index.js","types":"./dist/index.d.ts","module":"./dist/index.mjs","source":"./src/index.ts","gitHead":"03ed625252ef7de3b5aa7b7aea35bce7caf72ffa","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"tsup"},"_npmUser":{"name":"mcsam94","email":"mcsam1216@gmail.com"},"_npmVersion":"9.1.3","description":"","directories":{},"_nodeVersion":"18.4.0","dependencies":{"@solana/web3.js":"~1.77.3","@coral-xyz/anchor":"0.28.0","@solana/spl-token":"^0.1.8"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^7.1.0","typescript":"^5.0.4"},"_npmOperationalInternal":{"tmp":"tmp/farming-sdk_1.0.2_1690773468872_0.6424248156986803","host":"s3://npm-registry-packages"}},"1.0.4":{"name":"@mercurial-finance/farming-sdk","version":"1.0.4","keywords":[],"author":{"name":"McSam"},"license":"ISC","_id":"@mercurial-finance/farming-sdk@1.0.4","maintainers":[{"name":"mcsam94","email":"mcsam1216@gmail.com"},{"name":"dicksonp","email":"dickson.pys@icloud.com"},{"name":"siong","email":"siong@mercurial.finance"},{"name":"zhengyutay","email":"tayzhengyu@gmail.com"}],"dist":{"shasum":"abcf847d227e927cf132dfe8d681e7f258328d21","tarball":"https://registry.npmjs.org/@mercurial-finance/farming-sdk/-/farming-sdk-1.0.4.tgz","fileCount":8,"integrity":"sha512-3n+QhCGxgapZVJRMoqK7DPtCdGPzlPfHtzhYtoij2eB8pcW6sWvUqad22CdX5kxynotI1/BjCWX+VbwuZcIbJw==","signatures":[{"sig":"MEQCIDhxfln8j5xFp8HLCuAD21udE5i+bmlAoM0A46d0OKC9AiBJaAXK7L2U03u0UjpibODmt/WDMtOVKVOQ1V+xRkpKnQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":239979},"main":"./dist/index.js","types":"./dist/index.d.ts","module":"./dist/index.mjs","source":"./src/index.ts","gitHead":"923f06e7355d0c4119097492f3be7355c1cb991b","scripts":{"test":"jest ./src/tests/*.test.ts --runInBand --setupFiles dotenv/config","build":"tsup"},"_npmUser":{"name":"mcsam94","email":"mcsam1216@gmail.com"},"_npmVersion":"9.1.3","description":"
","maintainers":[{"name":"siong","email":"siong@mercurial.finance"},{"name":"zhengyutay","email":"tayzhengyu@gmail.com"},{"name":"dicksonp","email":"dickson.pys@icloud.com"},{"name":"mcsam94","email":"mcsam1216@gmail.com"},{"name":"dongnguyen91861","email":"dongnguyen9186@gmail.com"},{"name":"raccoons-bot","email":"zhengyu@raccoons.dev"},{"name":"thimerosa","email":"dionis.chiua@gmail.com"}],"readme":"# Meteora Pool Farm SDK\n\n
\n\n
\n \n\n## Getting started\n\nNPM: https://www.npmjs.com/package/@mercurial-finance/farming-sdk\n\nSDK: https://github.com/MeteoraAg/reward-pool\n\n\n\nDiscord: https://discord.com/channels/841152225564950528/864859354335412224\n\n\n\n## Install\n\n1. Install deps\n\n```\nnpm i @mercurial-finance/farming-sdk @coral-xyz/anchor @solana/web3.js @solana/spl-token @solana/spl-token-registry\n```\n\n2. Initialize PoolFarmImpl instance\n\n```ts\nimport { PoolFarmImpl } from \"@mercurial-finance/farming-sdk\";\nimport { Wallet, AnchorProvider } from \"@coral-xyz/anchor\";\nimport { Connection, PublicKey, Keypair } from \"@solana/web3.js\";\n\n// Connection, Wallet, and AnchorProvider to interact with the network\nconst mainnetConnection = new Connection(\"https://api.mainnet-beta.solana.com\");\nconst mockWallet = new Wallet(new Keypair());\nconst provider = new AnchorProvider(mainnetConnection, mockWallet, {\n commitment: \"confirmed\",\n});\n// Alternatively, to use Solana Wallet Adapter\n\nconst USDC_acUSDC_POOL = new PublicKey(\n \"6ZLKLjMd2KzH7PPHCXUPgbMAtdTT37VgTtdeXWLoJppr\"\n); // Pool Address can get from https://docs.meteora.ag/dynamic-pools-integration/dynamic-pool-api/pool-info\n\nconst farmingPools = await PoolFarmImpl.getFarmAddressesByPoolAddress(\n USDC_acUSDC_POOL\n);\n// farmingPools is an array (A pool can have multiple farms)\nconst farmingPool = farmingPools[0];\nconst farm = await PoolFarmImpl.create(\n mainnetConnection,\n farmingPool.farmAddress\n);\n```\n\n3. To interact with the PoolFarmImpl\n\n- Stake\n\n```ts\n// https://station.jup.ag/blog/jupiter-token-list-api#endpoints\nconst tokenList = await fetch('https://token.jup.ag/all').then(res => res.json());\nconst USDC = tokenList.find(token => token.address === );\nconst USDT = tokenList.find(token => token.address === );\n// Get pool lp balance from `@mercurial-finance/dynamic-amm-sdk` package\nconst pool = await AmmImpl.create(connection, MAINNET_POOL.USDC_USDT, USDC, USDT);\nconst lpBalance = await pool.getUserBalance(mockWallet.publicKey);\n\nconst stakeTx = await farm.deposit(mockWallet.publicKey, lpBalance); // Web3 Transaction Object\nconst stakeResult = await provider.sendAndConfirm(stakeTx); // Transaction hash\n```\n\n- Check staked balance\n\n```ts\nconst farmBalance = await farm.getUserBalance(mockWallet.publicKey);\n```\n\n- Claim\n\n```ts\nconst claimTx = await farm.claim(mockWallet.publicKey); // Web3 Transaction Object\nconst claimResult = await provider.sendAndConfirm(claimTx); // Transaction hash\n```\n\n- Unstake\n\n```ts\nconst unStakeTx = await farm.withdraw(mockWallet.publicKey, farmBalance); // Web3 Transaction Object\nconst unstakeResult = await provider.sendAndConfirm(depositTx); // Transaction hash\n```\n","readmeFilename":"README.md"}
![](\"https://vaults.mercurial.finance/icons/logo.svg\"){kind=icon}
![](\"https://app.meteora.ag/icons/logo.svg\"){kind=icon}