Skip to main content

Metadata

Metadata & Arweave commands.

arweave​

Arweave commands for uploading and managing metadata files.

upload-single​

$ joystiq metadata arweave upload-single <file-path>
  • <file-path>: Path to the metadata file to upload

Options​

  • -w --wallet <wallet-path>: Path to Arweave keypair JSON file (default is pulled from chain config arweave_wallet_path)
  • -u --url <url>: Arweave gateway URL (default: https://arweave.net)
  • -s --skip-confirm: Skip confirmation for the transaction cost (default: false)

upload​

Upload metadata files to Arweave. This command will upload the metadata files in 'assets' folder of selected project to Arweave. It will upload every image files then create a 'metadata.json' file in the project directory. You have to run joystiq collection metadata set <project-path> command to set the metadata for the collection after uploading the assets.

$ joystiq metadata arweave upload <project-path>
  • <project-path>: The path to the project directory.

Options​

  • -w --wallet <wallet-path>: Path to Arweave keypair JSON file
  • -u --url <url>: Arweave gateway URL (default: https://arweave.net)
  • -s --skip-confirm: Skip confirmation for the transaction cost (default: false)
  • -m --max-retries <maxRetries>: Maximum number of retries for uploading images (default: "3")

When you run the upload command,

a cache file will be created in the '.arweave/cache.json' file for tracking transaction IDs.

a '.arweave/log.json' file will be created for any errors.

If your upload gets interrupted, CLI will use the 'cache.json' file to resume the upload.

walrus (Experimental)​

Walrus commands for uploading and managing metadata files. (walrus uses the sui wallet in chain config) Right now walrus support is in experimental stage, you can upload metadata files to walrus, but you cannot mint NFTs with it yet.

upload-single​

$ joystiq metadata walrus upload-single <file-path>
  • <file-path>: Path to the metadata file to upload

Options​

  • -s --skip-confirm: Skip confirmation for the transaction cost (default: false)
  • -t --tip <tip>: Max relay tip in WAL (default: "1000") (smallest unit of WAL)
  • -u --url <url>: Base (Aggregator) URL for the image (default is walrus.space depending on the network)
  • -ur --upload-relay <url>: Upload relay URL (default is walrus.space depending on the network)

upload​

Upload metadata files to Walrus. This command will upload the metadata files in 'assets' folder of selected project to Walrus. It will upload every image files then create a 'metadata.json' file in the project directory.

$ joystiq metadata walrus upload <project-path>
  • <project-path>: The path to the project directory.

Options​

  • -s --skip-confirm: Skip confirmation for the transaction cost (default: false)
  • -m --max-retries <maxRetries>: Maximum number of retries for uploading images (default: "3")
  • -t --tip <tip>: Max relay tip in WAL (default: "1000") (smallest unit of WAL)
  • -u --url <url>: Base (Aggregator) URL for the images (default is walrus.space depending on the network)
  • -ur --upload-relay <url>: Upload relay URL (default is walrus.space depending on the network)

When you run the upload command,

a cache file will be created in the '.walrus/cache.json' file for tracking transaction IDs.

a '.walrus/log.json' file will be created for any errors.

If your upload gets interrupted, CLI will use the 'cache.json' file to resume the upload.