{"_id":"@dcspark/milkomeda-liquid-staking","_rev":"1-f7f49dd8db942137c5212e448507fecb","name":"@dcspark/milkomeda-liquid-staking","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@dcspark/milkomeda-liquid-staking","version":"1.0.0","description":"- [Synopsis](#synopsis) - [Installation](#installation) - [Getting Started](#getting-started)","main":"index.js","devDependencies":{"@nomiclabs/hardhat-ethers":"^2.2.2","@nomiclabs/hardhat-waffle":"^2.0.5","@openzeppelin/contracts":"^4.8.1","@openzeppelin/contracts-upgradeable":"^4.8.2","@typechain/ethers-v5":"^10.2.0","@typechain/hardhat":"^6.1.5","@types/chai":"^4.3.4","@types/chai-as-promised":"^7.1.5","@types/mocha":"^10.0.1","@types/sinon-chai":"^3.2.9","chai":"^4.3.7","chai-as-promised":"^7.1.1","dotenv":"^16.0.3","ethers":"^5.7.2","mls":"github:dcSpark/liquid-staking#06e56e18252aa68efb17988b6999cabdced17060","rimraf":"^4.1.2","sinon-chai":"^3.7.0","ts-node":"^10.9.1","typechain":"^8.1.1","typescript":"^4.9.5"},"dependencies":{"@ethersproject/abstract-provider":"^5.7.0","@ethersproject/abstract-signer":"^5.7.0","@nomicfoundation/hardhat-toolbox":"^2.0.1","@nomiclabs/hardhat-waffle":"^2.0.3","@typechain/ethers-v5":"^10.2.0","hardhat":"^2.12.7"},"scripts":{"build":"hardhat compile && tsc -p tsconfig.build.json","test":"hardhat test"},"repository":{"type":"git","url":"git+https://github.com/dcSpark/milkomeda-liquid-staking-js.git"},"keywords":[],"author":"","license":"MIT","bugs":{"url":"https://github.com/dcSpark/milkomeda-liquid-staking-js/issues"},"homepage":"https://github.com/dcSpark/milkomeda-liquid-staking-js#readme","gitHead":"caf6c2efee88034faf7d0a7c755f7d9887119648","_id":"@dcspark/milkomeda-liquid-staking@1.0.0","_nodeVersion":"16.16.0","_npmVersion":"8.11.0","dist":{"integrity":"sha512-6ZWD/tvnO1mMBW+/GoKAFreqk1ItVl0e9/Mp3u5NZ+G49N9tEKCOHJ8vtk0EfYXvJIW+Tc8RDND9LW0w7br3pQ==","shasum":"4cf25422dbcc8e7f1599a3b6fbce03a795f6fa02","tarball":"https://registry.npmjs.org/@dcspark/milkomeda-liquid-staking/-/milkomeda-liquid-staking-1.0.0.tgz","fileCount":21,"unpackedSize":28081,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCMa+sSOKY2ejKDgO3WhmIufGDI/kh4tKRWQT1D2eR9XgIhAP4bfV5gdm6NCFXJRq7LP981EEzRq0+lHQTO1PRjC07m"}]},"_npmUser":{"name":"sebastiengllmt","email":"sebastiengllmt@gmail.com"},"directories":{},"maintainers":[{"name":"ycl1","email":"code@yago.one"},{"name":"robkorn","email":"rob@dcspark.io"},{"name":"sebastiengllmt","email":"sebastiengllmt@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/milkomeda-liquid-staking_1.0.0_1687894708671_0.031356888575666764"},"_hasShrinkwrap":false}},"time":{"created":"2023-06-27T19:38:28.556Z","1.0.0":"2023-06-27T19:38:28.855Z","modified":"2023-07-18T23:34:59.914Z"},"maintainers":[{"email":"rob@dcspark.io","name":"robkorn"},{"email":"sebastiengllmt@gmail.com","name":"sebastiengllmt"}],"description":"- [Synopsis](#synopsis) - [Installation](#installation) - [Getting Started](#getting-started)","homepage":"https://github.com/dcSpark/milkomeda-liquid-staking-js#readme","keywords":[],"repository":{"type":"git","url":"git+https://github.com/dcSpark/milkomeda-liquid-staking-js.git"},"bugs":{"url":"https://github.com/dcSpark/milkomeda-liquid-staking-js/issues"},"license":"MIT","readme":"# milkomeda-liquid-staking-js\n\n- [Synopsis](#synopsis)\n- [Installation](#installation)\n- [Getting Started](#getting-started)\n\n## Synopsis\n\nThis is a JavaScript library to help interface with the Milkomeda Liquid Staking protocol. It includes helper methods that make intefacing with the the Milkomeda Liquid Staking protocol easy.\n## Build\n\n```console\n$ npm install\n$ npm run build\n```\n\n## Installation\n\nIn your project run:\n\n```console\nnpm install --save @dcspark/milkomeda-liquid-staking-js\n```\n\n## Getting Started\n\nCreate an instance of MLS using an ethers provider.\n\n### Examples\n\nThrough an RPC Provider\n\n```js\nimport { MilkomedaLiquidStaking } from \"@dcSpark/milkomeda-liquid-staking-js\";\nimport { ethers } from \"ethers\";\n\nconst provider = new ethers.providers.JsonRpcProvider(\"<RPC_URL>\");\nconst liquidStaking = new MilkomedaLiquidStaking.createAsync(provider);\n```\n\nWith custom signer\n\n```js\nimport { MilkomedaLiquidStaking } from \"@dcSpark/milkomeda-liquid-staking-js\";\nimport { ethers } from \"ethers\";\n\nconst provider = new ethers.providers.JsonRpcProvider(\"<RPC_URL>\");\n\nconst signer = new ethers.Wallet(\"<YOUR_PK>\", provider);\n\nconst liquidStaking = new MilkomedaLiquidStaking.createAsync(signer);\n```\n","readmeFilename":"README.md"}