{"id":13454535,"url":"https://github.com/Irys-xyz/js-sdk","last_synced_at":"2025-03-24T06:30:52.248Z","repository":{"id":37687680,"uuid":"413859003","full_name":"Irys-xyz/arweave-js-sdk","owner":"Irys-xyz","description":"JS SDK for Irys on Arweave","archived":true,"fork":false,"pushed_at":"2024-09-04T20:43:18.000Z","size":3536,"stargazers_count":111,"open_issues_count":0,"forks_count":96,"subscribers_count":7,"default_branch":"main","last_synced_at":"2024-10-30T02:29:58.971Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Irys-xyz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-10-05T14:46:00.000Z","updated_at":"2024-10-24T03:34:58.000Z","dependencies_parsed_at":"2022-07-09T03:16:21.051Z","dependency_job_id":"8b062940-38f5-491f-9f1b-5c601a1cd42e","html_url":"https://github.com/Irys-xyz/arweave-js-sdk","commit_stats":null,"previous_names":["bundlr-network/js-client","irys-xyz/js-sdk","irys-xyz/arweave-js-sdk","bundlr-network/js-sdk"],"tags_count":134,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Irys-xyz%2Farweave-js-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Irys-xyz%2Farweave-js-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Irys-xyz%2Farweave-js-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Irys-xyz%2Farweave-js-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Irys-xyz","download_url":"https://codeload.github.com/Irys-xyz/arweave-js-sdk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245222253,"owners_count":20580117,"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-07-31T08:00:55.090Z","updated_at":"2025-03-24T06:30:49.799Z","avatar_url":"https://github.com/Irys-xyz.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# Irys SDK\n\n# DEPRECATED\nThis package and the Arweave bundlers - which we will continue to operate - have been deprecated and are no longer actively supported. We recommend migrating to [Irys - the world’s first programmable datachain](https://migrate-to.irys.xyz). \n\n![](./assets/irys-SDK.png?raw=true)\n\n\nThe [Irys SDK](http://docs.irys.xyz/developer-docs/irys-sdk) is a typesafe SDK for interacting with [Irys](https://irys.xyz).\n\n## What is Irys?\n\nIrys is the only provenance layer. It enables users to scale permanent data and precisely attribute its origin. Data uploaded to Irys is permanent, precise, and unconstrained. Learn [more in our docs](http://docs.irys.xyz/overview/about).\n\n\n## How Irys works\n\n![](./assets/provenance-machine.jpg?raw=true)\n\nWhen you upload data to Irys, you are immediately issued a receipt. This [receipt](https://docs.irys.xyz/learn/receipts) contains an ID that can be used to instantly download your data, along with attribution, authorship details, and timestamp accurate to the millisecond. The receipt acts as cryptographic proof of time and can be trustlessly verified as a safeguard against potentially malicious behavior.\n\nNext, Irys [includes your transaction in a bundle](http://docs.irys.xyz/learn/transaction-lifecycle) and submits it to Arweave where it is permanently stored. Irys guarantees your transaction will be finalized on Arweave (\u003e= 50 block confirmations) and seeded to \u003e=5 miners.\n\nFor more details, including a video overview, [see our docs](http://docs.irys.xyz/overview/about).\n\n## Why Irys offers\n- Volumetric scaling: [Can handle 50K+ Transactions Per Second (TPS)](https://youtu.be/JKEivHKDXAo) and [limitless data volumes](http://docs.irys.xyz/learn/volumetric-scaling).\n- Instant uploads: Upload data to Irys in as little as 8ms.\n- Frictionless integration: [3-4 lines of code](http://docs.irys.xyz/developer-docs/irys-sdk) to integrate Irys.\n- Pay in any token: Sign and pay to use Irys in [14 supported tokens](http://docs.irys.xyz/overview/supported-tokens).\n\n## Getting started\n\n### Install the SDK\n\nUsing npm:\n\n```console\nnpm install @irys/sdk\n```\n\nor yarn:\n```console\nyarn add @irys/sdk\n```\n\n### Connect to an Irys node\n\nConnect to [one of our three nodes](http://docs.irys.xyz/overview/nodes):\n\n```js\nconst getIrys = async () =\u003e {\n\tconst providerUrl = \"https://rpc-mumbai.maticvigil.com\";\n\tconst token = \"matic\";\n \n\tconst irys = new Irys({\n\t\tnetwork: \"devnet\", // \"mainnet\" || \"devnet\"\n\t\ttoken, // Token used for payment\n\t\tkey: process.env.PRIVATE_KEY, // Private key\n\t\tconfig: { providerUrl }, // Optional provider URL, only required when using Devnet\n\t});\n\treturn irys;\n};\n```\n\n### Upload\n\n```js\nconst uploadData = async () =\u003e {\n\tconst irys = await getIrys();\n\tconst dataToUpload = \"GM world.\";\n\ttry {\n\t\tconst receipt = await irys.upload(dataToUpload);\n\t\tconsole.log(`Data uploaded ==\u003e https://gateway.irys.xyz/${receipt.id}`);\n\t} catch (e) {\n\t\tconsole.log(\"Error uploading data \", e);\n\t}\n};\n```\n\nFor more code examples, including code showing how to upload files and folders, see [our docs](http://docs.irys.xyz/developer-docs/irys-sdk).\n\n## Irys in the browser\n\nWhen using [Irys in the browser](http://docs.irys.xyz/developer-docs/irys-sdk/irys-in-the-browser), the end user's injected provider is used to sign transactions and pay for uploads. See our docs for [code examples](http://docs.irys.xyz/developer-docs/irys-sdk/irys-in-the-browser). \n\n## UI toolkit\n\nTo help kickstart your next project, we've released the [Provenance Toolkit](http://docs.irys.xyz/developer-docs/provenance-toolkit), a full suite of open source UI components.\n\n## Video\n\nWe also have a [video](https://youtu.be/CdWn9clSybM) teaching how to build with Irys.\n\n## Support\n\nIf you have any questions or just want to brainstorm about how to integrate Irys into your project, reach out to us in [Discord](https://discord.irys.xyz).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FIrys-xyz%2Fjs-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FIrys-xyz%2Fjs-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FIrys-xyz%2Fjs-sdk/lists"}