Irys JS SDK

What is Irys?

Irys is the world's first L1 programmable datachain. On Irys, you can upload onchain data, deploy smart contracts, and those smart contracts can access and perform verifiable computations on onchain data.

This Irys JS SDK is for uploading onchain data.

Docs

https://docs.irys.xyz

Migrating

Migrating from our old SDK? We've got a handy guide for you.

https://migrate-to.irys.xyz

Repos

The Irys JS SDK reduces dependency bloat by providing dedicated packages for each supported token.

Install only the specific packages you require.

CLI

• cli: The Irys storage CLI.

EVM Chains

• ethereum: Use with NodeJS, contains token-specific packages for all supported EVM tokens.
• ethereum-web: Use in the browser, contains token-specific packages for all supported EVM tokens.
• ethereum-ethers-v5: Use with the ethers v5 browser provider.
• ethereum-ethers-v6: Use with the ethers v6 browser provider.
• ethereum-viem-v2: Use with the viem v2 browser provider.

Solana

• solana-node: Use with NodeJS, contains token-specific packages for all supported Solana tokens.
• solana-web: Use in the browser, contains token-specific packages for all supported Solana tokens.

Aptos

• aptos-node: Use with NodeJS and the Aptos token.
• aptos-web: Use in the browser with the Aptos token.

Core

The Irys core packages are used internally, most users will not need to install them directly.

• client-core
• client-node
• client-web