ArweaveKit Docs
  • 💳ARWEAVE WALLET KIT
    • Introduction to Arweave Wallet Kit
    • Setup
    • Connect Button
    • Hooks
    • Customization
  • 🤖Arweave Data Storage SDK
    • Introduction to the Arweave Data Storage SDK
  • Installation
  • Usage
  • Wallet
  • Configuration
  • Data Upload Service
  • ArweaveKit
    • Introduction
  • 🔐Wallets
    • Introduction to Wallets
    • Create Wallet
    • Get Wallet Address
    • Get Wallet Balance
    • Wallet Plugins
  • 🏦Transactions
    • Introduction to Transactions
    • Create Transaction
    • Sign Transaction
    • Post Transaction
    • Get Transaction Status
    • Get Transaction
    • Create and Post Transaction with Othent
    • Transaction Plugins
  • ✅AUTH
    • Introduction to Auth
    • Connect
    • Disconnect
    • Get Active Address
    • Get Permissions
    • Get Wallet Names
    • Get All Addresses
    • Get Active Public Key
    • Is Installed
    • Log In with Othent
    • Log Out with Othent
    • Get User Details with Othent
    • Auth Plugins
  • 🔐Encryption
    • Introduction to Encryption
    • Encrypt Data with AES
    • Decrypt Data with AES
    • Encrypt AES Key with RSA
    • Decrypt AES Key with RSA
    • Encryption Plugins
  • 🌐GRAPHQL
    • Introduction to GraphQL
    • Query All Arweave Transactions
    • Query Arweave Data
    • Query Arweave Transactions
    • GraphQL Plugins
  • 📘REFERENCES
    • ArweaveKit in Browser Environments
  • 🛠️SUPPORTING TOOLS
    • Arweave StarterKit
Powered by GitBook
On this page

Was this helpful?

Configuration

Initialize the Arweave Data Storage SDK object with various configuration options. The appName is recommended as it helps in organizing and searching your transactions on Arweave. The privateKey can either be your account’s key or a flag to use a browser wallet. Other parameters like network, token, and gateway let you tailor the SDK to your specific environment.

const { Configuration, Network, Token} = require('arweave-storage-sdk');

const config = new Configuration({
	appName: 'My cool project'
	privateKey: process.env.PRIVATE_KEY,
	network: Network.BASE_MAINNET,
	token: Token.USDC
})
Option
Optional
Description

appName

true

App name to be used in Arweave transactions. Recommended to use since it makes searching all your app files easier.

privateKey

false

Private key of your account. JWK in case of Arweave. if 'use_web_wallet' is used, sdk will rely on browser wallets.

network

true

Network of your payment token. Eg: 'SOL_MAINNET'. Simply use the Network object provided by the sdk to see supported networks. Defaults to Arweave.

token

true

Token to use for payments. Eg: 'USDT'. Use the Token object provided by the sdk to see all supported tokens. Defaults to AR.

  • Encryption: For private drives or file storage, use the built-in Crypto utilities to manage encryption.

  • API Calls: The SDK uses the ArFSApi internally to interact with the Arweave network. You can override or customize gateway endpoints if needed.

PreviousWalletNextData Upload Service

Last updated 8 days ago

Was this helpful?