# JS / Docker example code

## Akave Link API - Hackathon Documentation

Welcome to the Akave Link API! This API wrapper enables seamless integration with Akave's decentralized storage network. Below, you’ll find quick setup steps, examples of how to use each API endpoint with JavaScript, and equivalent `curl` commands.

Github repo for reference : <https://github.com/akave-ai/akavelink>

Installing docker : <https://docs.docker.com/engine/install/>

### Getting Started

#### Step 1: Pull the Docker Image

To start, pull the Akave Link Docker image:

```bash
docker pull akave/akavelink:latest
```

#### Step 2: Get a Wallet Address and Request Funds

* Visit <https://faucet.akave.ai> to obtain a wallet address and add the Akave chain to MetaMask.
* Request funds from the faucet to start experimenting with the Akave Link API.

<figure><img src="/files/r0CqlLAqtL1SA5RrcHll" alt=""><figcaption></figcaption></figure>

{% hint style="danger" %}
**Always be careful when dealing with your private key. Double-check that you’re not hardcoding it anywhere or committing it to Git. Remember: anyone with access to your private key has complete control over your funds.**

Ensure you’re not reusing a private key that’s been deployed on other EVM chains. Each blockchain has its own attack vectors, and reusing keys across chains exposes you to cross-chain vulnerabilities. Keep separate keys to maintain isolation and protect your assets.
{% endhint %}

#### Blockchain explorer : <http://explorer.akave.ai>

#### Step 3: Run the Akave Link Container

Run the container and specify the `PRIVATE_KEY` environment variable:

{% hint style="success" %}
With Akavelink we expect you to use the blockchain enabled storage network on port 5500
{% endhint %}

**Node Address Public endpoint (** NODE\_ADDRESS **)  ->  `connect.akave.ai:5500`**

```bash
docker run -d \
  -p 8000:3000 \
  -e NODE_ADDRESS="public_node_address" \
  -e PRIVATE_KEY="your_private_key" \
  akave/akavelink:latest
```

The API will now be running locally at `http://localhost:8000`.

### Setting Up the JavaScript Wrapper

Here's a quick setup to interact with the Akave API using JavaScript:

```javascript
const axios = require('axios');

const API_BASE_URL = 'http://localhost:8000';

async function apiRequest(method, endpoint, data = null) {
  try {
    const response = await axios({
      method,
      url: `${API_BASE_URL}${endpoint}`,
      data,
    });
    console.log(response.data);
  } catch (error) {
    console.error(error.response ? error.response.data : error.message);
  }
}
```

#### Example Usage:

Each section below demonstrates API calls using this wrapper, alongside the `curl` equivalent.

***

### Bucket Operations

#### 1. Create a Bucket

Create a new storage bucket.

**JavaScript Example:**

```javascript
apiRequest('POST', '/buckets', { bucketName: 'myBucket' });
```

**`curl` Command:**

```bash
curl -X POST http://localhost:8000/buckets -H "Content-Type: application/json" -d '{"bucketName": "myBucket"}'
```

#### 2. List Buckets

Retrieve all existing buckets.

**JavaScript Example:**

```javascript
apiRequest('GET', '/buckets');
```

**`curl` Command:**

```bash
curl -X GET http://localhost:8000/buckets
```

#### 3. View Bucket Details

Retrieve details of a specific bucket.

**JavaScript Example:**

```javascript
apiRequest('GET', '/buckets/myBucket');
```

**`curl` Command:**

```bash
curl -X GET http://localhost:8000/buckets/myBucket
```

***

### File Operations

#### 1. List Files in a Bucket

Retrieve a list of files within a bucket.

**JavaScript Example:**

```javascript
apiRequest('GET', '/buckets/myBucket/files');
```

**`curl` Command:**

```bash
curl -X GET http://localhost:8000/buckets/myBucket/files
```

#### 2. Get File Info

Fetch metadata about a specific file.

**JavaScript Example:**

```javascript
apiRequest('GET', '/buckets/myBucket/files/myFile.txt');
```

**`curl` Command:**

```bash
curl -X GET http://localhost:8000/buckets/myBucket/files/myFile.txt
```

#### 3. Upload a File

Upload a file to a bucket.

{% hint style="info" %}
Make sure the minimum file size is 127 bytes! Keep max size to test at 100MB
{% endhint %}

**JavaScript Example (using FormData):**

```javascript
const FormData = require('form-data');
const fs = require('fs');

async function uploadFile(bucketName, filePath) {
  const form = new FormData();
  form.append('file', fs.createReadStream(filePath));
  
  try {
    const response = await axios.post(`${API_BASE_URL}/buckets/${bucketName}/files`, form, {
      headers: form.getHeaders(),
    });
    console.log(response.data);
  } catch (error) {
    console.error(error.response ? error.response.data : error.message);
  }
}

uploadFile('myBucket', './path/to/file.txt');
```

**`curl` Command:**

```bash
curl -X POST http://localhost:8000/buckets/myBucket/files -F file=@/path/to/file.txt
```

#### 4. Download a File

Download a file from a bucket.

**JavaScript Example:**

```javascript
async function downloadFile(bucketName, fileName, outputDir) {
  try {
    const response = await axios.get(`${API_BASE_URL}/buckets/${bucketName}/files/${fileName}/download`, {
      responseType: 'blob',
    });
    console.log(`File downloaded: ${fileName}`);
    fs.writeFileSync(`./${outputDir}/${fileName}`, response.data);
  } catch (error) {
    console.error(error.response ? error.response.data : error.message);
  }
}
```

You can download the file directly in your browser or provide a download url with a public hosted API by using:\
`http(s)://ip-or-dns-name/buckets/:BucketName/files/:FileName/download`

**`curl` Command:**

```bash
curl -X GET http://localhost:8000/buckets/myBucket/files/myFile.txt/download -o myFile.txt
```

Output file extention should be the same as the requested file.

***

### Error Handling

All endpoints return errors in the following format:

```json
{
    "success": false,
    "error": "error message"
}
```

Ensure you handle these responses in your code to capture and process errors effectively.

Good luck with your hackathon, and have fun building with Akave’s decentralized storage API!


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://hackathon-docs.akave.ai/js-docker-example-code.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.