Command line application and library for effortlessly uploading files to Arweave. Arweave enables you to store documents and applications forever.
cargo install arloader
Get an Arweave wallet json file here.
If you're going to use AR to pay for transactions, get AR tokens. I've been using gate.io despite the high withdrawal fees and KYC delays.
If you're going to use SOL, get a Solana wallet json file and transfer some SOL to it.
If you're uploading more than one file, you should pretty much always be using bundles. Bundles take multiple files and package them together in a single transaction. This is better than uploading multiple individual files because you only have to wait for one transaction to be confirmed. Once the bundle transaction is confirmed, all of your files will be available. Larger transactions with larger rewards are more attractive to miners, which means a larger bundled transaction is more likely to get written quickly than a bunch of smaller individual ones.
Arloader accepts file glob patterns and defaults to creating a bundle for your files.
Arweave gateways only index bundles up to 250MB, so if the aggregate size of all your files is greater than that, you should create multiple bundle transactions each less than 250MB.
arloader estimate "<GLOB>"
Make sure to include quotes around your glob patterns, otherwise your shell will expand them into a list of files. Arloader expects a glob pattern, not a list of files.
arloader upload "<GLOB>" --log-dir "<LOG_DIR>"
A json status object gets written to LOG_DIR with a file name of txid_<TXID>.json that has the transaction id, reward and creation time in it. A manifest file will also be written with a file name of manifest_<TXID>.json. This has all of the ids of the files that were included in your bundle it. This manifest was automtically included in your bundle, which means that in addition to being available individually at https://arweave.net/<BUNDLE_ITEM_ID>, they will also be available at https://arweave.net<MANIFEST_ID>/<FILE_PATH> where MANIFEST_ID is the id of the manifest item included in the bundle and FILE_PATH is the relative file path of the file included in the GLOB pattern you specified. The manifest file is named with the bundle transaction id so you can match them up. MANIFEST_ID gets printed out following the upload command and can also be found in the manifest json file in LOG_DIR at the manifest_id key. Paths relative to MANIFEST_ID can be found at the relative_paths key and paths with the BUNDLE_ITEM_ID can be found at the id_paths key, with corresponding indexes.
```
aHYRHIQg2BRqzQcyfYdG7vvsbZZZLkmsUJ8SsDQPsmE a3USnDu6Goq2O6ndbhtornjDPM3nk9v61E-Oklzgle8 Submitted 0
Uploaded 10 files in 1 bundle transaction. Run arloader raw-status a3USnDu6Goq2O6ndbhtornjDPM3nk9v61E-Oklzgle8 to confirm status.
Files will be available at https://arweave.net/
They will also be available at https://arweave.net/aHYRHIQg2BRqzQcyfYdG7vvsbZZZLkmsUJ8SsDQPsmE/
You can use SOL to pay for your tranactions without going through the hassle of procuring AR tokens.
Arloader usage is pretty much exactly the same as above, with the addition of the --with-sol flag.
arloader estimate "<GLOB>" --with-sol
arloader upload "<GLOB>" --log-dir "<LOG_DIR>" --with sol
This will create the same bundle that gets created without using SOL and then goes out to an api to get your transaction signed. Once the SOL payment transaction has gone through, the signature comes back from the api and gets added to your bundle transaction and then your transaction. Then it gets uploaded directly to the arweave.net gateway from your computer.
Arweave is limited to approximately 1,000 transactions every two minutes so if you happen to submit your transaction at a time when there are a lot of pending transactions, it may take longer to get written, or if there are enough more attractive transaction, i.e, with higher rewards, it may not get written at all. To check the current number of pending transactions, run
arloader pending
and that will print the number of pending transctions every second for one minute.
```
118 | ▥▥▥ 123 | ▥▥▥ 124 | ▥▥▥ 224 | ▥▥▥▥▥ 125 | ▥▥▥ 326 | ▥▥▥▥▥▥▥ 128 | ▥▥▥ ```
Given that Arloader bundles by default, your transaction is hopefully relatively attractive and you don't need to increase the reward to get it written in a timely fashion. However, if you see that there are a lot of transactions pending and you want to be sure your transaction goes through quickly, you can adjust the reward with --reward-multipler followed by something tha can be parsed as a float between 1.0 and 10.0. The reward included in your transaction will then be multiplied by this factor when it gets submitted. Similar to the --with-sol flag, you can add --reward-multiplier to both estimate and upload commands.
You can add the --no-bundle flag if for some reason you want to create individual transactions. This works with both estimate and upload commands. In that case individual status objects are written to LOG_DIR and you can run update-status to update them from the network and status-report for a count of transactions by status.