{"_id":"@bombearn/sdk","_rev":"2-d394b817c5aeeca5f2fca19248e85ffa","name":"@bombearn/sdk","dist-tags":{"latest":"3.0.3"},"versions":{"3.0.1":{"name":"@bombearn/sdk","version":"3.0.1","description":"Interaction framework for the yearn protocol","author":{"name":"nymmrx","email":"nymmrx@protonmail.com"},"license":"MIT","main":"dist/index.js","module":"dist/core.esm.js","typings":"dist/index.d.ts","scripts":{"start":"tsdx watch","build":"tsdx build","build:watch":"tsdx watch --onSuccess \"yalc push --replace\"","test":"tsdx test","test:coverage":"tsdx test --coverage","lint":"run-p lint:*","lint:eslint":"eslint src","lint:typescript":"tsc --noEmit --skipLibCheck","docs":"typedoc --out docs src/index.ts","size":"size-limit","analyze":"size-limit --why","version":"tsdx build"},"peerDependencies":{"@ethersproject/abi":"^5.4.0","@ethersproject/address":"^5.4.0","@ethersproject/bignumber":"^5.4.1","@ethersproject/bytes":"^5.4.0","@ethersproject/contracts":"^5.4.1","@ethersproject/providers":"^5.4.3"},"devDependencies":{"@ethersproject/abi":"^5.4.0","@ethersproject/address":"^5.4.0","@ethersproject/bignumber":"^5.4.1","@ethersproject/bytes":"^5.4.0","@ethersproject/contracts":"^5.4.1","@ethersproject/providers":"^5.4.3","@size-limit/preset-small-lib":"7.0.4","@solidity-parser/parser":"^0.12.0","@types/jest":"^27.4.1","@typescript-eslint/eslint-plugin":"^5.17.0","@typescript-eslint/parser":"^5.17.0","cli-table3":"^0.6.0","eslint":"^8.12.0","eslint-config-prettier":"^8.5.0","eslint-plugin-import":"^2.25.4","eslint-plugin-prettier":"^4.0.0","eslint-plugin-simple-import-sort":"6","events":"3.3.0","jest":"^27.5.1","npm-run-all":"^4.1.5","prettier":"^2.6.2","size-limit":"7.0.4","ts-jest":"^27.1.3","tsdx":"^0.14.1","tslib":"^2.1.0","typedoc":"^0.22.13","typescript":"^4.6.3"},"dependencies":{"@cowprotocol/cow-sdk":"1.0.0-RC.5","bignumber.js":"9.0.1","cross-fetch":"3.1.5","dotenv":"10.0.0","emittery":"0.8.1","type-fest":"1.2.1"},"size-limit":[{"path":"dist/sdk.cjs.production.min.js","limit":"80 KB"},{"path":"dist/sdk.esm.js","limit":"80 KB"}],"engines":{"node":">=12.0.0"},"prettier":{"endOfLine":"auto","printWidth":120},"keywords":["yearn","crypto","sdk","typescript"],"jest":{"preset":"ts-jest","testPathIgnorePatterns":["<rootDir>/node_modules/","<rootDir>/dist/"]},"licenseText":"MIT License\n\nCopyright (c) 2021 yearn.finance\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","_id":"@bombearn/sdk@3.0.1","dist":{"shasum":"fc6742981b1cf928f4282128568ed73ddce067e8","integrity":"sha512-vph4sSlFG0xw0W2LMiD1etcp9DK39LSaLnYdp7Js8CZG7PQ89CdFvfiLpINMK0MBfztcjww8aDmJHnxN6zvwyA==","tarball":"https://registry.npmjs.org/@bombearn/sdk/-/sdk-3.0.1.tgz","fileCount":103,"unpackedSize":2977543,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDM7hzY1lOH9iRUzRT0ZWfjdvD7M0/Qc7SW494T+Qgy4QIhAMrW/88mYgemj4xGWEaiH++JG4Wt2lE7N7yGB//WdtI2"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkAConACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpR2A//TvbVN8WJcLSERYgF93ISpuSu/POEFIGzmOv7hsccHzJFXbME\r\nAhBghSJw2GsFEtz7vkYk4xeuFRP2Ys3V0tgINhG+AKEOgMQGe7dS1ZeiZ3tf\r\nl5M6xwLJF8okEC5EgKJFbtKDHvih0vN8YZgIWSf+ogsTcLQOZRbSaLlQzT96\r\ncgFCB51utjc7UGC404v+Bw+LV8cv2OYvjZOgvkDtw+FfcX0cLgTv/6iZmgms\r\n5uIQ8y1CGx3ULaMt+EHa7aEB8//cU4yw7JCVyXNRsEQiylXORBhJ+rLIZTeH\r\nNdB2yqPGN3TLtSslZrK2JAkReh6mDXecrkUcBXAxytWWLdYWk1WGvpLYCsXR\r\n3O2OnJ1jo5JoXcWD0zlMBkY//DX2jOrQ529WVzeIT8yI6VXZDhwYNcyC0u1b\r\nlElVSJPQP59+/Td0syXRlbpG/QilkE/U2Z6/i9LEcrsJZToibBIFOSngHpRc\r\nSKbkbXODZoGkeHSP2CFR/CfBZGtPM4hoDHLSVrG1qDRY1qxML5UcNIzqnwDE\r\nqzrXZOBdG4XXucXMdZquaIuvd1e6tUAZWpwzAKYJFH5EE+BpYtPJyCoRXb7b\r\nv2zreI0a0by7Tx3+sIwtfO3ow0ITWwiTr6H2ZNn7V/9MHtZy9LbxtyiB88vD\r\n0WlgmJ7hid9tCdyG+KLqVZQe4X7RupyYYhU=\r\n=1gvU\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"1coinassets","email":"aaron@1coin.io"},"directories":{},"maintainers":[{"name":"1coinassets","email":"aaron@1coin.io"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/sdk_3.0.1_1677732391643_0.4656733157250226"},"_hasShrinkwrap":false},"3.0.2":{"name":"@bombearn/sdk","version":"3.0.2","description":"Interaction framework for the yearn protocol","author":{"name":"nymmrx","email":"nymmrx@protonmail.com"},"license":"MIT","main":"dist/index.js","module":"dist/core.esm.js","typings":"dist/index.d.ts","scripts":{"start":"tsdx watch","build":"tsdx build","build:watch":"tsdx watch --onSuccess \"yalc push --replace\"","test":"tsdx test","test:coverage":"tsdx test --coverage","lint":"run-p lint:*","lint:eslint":"eslint src","lint:typescript":"tsc --noEmit --skipLibCheck","docs":"typedoc --out docs src/index.ts","size":"size-limit","analyze":"size-limit --why","version":"tsdx build"},"peerDependencies":{"@ethersproject/abi":"^5.4.0","@ethersproject/address":"^5.4.0","@ethersproject/bignumber":"^5.4.1","@ethersproject/bytes":"^5.4.0","@ethersproject/contracts":"^5.4.1","@ethersproject/providers":"^5.4.3"},"devDependencies":{"@ethersproject/abi":"^5.4.0","@ethersproject/address":"^5.4.0","@ethersproject/bignumber":"^5.4.1","@ethersproject/bytes":"^5.4.0","@ethersproject/contracts":"^5.4.1","@ethersproject/providers":"^5.4.3","@size-limit/preset-small-lib":"7.0.4","@solidity-parser/parser":"^0.12.0","@types/jest":"^27.4.1","@typescript-eslint/eslint-plugin":"^5.17.0","@typescript-eslint/parser":"^5.17.0","cli-table3":"^0.6.0","eslint":"^8.12.0","eslint-config-prettier":"^8.5.0","eslint-plugin-import":"^2.25.4","eslint-plugin-prettier":"^4.0.0","eslint-plugin-simple-import-sort":"6","events":"3.3.0","jest":"^27.5.1","npm-run-all":"^4.1.5","prettier":"^2.6.2","size-limit":"7.0.4","ts-jest":"^27.1.3","tsdx":"^0.14.1","tslib":"^2.1.0","typedoc":"^0.22.13","typescript":"^4.6.3"},"dependencies":{"@cowprotocol/cow-sdk":"1.0.0-RC.5","bignumber.js":"9.0.1","cross-fetch":"3.1.5","dotenv":"10.0.0","emittery":"0.8.1","type-fest":"1.2.1"},"size-limit":[{"path":"dist/sdk.cjs.production.min.js","limit":"80 KB"},{"path":"dist/sdk.esm.js","limit":"80 KB"}],"engines":{"node":">=12.0.0"},"prettier":{"endOfLine":"auto","printWidth":120},"keywords":["yearn","crypto","sdk","typescript"],"jest":{"preset":"ts-jest","testPathIgnorePatterns":["<rootDir>/node_modules/","<rootDir>/dist/"]},"licenseText":"MIT License\n\nCopyright (c) 2021 yearn.finance\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","_id":"@bombearn/sdk@3.0.2","dist":{"shasum":"e76b2de9225e61b50022068f6d570ea1b8c7f408","integrity":"sha512-eOaiRDUXQVKz1Uu9GcFpx3yHhfspHEmhwFrdxJCeKwsv16/pwIPqW7ZyEDz/KGvft9TtPCgDUTrhITz75zu/1g==","tarball":"https://registry.npmjs.org/@bombearn/sdk/-/sdk-3.0.2.tgz","fileCount":103,"unpackedSize":2980595,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDbbRSz6EwfoU496ixsOLLzTAI1mBCYbF5EPdjRk+LF6AiEAsiu9ZEa15QtQSvN/MF7sBcr3S4m7Y6Xt2beJpV4ROKI="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkACtFACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqNYQ//bRfEdcQuXz954cTZRhFWgDgzuSfKwUBAMr/4C1/wEA3rscjV\r\ntdrbHJxP3hkgbRQdJne1y2zvV7ge+3S7Bm9RkWBcWEXYNtc4omJVgjz3wn4K\r\noSfFjfk2PeWoYubLIaBm+65FjjsmJBibT4CM/XKATYxAS0+CoHrzlUWqgzNs\r\ni+fMZQWfGaaJJOmTbUrk3iRNqJoovK09xnu3xvKSL+dnsBEcJql28QUVu52Z\r\n87E7c1jPsrSzg5BhyNm1vMVs/SQ8kfDG4ZB48BotadQvEuCZn+iCpzX/xyxA\r\nftfEt3FMjF/NOX5rVjIXvQ6p2XYPDTTIXoVQ5xuVpKN9J/mfA1cbnV2dT9T0\r\nRtlddl5yCGaA5mXyhtlr1wpju+oIVpBz95iXXmhi+brlSllL7FeMRlwRcB2o\r\nCvdQbXI0tFefj5z8R4rchG/0PWmp1YWTuly/mSQ6aXrx+6iFjKWHyzpq6PX5\r\nzAT4keaR4Rv0FaE8vixZkEIyacIwb/PmZlCZWrLHB8QjybBE6SvFowFKMVMX\r\nEmZ2SNiZsBKg3KGOSgo2juj9770N6xcEfW/iLkU3y62yu5ZGutaEuzP41nTO\r\nZQs4g0Zx0pZ8PHZO1PHy1LFUKpuZbDPuRoLtlo98Su8mJsqakk58KZZMgmnF\r\nT963z/lmPFrbOi/8cLxBkHxAqwN5/q0ZPo0=\r\n=SUk2\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"1coinassets","email":"aaron@1coin.io"},"directories":{},"maintainers":[{"name":"1coinassets","email":"aaron@1coin.io"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/sdk_3.0.2_1677732677508_0.7947711295719295"},"_hasShrinkwrap":false},"3.0.3":{"name":"@bombearn/sdk","version":"3.0.3","description":"Interaction framework for the yearn protocol","author":{"name":"nymmrx","email":"nymmrx@protonmail.com"},"license":"MIT","main":"dist/index.js","module":"dist/core.esm.js","typings":"dist/index.d.ts","scripts":{"start":"tsdx watch","build":"tsdx build","build:watch":"tsdx watch --onSuccess \"yalc push --replace\"","test":"tsdx test","test:coverage":"tsdx test --coverage","lint":"run-p lint:*","lint:eslint":"eslint src","lint:typescript":"tsc --noEmit --skipLibCheck","docs":"typedoc --out docs src/index.ts","size":"size-limit","analyze":"size-limit --why","version":"tsdx build"},"peerDependencies":{"@ethersproject/abi":"^5.4.0","@ethersproject/address":"^5.4.0","@ethersproject/bignumber":"^5.4.1","@ethersproject/bytes":"^5.4.0","@ethersproject/contracts":"^5.4.1","@ethersproject/providers":"^5.4.3"},"devDependencies":{"@ethersproject/abi":"^5.4.0","@ethersproject/address":"^5.4.0","@ethersproject/bignumber":"^5.4.1","@ethersproject/bytes":"^5.4.0","@ethersproject/contracts":"^5.4.1","@ethersproject/providers":"^5.4.3","@size-limit/preset-small-lib":"7.0.4","@solidity-parser/parser":"^0.12.0","@types/jest":"^27.4.1","@typescript-eslint/eslint-plugin":"^5.17.0","@typescript-eslint/parser":"^5.17.0","cli-table3":"^0.6.0","eslint":"^8.12.0","eslint-config-prettier":"^8.5.0","eslint-plugin-import":"^2.25.4","eslint-plugin-prettier":"^4.0.0","eslint-plugin-simple-import-sort":"6","events":"3.3.0","jest":"^27.5.1","npm-run-all":"^4.1.5","prettier":"^2.6.2","size-limit":"7.0.4","ts-jest":"^27.1.3","tsdx":"^0.14.1","tslib":"^2.1.0","typedoc":"^0.22.13","typescript":"^4.6.3"},"dependencies":{"@cowprotocol/cow-sdk":"1.0.0-RC.5","bignumber.js":"9.0.1","cross-fetch":"3.1.5","dotenv":"10.0.0","emittery":"0.8.1","type-fest":"1.2.1"},"size-limit":[{"path":"dist/sdk.cjs.production.min.js","limit":"80 KB"},{"path":"dist/sdk.esm.js","limit":"80 KB"}],"engines":{"node":">=12.0.0"},"prettier":{"endOfLine":"auto","printWidth":120},"keywords":["yearn","crypto","sdk","typescript"],"jest":{"preset":"ts-jest","testPathIgnorePatterns":["<rootDir>/node_modules/","<rootDir>/dist/"]},"licenseText":"MIT License\n\nCopyright (c) 2021 yearn.finance\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","_id":"@bombearn/sdk@3.0.3","dist":{"shasum":"da84d788c1683c9f64e787c9dad877fe0c6b940c","integrity":"sha512-a8XFDgo6HCItR5LvzGnY+w6BllfcS+o99j7spKCXbb5R2J94PGO4vd8Aqef04yyXkx36klHp+iyPM7NIlFEUpw==","tarball":"https://registry.npmjs.org/@bombearn/sdk/-/sdk-3.0.3.tgz","fileCount":103,"unpackedSize":2979767,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHAu6xDYCFkIIHIrqPnXmg2Bnu/P34X41cfkOQu8OkJRAiEA/ymUGfPTXBdPeLPGyGB8RRxBeqRl03OvpQ0QhN6NcaQ="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJkAC8YACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmp5QA/6Akjaj5UT1BWsu7tIdUsdkKjSRrv4iR/qdQyUe0QObrq54A82\r\n6xnSiJUyhCAyy6q1vjvsEP7kQJdW7patYevqSnggAYsksBl5DdJj7ZKbfq51\r\nK7IZ+H70MJn1GkaMYMbrpAjtBW44Cp4TmpiZ2zTRh4LUHgEOx10xag5N4SCx\r\nN/LI9KsUohLDOElJsu0Z6zZPVjQlipgvMS3+x/oi3eZUzljFy98x7z/lYHS+\r\nEfI+OnTBrlOy+FNSm+iPUdI2/zopzhg9KkRNfu53yabWcH+693Cd/9eUmLhY\r\nziqcJqnkLNh4T65ERTg6qDrKRBxlJM2AWq/NIHD2CvgN02R/udpQmK+3i31K\r\nVkH6M5qx2Ouibc6WxqVBGvAz5/zFHKxxLj64Xn0sZd5UW6JSBaGnjQ/snihr\r\nW0hFSC8vzRyhDElcnYn37XSUxwl8u0eh+6ANaTiTvj3wMK+4YtQzE3QKQvLQ\r\nNqrpNuo8kPfKtyT2mLA3N205ZGNZZK6H8eeWt/utxGSJM0gt8tGdV2rKG7+3\r\nTioW0WD+0jG0Vsr0Kbrs0BLSUP9X2oPxjNwRnT2SxbfAIkgwohhnura9PGjc\r\nfm7n/KMMlK5hdpkHaUmotbGDeVUx3UQasH0lgcryzgOWaF0W0FRf9cUwOLWQ\r\n8nG9tSZyX4D+IVl+A3F62NchHOZuuGW2Meo=\r\n=iob9\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"1coinassets","email":"aaron@1coin.io"},"directories":{},"maintainers":[{"name":"1coinassets","email":"aaron@1coin.io"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/sdk_3.0.3_1677733656428_0.6196048443801194"},"_hasShrinkwrap":false}},"time":{"created":"2023-03-02T04:46:31.543Z","3.0.1":"2023-03-02T04:46:31.910Z","modified":"2023-03-02T05:07:36.882Z","3.0.2":"2023-03-02T04:51:17.674Z","3.0.3":"2023-03-02T05:07:36.701Z"},"maintainers":[{"name":"1coinassets","email":"aaron@1coin.io"}],"description":"Interaction framework for the yearn protocol","keywords":["yearn","crypto","sdk","typescript"],"author":{"name":"nymmrx","email":"nymmrx@protonmail.com"},"license":"MIT","readme":"<span>\n    <img align=\"right\" src=\"https://raw.githubusercontent.com/yearn/yearn-sdk/master/.github/media/sdk.png\" height=\"150\" />\n</span>\n\n# Yearn SDK\n\n[![CI](https://github.com/nymmrx/yearn-sdk/workflows/CI/badge.svg)](https://github.com/nymmrx/yearn-sdk/actions?query=workflow%3ACI)\n[![Styled With Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io/)\n\n## Getting Started\n\n### Installation\n\n```\nnpm i @yfi/sdk\n```\n\n### Configuration/Usage\n\nTo use the SDK, you will need to instantiate a Yearn object with your desired configuration;\n\n```\nimport { Yearn } from \"@yfi/sdk\";\nimport { JsonRpcProvider } from \"@ethersproject/providers\";\n\n// Ethereum mainnet\nconst chainId = 1;\n\n// It is recommended to use Alchemy for your Web3 provider when using the Yearn SDK.\nconst rpcUrl = \"https://eth-mainnet.alchemyapi.io/v2/secret-id-here\";\n\nconst yearn = new Yearn(chainId, {\n  provider: new JsonRpcProvider(rpcUrl)\n});\n```\n\n## Documentation\n\nAutogenerated documentation can be found [here](https://yearn.github.io/yearn-sdk).\n\n## Helpful links\n\n- 🌐 [Live site](https://yearn.finance)\n- ⚖️ [Governance forum](https://gov.yearn.finance)\n- 📑 [Documentation](https://docs.yearn.finance)\n\n## Contributing\n\n- Code style follows prettier conventions (`yarn lint`). Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).\n- PR conventions should follow our guidelines outlined at https://github.com/yearn/yearn-sdk/wiki/PR-conventions\n\n## Releasing the SDK to npmjs\n\n- Get write access to the package on npmjs - https://www.npmjs.com/package/@yfi/sdk\n- Login to npm - `npm login`\n- Install np - https://www.npmjs.com/package/np\n- Checkout and pull the master branch\n- Run `yarn build`\n- Run `np` and follow the instructions\n\n## Debug the website with a local copy of the sdk\n\n- Install yalc - https://www.npmjs.com/package/yalc\n- Run `yarn build`\n- Run `yalc publish`\n- Clone the website repo, configure the enviornment and open a terminal in it - https://github.com/yearn/yearn-finance-v3\n- Run `yalc add @yfi/sdk`\n- Run `yarn install`\n- Run `yarn start`\n","readmeFilename":"README.md"}