How to upload a folder to IPFS

Prerequisites

Before getting started, make sure you have the following ready:

• Node v.14+ or Python
• NPM/Yarn or Pip

Step 1: Setup Moralis

First register your Moralis account and get your Moralis API Key.

Once you have your Moralis API Key, install the Moralis SDK in your project.

npm

npm install moralis @moralisweb3/common-evm-utils

yarn

yarn add moralis @moralisweb3/common-evm-utils

pnpm

pnpm add moralis @moralisweb3/common-evm-utils

pip

pip install moralis

Step 2: Upload a Folder to IPFS

In order to upload a folder to IPFS, Moralis provides you a uploadFolder endpoint to do so.

Here you'll need two parameters: path and content.

Once you have obtained both the path and content, you can copy the following code:

index.js (JavaScript)

const Moralis = require("moralis").default;
const { EvmChain } = require("@moralisweb3/common-evm-utils");

const runApp = async () => {
  await Moralis.start({
    apiKey: "YOUR_API_KEY",
    // ...and any other configuration
  });

  const abi = [
    {
      path: "YOUR_FILE_PATH",
      content: "YOUR_JSON_OR_BASE64",
    },
  ];

  const response = await Moralis.EvmApi.ipfs.uploadFolder({ abi });

  console.log(response.toJSON());
};

runApp();

index.ts (TypeScript)

import Moralis from "moralis";
import { EvmChain } from "@moralisweb3/common-evm-utils";

const runApp = async () => {
  await Moralis.start({
    apiKey: "YOUR_API_KEY",
    // ...and any other configuration
  });

  const abi = [
    {
      path: "YOUR_FILE_PATH",
      content: "YOUR_JSON_OR_BASE64",
    },
  ];

  const response = await Moralis.EvmApi.ipfs.uploadFolder({ abi });

  console.log(response.toJSON());
};

runApp();

index.py (Python)

from moralis import evm_api

api_key = "YOUR_API_KEY"
body = [{
    "path": "moralis/logo.webp",
    "content": "iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAApgAAAKYB3X3",
}]

result = evm_api.ipfs.upload_folder(
    api_key=api_key,
    body=body,
)

print(result)

Step 3: Run the script

To run the script, enter the following command:

Shell (JavaScript)

node index.js

Shell (TypeScript)

ts-node index.ts

Shell (Python)

python index.py

In your terminal, you should see the following JSON response:

[
  {
    "path": "https://ipfs.moralis.io:2053/ipfs/QmfL6fMaYJDnizFVj4wxyutDnGMePG2JL95rN2A5mcWyB1/moralis/logo.webp"
  }
]

Congratulations 🥳 You just uploaded your files to IPFS with just a few lines of code using the Moralis IPFS API!

API Reference

If you want to know more details on the endpoint and optional parameters, check out:

• uploadFolder

Support

If you face any trouble following the tutorial, feel free to reach out to our community engineers in our Discord or Forum to get 24/7 developer support.