Skip to content
Public template

About

This project is a Node.js SDK developed to interact with the Arweave network. Arweave is a blockchain protocol that enables permanent and immutable data storage. With this SDK, you can easily check wallet balances, read data, and write data to the network.

Topics

Resources

Stars

5 stars

Watchers

0 watching

Forks

Latest commit

 

History

3 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Arweave Node.js SDK 🚀

This project is a Node.js SDK developed to interact with the Arweave network. Arweave is a blockchain protocol that enables permanent and immutable data storage. With this SDK, you can easily check wallet balances, read data, and write data to the network.

Features ✨

  • 📝 Write data to the Arweave network
  • 📖 Read data from the Arweave network
  • 💰 Check wallet balance
  • 🛡️ TypeScript support

Requirements 🛠️

  • Node.js (v16 or higher recommended)
  • npm
  • ts-node (globally or as a project dependency)

Installation 🔧

After cloning the project, install the dependencies:

npm install

Usage 🚦

You need to place your wallet key in the wallet.json file. Then, you can run the following examples:

Examples 📚

  • examples/balance/index.ts: 💰 Checks the wallet balance.
  • examples/read/index.ts: 📖 Reads data from the Arweave network.
  • examples/write/index.ts: 📝 Writes data to the Arweave network.

To run each example:

npm run <example name>

For instance, to check the balance:

npm run balance

Project Structure 🗂️

  • src/utils.ts: 🛠️ Basic utility functions
  • examples/: 📚 Usage examples
  • wallet.json: 🔑 Wallet key file
  • tsconfig.json: ⚙️ TypeScript configuration

Contributing 🤝

If you would like to contribute, please create a fork and submit a pull request. You can report bugs or suggest features in the Issues section.

License 📄

This project is licensed under the MIT License. For details, please see the LICENSE file.


For any questions or suggestions, feel free to contact us. ✉️

About

This project is a Node.js SDK developed to interact with the Arweave network. Arweave is a blockchain protocol that enables permanent and immutable data storage. With this SDK, you can easily check wallet balances, read data, and write data to the network.

Topics

Resources

Stars

5 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages