add --update-animation-url flag to update-metadata command

Author: CalebEverett

CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes starting with v0.1.34 to this project will be documented in
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+# v0.1.54 (2022-01-18)
+- **added:** added `--update-animation-url` flag to `update-metadata`.
+- **added:** added [instructions](docs/multiple_asset_files.md) for uploading with multiple asset files.
+- **changed:** validate `<FILE_PATHS>` for `update-metadata` command as json and fix docs to specify json instead of assets.
+
 # v0.1.53 (2022-01-12)
 - **fixed:** Include files as objects with `uri` and `type` keys in the `files` key of the `properties` key when updating metadata files.
 - **changed:** File objects are now appended to the `files` key with the `update-metadata` command and in order to update the `image` key, you have to pass the `--update-image` flag. This was done to make it possible to have multiple asset files and associated links for each NFT, in which case you can run `update-metadata` multiple times without the `--update-image` flag to append multiple links to the `files` key.

Cargo.toml

@@ -2,7 +2,7 @@
 name = "arloader"
 authors = ["calebeverett <[email protected]>"]
 description = "Command line application and library for uploading files to Arweave."
-version = "0.1.53"
+version = "0.1.54"
 edition = "2021"
 license = "Apache-2.0"
 repository = "https://github.com/CalebEverett/arloader"

README.md

