Skip to content

Latest commit

 

History

History
101 lines (55 loc) · 5.71 KB

akord-arweave-blockchain.md

File metadata and controls

101 lines (55 loc) · 5.71 KB
Raw

Akord - Arweave blockchain

Introduction

Akord is an app, API, SDK and CLI enabling permanent data storage on the Arweave blockchain with one upfront payment.

Akord vaults can be used to store any data – images, videos, documents, audio, even websites and applications. After uploading a file, an Arweave gateway URL will be available (it normally takes 5-15 minutes for files to be committed on-chain), enabling the minting of a data NFT.

Below are different options for uploading assets and obtaining the Arweave gateway URL using the app and API.

Upload with the Akord app

1. Create your account in a few minutes. Get 100 MB of free blockchain storage to test your workflow.

2. Select “NFT assets” when you login as the template for creating your first vault:

  1. Give your vault a name and optionally add a description and tag, which can help your vault be discovered on-chain in the future:

  1. Drag and drop your assets into the main vault window or select the files by clicking “Upload a file”:

  1. Click the info icon on the right side of the row once the file is uploaded to the vault:

  1. Get an Arweave gateway URL. There are two options – akrd.net, Akord’s own gateway, or arweave.net, another popular gateway in the ecosystem:

  • Note that once the file is uploaded it takes a few moments to reflect on the Decentralized storage file explorer.
  • Upon copying the URL kindly place it in a new tab/window to check if the file is accessible.

This URL can now be used for Data NFT minting.

  1. Generate a manifest if you have multiple NFTs (optional).

If you’re uploading many assets, you can generate an Arweave manifest that will contain all transaction IDs in one JSON.

Click “Create JSON metadata” link in the top right of the vault, and select the Arweave manifest option

The generated manifest.json will look like this with all transaction IDs listed for any file in the vault:

All gateways follow the same scheme: https://{gateway host}/{tx-id}

You’ll also find Akord documentation on how to generate a manifest with the CLI, along with a script for generating Arweave gateway URLs without using a manifest file.

These Arweave gateway URLs can be used for Data NFT minting.

Simple API upload

Using this method, you can use the Akord API to upload to arweave.

1. Create your account in a few minutes. Get 100 MB of free blockchain storage to test your workflow.

2. Get your API key here.

3. A simple API method in JavaScript: 

// Javascript

const fs = require('fs').promises;
const data = await fs.readFile('/path/to/your/file.txt', 'utf8'); //nodejs specific

const response = await fetch('https://api.akord.com/files', {
    method: 'POST',
    headers: {
        'Accept': 'application/json',
        'Api-Key': 'your_api_key',
        'Content-Type': 'text/plain'
    },
    body: data
})


More API documentation

For code snippets in Bash and Python, example responses, and upload methods with tags and larger multipart upload guidelines, check out the Akord docs.

The End Result

Upon implementing the above steps, the final result will look like this.

{% embed url="https://www.youtube.com/watch?v=LgRhwXyhPNU" %}