{"id":21082721,"url":"https://github.com/renproject/ren-js","last_synced_at":"2025-04-05T21:05:36.143Z","repository":{"id":36466547,"uuid":"192451077","full_name":"renproject/ren-js","owner":"renproject","description":"RenJS - the official JavaScript library for interacting with RenVM","archived":false,"fork":false,"pushed_at":"2023-03-15T04:13:31.000Z","size":19162,"stargazers_count":139,"open_issues_count":10,"forks_count":40,"subscribers_count":21,"default_branch":"master","last_synced_at":"2025-03-29T20:02:37.320Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://renproject.github.io/ren-client-docs/","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/renproject.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-06-18T02:30:30.000Z","updated_at":"2025-02-14T15:52:44.000Z","dependencies_parsed_at":"2023-12-18T06:39:51.438Z","dependency_job_id":"f6228da1-1366-4023-8ab7-371816b6914e","html_url":"https://github.com/renproject/ren-js","commit_stats":{"total_commits":1466,"total_committers":9,"mean_commits":"162.88888888888889","dds":0.252387448840382,"last_synced_commit":"d4ac2ef563368ac29681e0341d6525568b40aa64"},"previous_names":[],"tags_count":230,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renproject%2Fren-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renproject%2Fren-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renproject%2Fren-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renproject%2Fren-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/renproject","download_url":"https://codeload.github.com/renproject/ren-js/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247399871,"owners_count":20932876,"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":[],"created_at":"2024-11-19T20:15:08.966Z","updated_at":"2025-04-05T21:05:36.109Z","avatar_url":"https://github.com/renproject.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# `🛠️ ren-js`\n\n[![Version](https://img.shields.io/npm/v/@renproject/ren)](https://www.npmjs.com/package/@renproject/ren)\n\nThe official Javascript SDK for interacting with [RenVM](https://renproject.io).\n\n```sh\nyarn add @renproject/ren @renproject/chains\n```\n\n## Docs\n\nSee [Ren Client Docs](https://renproject.github.io/ren-client-docs/ren-js/)\n\n## RenJS v3\n\nRenJS v3 is currently available as an alpha release:\n\n```sh\nyarn add @renproject/ren @renproject/chains\n```\n\n[RenJS v3 Docs](https://renproject.github.io/ren-client-docs/ren-js/ren-js-v3) (WIP)\n\n## Changelog\n\nSee the [Releases page](https://github.com/renproject/ren-js/releases).\n\n## Package list\n\n-   [`ren`](./packages/ren) - Javascript SDK for interacting with RenVM.\n-   [`provider`](./packages/provider) - JSON-RPC provider.\n-   [`utils`](./packages/utils) - Helper functions used by the other packages.\n-   [`mock-provider`](./packages/mock-provider) - For testing locally with Ganache/Hardhat\n-   chains, for enabling support for blockchains and assets:\n-   -   [`chains-bitcoin`](./packages/chains/chains-bitcoin) - Bitcoin and Bitcoin forks\n-   -   [`chains-ethereum`](./packages/chains/chains-ethereum) - Ethereum and other EVM chains\n-   -   [`chains-terra`](./packages/chains/chains-terra) - Terra/LUNA\n-   -   [`chains-filecoin`](./packages/chains/chains-filecoin) - Filecoin\n-   -   [`chains-solana`](./packages/chains/chains-solana) - Solana\n-   -   [`chains`](./packages/chains/chains) - Combines all of the above chains into one package\n\n\u003chr /\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eDeveloper docs - click to expand\u003c/summary\u003e\n\n\u003cbr /\u003e\n\n## Developing locally\n\n```sh\n# Clone repository\ngit clone git@github.com:renproject/ren-js.git \u0026\u0026 cd ren-js\n\n# Install dependencies\nyarn\n\n# Build every package\nyarn run build\n```\n\n## Linking\n\nIf you want to use your local version of RenJS in another repository, run\n\n```sh\n# In the ren-js repository\nyarn run link:all\n```\n\nYou can now link it to any other local repository by running:\n\n```sh\n# In other local repositories\nyarn link @renproject/ren @renproject/chains @renproject/utils @renproject/provider\n```\n\n## Running tests\n\nYou'll need to:\n\n1. Generate a mnemonic and send ETH (goerli for testnet) (path: `m/44'/60'/0'/0/`).\n    - `let w = require(\"ethers\").Wallet.createRandom(); console.debug(w.address, w.mnemonic.phrase);`\n2. Generate a private key and send testnet crypto funds.\n    - `require(\"send-crypto\").newPrivateKey();`\n3. Optionally generate an [Infura](https://infura.io) API key.\n\nCreate a `.env` file which contains the following exported variables:\n\n```sh\nexport MNEMONIC=\"your mnemonic here\"\nexport TESTNET_PRIVATE_KEY=\"your bitcoin private key\"\n\n# Optional\nexport INFURA_KEY=\"your infura key\"\n```\n\nTo run the tests:\n\n```sh\nyarn run test\n```\n\n\u003c/details\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frenproject%2Fren-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frenproject%2Fren-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frenproject%2Fren-js/lists"}