@@ -20,6 +20,7 @@ Upload gigabytes of files with one command. Files are read and posted to [arweav
 * [Pricing Comparison](#pricing-comparison)
 * [Roadmap](#roadmap)
 * [Transactions Prior to v0.1.51](#potential-issue-with-transactions-uploaded-prior-to-version-0.1.51)
+* [Showing Love](#showing-love)
 
 ## Installation
 
@@ -436,3 +437,6 @@ file size | num files | arweave | bundlr | arweave total | bundlr total | arweav
 
 ## Potential Issue with Transactions Uploaded Prior to Version 0.1.51
 The way arloader was formatting transactions for upload was not entirely compatible with the Arweave protocol prior to version 1.51. For transactions bigger than 256 KB it is possible that even though your transactions are visible and are showing more than 25 confirmations that they were not written to the Arweave blockchain. If you would like assistance determining whether your transactions were impacted, please open an issue and I will be happy to help, including paying for any necessary re-uploading.
+
+## Showing Love
+If arloader was useful and the spirit moves you, I'd love to have one of your NFTs in my collection: `F4B7659xdVcTqQEHShLsxp7w8wckMyBmT9GM8bGDqTUW`.

docs/multiple_asset_files.md

@@ -2,11 +2,11 @@
 
 There isn't a single command you can run if you have multiple media files per NFT, i.e., an mp4 and a png file. But you can run separate commands for each to get all of your files uploaded with your metadata files updated to include links to all of your media files.
 
-Here is an example from a an upload of a series of glb and png files
+Here is an example from a an upload of a series of glb and png files.
 
 1. `arloader upload *.glb --sol-keypair-path ~/.config/solana/wallet.json --with-sol --ar-default-keypair --bundle-size 100 --reward-multiplier 2`
 2. `arloader upload-manifest  arloader_EsBWe5NTZ8E --sol-keypair-path ~/.config/solana/wallet.json --with-sol --ar-default-keypair --reward-multiplier 2`
-3. `arloader update-metadata *.glb --manifest-path arloader_EsBWe5NTZ8E/manifest_2LpuzxUYEmKl5huvPChgoZ3YcAKNnpUoh-Jyq1EoB-9.json`
+3. `arloader update-metadata *.glb --manifest-path arloader_EsBWe5NTZ8E/manifest_2LpuzxUYEmKl5huvPChgoZ3YcAKNnpUoh-Jyq1EoB-9.json --update-animation-url`
 4. `arloader upload *.png --sol-keypair-path ~/.config/solana/wallet.json --with-sol --ar-default-keypair --reward-multiplier 2`
 5. `arloader upload-manifest arloader_l00ydMAOy7E --sol-keypair-path ~/.config/solana/wallet.json --with-sol --ar-default-keypair --reward-multiplier 2`
 6. `arloader update-metadata *.png --manifest-path arloader_l00ydMAOy7E/manifest_rJiNPRYtu-tsMYP5wyDU4L-4Qu8HFaL2QMHn7Oq1BGn.json  --update-image`

docs/upload_nfts_steps.md

@@ -98,7 +98,9 @@ If your metadata files have the same stem as your asset files and an extension o
 arloader update-metadata --manifest-path <MANIFEST_PATH>
 ```
 
-This will append the links from the manifest file to the `files` key in the metadata file. If you want to update the `image` key as well, pass the `--update-image` flag. Arloader defaults to using the id link (`https://arweave.net/<BUNDLE_ITEM_ID>`) for the `image` key, but you can pass the `--link-file` flag to use the file path based link. If you pass `--link-file`, the `files` key will get both the id based and file path based links appended.
+This will append the links from the manifest file to the `files` key in the metadata file.Arloader defaults to using the id link (`https://arweave.net/<BUNDLE_ITEM_ID>`) for the `image` key, but you can pass the `--link-file` flag to use the file path based link. If you pass `--link-file`, the `files` key will get both the id based and file path based links appended.
+
+ If you want to update the `image` key as well, pass the `--update-image` flag. If you want to update the `animation_url` key as well, pass the `--update-animation-url` flag.
 
 ### Upload Metadata
 

examples/check_peers.rs

@@ -3,7 +3,7 @@ use reqwest;
 
 #[tokio::main]
 async fn main() {
-    let txid = "4Mh_VQSTvL_jD-PrP7aUzrOkJ2zmXbYJhvfxnn-ojk0";
+    let txid = "8kEv0wGeAuk5-lateTOwFiWGffZomRS3sYZgwiDiY74";
 
     let peers = reqwest::get("https://arweave.net/peers")
         .await

src/commands.rs

@@ -285,6 +285,7 @@ pub async fn command_update_metadata<IP>(
     manifest_path: PathBuf,
     link_file: bool,
     update_image: bool,
+    update_animation_url: bool,
 ) -> CommandResult
 where
     IP: Iterator<Item = PathBuf> + Send + Sync,
@@ -298,6 +299,7 @@ where
             manifest_path,
             link_file,
             update_image,
+            update_animation_url,
         )
         .await?;
 
@@ -807,6 +809,7 @@ where
         asset_manifest_path,
         link_file,
         true,
+        false,
     )
     .await?;
 

src/lib.rs

@@ -1572,6 +1572,7 @@ impl Arweave {
         file_path: PathBuf,
         mut files_array: Vec<Value>,
         image_link: Option<String>,
+        animation_url_link: Option<String>,
     ) -> Result<(), Error> {
         let data = fs::read_to_string(file_path.clone()).await?;
         let mut metadata: Value = serde_json::from_str(&data)?;
@@ -1581,6 +1582,13 @@ impl Arweave {
             metadata.insert("image".to_string(), Value::String(image_link));
         }
 
+        if let Some(animation_url_link) = animation_url_link {
+            metadata.insert(
+                "animation_url".to_string(),
+                Value::String(animation_url_link),
+            );
+        }
+
         let properties = if let Some(properties) = metadata.get_mut("properties") {
             properties.as_object_mut().unwrap()
         } else {
@@ -1604,6 +1612,7 @@ impl Arweave {
         manifest_path: PathBuf,
         image_link_file: bool,
         update_image_link: bool,
+        update_animation_url_link: bool,
     ) -> Result<(), Error>
     where
         IP: Iterator<Item = PathBuf> + Send,
@@ -1621,23 +1630,32 @@ impl Arweave {
 
             try_join_all(paths_iter.map(|p| {
                 let path_object = manifest.get(&p.display().to_string()).unwrap();
+
+                let link = if image_link_file {
+                    format!(
+                        "https://arweave.net/{}/{}",
+                        manifest_id,
+                        &p.display().to_string()
+                    )
+                } else {
+                    format!(
+                        "https://arweave.net/{}",
+                        path_object["id"].as_str().unwrap()
+                    )
+                };
+
                 let image_link = if update_image_link {
-                    let link = if image_link_file {
-                        format!(
-                            "https://arweave.net/{}/{}",
-                            manifest_id,
-                            &p.display().to_string()
-                        )
-                    } else {
-                        format!(
-                            "https://arweave.net/{}",
-                            path_object["id"].as_str().unwrap()
-                        )
-                    };
+                    Some(link.clone())
+                } else {
+                    None
+                };
+
+                let animation_url_link = if update_animation_url_link {
                     Some(link)
                 } else {
                     None
                 };
+
                 let files_array = if image_link_file {
                     path_object["files"].as_array().unwrap().clone()
                 } else {
@@ -1648,7 +1666,12 @@ impl Arweave {
                         .unwrap()
                         .clone()]
                 };
-                self.update_metadata_file(p.with_extension("json"), files_array, image_link)
+                self.update_metadata_file(
+                    p.with_extension("json"),
+                    files_array,
+                    image_link,
+                    animation_url_link,
+                )
             }))
             .await?;
             Ok(())

src/main.rs

@@ -202,12 +202,14 @@ async fn main() -> CommandResult {
                 .unwrap();
             let link_file = sub_arg_matches.is_present("link_file");
             let update_image = sub_arg_matches.is_present("update_image");
+            let update_animation_url = sub_arg_matches.is_present("update_animation_url");
             command_update_metadata(
                 &Arweave::default(),
                 paths_iter,
                 manifest_path,
                 link_file,
                 update_image,
+                update_animation_url,
             )
             .await
         }
@@ -555,7 +557,8 @@ fn get_app() -> App<'static, 'static> {
                 .arg(file_paths_arg())
                 .arg(manifest_path_arg())
                 .arg(link_file_arg())
-                .arg(update_image_arg()),
+                .arg(update_image_arg())
+                .arg(update_animation_url_arg())
         )
         .subcommand(
             SubCommand::with_name("update-status")
@@ -810,6 +813,15 @@ fn tags_arg<'a, 'b>() -> Arg<'a, 'b> {
         )
 }
 
+fn update_animation_url_arg<'a, 'b>() -> Arg<'a, 'b> {
+    Arg::with_name("update_animation_url")
+        .long("update-animation-url")
+        .value_name("UPDATE_ANIMATION_URL")
+        .required(false)
+        .takes_value(false)
+        .help("Update animation_url key in metadata file with link from manifest file.")
+}
+
 fn update_image_arg<'a, 'b>() -> Arg<'a, 'b> {
     Arg::with_name("update_image")
         .long("update-image")