🎉 The Irys L1 testnet docs are live. Migrate your project in 5 minutes and take advantage of our latest features. →
TwitterTwitter (opens in a new tab)DiscordDiscord (opens in a new tab)YouTubeYouTube (opens in a new tab)
GitHubGitHub (opens in a new tab)
    • Irys tools for Arweave
    • Networks
    • Downloading data
    • Cost to upload
    • Supported tokens
    • Receipts
  • SDK
    • Installing the SDK
    • Troubleshooting
    • Community SDKs
    • Irys in the browser
      • fund()
      • withdrawBalance()
      • withdrawAll()
      • getLoadedBalance()
      • getPrice()
      • upload()
      • uploadFile()
      • uploadFolder()
      • utils.toAtomic()
      • utils.fromAtomic()
      • utils.getReceipt()
      • utils.verifyReceipt()
      • funder.submitFundTransaction()
      • uploader.uploadBundle()
    • Chunked uploader
      • Conecting to a network
      • Upload parameters
      • Data mode
      • Transaction mode
      • Controlling the upload
      • Expired uploads
      • Upload events
    • Using IPFS CIDs
    • Manually creating a Tx
    • Balance approvals
    • Mutable References
    • Path Manifests
    • Tags
    • Using Devnet
  • CLI
    • Installation
      • balance
      • price
      • fund
      • withdraw
      • upload
      • upload-dir
  • QUERYING
    • Query package
      • search()
      • fromTimestamp()
      • toTimestamp()
      • tags()
      • ids()
      • from()
      • to()
      • token()
      • minHeight()
      • maxHeight()
      • sort()
      • limit()
      • stream()
      • fields()
    • GraphQL
  • GUIDES & TUTORIALS
      • Using npx-create-react-app
      • Using React + Vite
      • Learn the Irys SDK
      • Monitor node balance
      • Upload a static website
      • Transcode video with Livepeer
      • Transaction explorer
      • Gasless uploading
      • Upload NFT assets
      • Solana NFTs with Metaplex
      • Build a dynamic NFT
      • Upload Lens metadata
      • Encrypting on-chain data
      • Encrypting data server-side
      • Encrypting data in the browser
(opens in a new tab)
SDK
Installing the SDK

Installing The SDK

Install using npm:

npm install @irys/sdk

or yarn:

yarn add @irys/sdk
🎉

The Irys L1 private testnet is now live. Migrate your project (opens in a new tab) in 5 minutes and take advantage of our latest features.

SDKTroubleshooting
  • SDK
  • Query package
  • CLI
  • Tutorials
  • Repositories

2024 Irys. All rights reserved.