{"id":18263757,"url":"https://github.com/yearn/yearn-sdk","last_synced_at":"2025-04-04T20:31:17.979Z","repository":{"id":38422566,"uuid":"332256962","full_name":"yearn/yearn-sdk","owner":"yearn","description":"🦧 SDK for the yearn.finance platform. WIP","archived":false,"fork":false,"pushed_at":"2023-02-03T16:25:22.000Z","size":3516,"stargazers_count":53,"open_issues_count":11,"forks_count":56,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-20T19:07:25.337Z","etag":null,"topics":["defi","ethereum","sdk","yearn"],"latest_commit_sha":null,"homepage":"https://npm.im/@yfi/sdk","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yearn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-01-23T16:35:21.000Z","updated_at":"2023-09-08T18:17:38.000Z","dependencies_parsed_at":"2023-02-18T09:01:21.781Z","dependency_job_id":null,"html_url":"https://github.com/yearn/yearn-sdk","commit_stats":null,"previous_names":[],"tags_count":113,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yearn%2Fyearn-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yearn%2Fyearn-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yearn%2Fyearn-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yearn%2Fyearn-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yearn","download_url":"https://codeload.github.com/yearn/yearn-sdk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247246356,"owners_count":20907781,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["defi","ethereum","sdk","yearn"],"created_at":"2024-11-05T11:12:32.288Z","updated_at":"2025-04-04T20:31:16.043Z","avatar_url":"https://github.com/yearn.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cspan\u003e\n    \u003cimg align=\"right\" src=\"https://raw.githubusercontent.com/yearn/yearn-sdk/master/.github/media/sdk.png\" height=\"150\" /\u003e\n\u003c/span\u003e\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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyearn%2Fyearn-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyearn%2Fyearn-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyearn%2Fyearn-sdk/lists"}