Kompatybilność z S3

Użyj AWS SDK do przesyłania, pobierania i zarządzania plikami na IPFS Ninja z tym samym kodem, którego używasz dla Amazon S3.

Endpoint

https://s3.ipfs.ninja

Dane uwierzytelniające

S3 API używa Twojego klucza API IPFS Ninja do uwierzytelniania. Twój klucz API służy zarówno jako klucz dostępu, jak i klucz tajny.

Jak uzyskać dane uwierzytelniające

1. Przejdź do Dashboard > API Keys
2. Kliknij Create API key i nadaj mu nazwę (np. "S3 access")
3. Natychmiast skopiuj pełny klucz — jest wyświetlany tylko raz i nie można go później odzyskać

Twój klucz wygląda tak:

bws_628bba35e9e0079d9ff9c392b1b55a7b
├──────────┘└──────────────────────────┘
 prefix (12 chars)    rest of key

Mapowanie na dane uwierzytelniające AWS

Parametr AWS	Wartość	Przykład
accessKeyId	Pierwsze 12 znaków Twojego klucza API	bws_628bba35
secretAccessKey	Pełny klucz API (wszystkie 36 znaków)	bws_628bba35e9e0079d9ff9c392b1b55a7b
region	Zawsze us-east-1	us-east-1

WARNING

Pełny klucz API jest wyświetlany tylko raz podczas jego tworzenia. Jeśli go zgubisz, usuń klucz i utwórz nowy na stronie API Keys.

Szybki start

import { S3Client, PutObjectCommand, GetObjectCommand } from "@aws-sdk/client-s3";

const s3 = new S3Client({
  endpoint: "https://s3.ipfs.ninja",
  credentials: {
    accessKeyId: "bws_628bba35",
    secretAccessKey: "bws_628bba35e9e0079d9ff9c392b1b55a7b"
  },
  region: "us-east-1",
  forcePathStyle: true
});

// Upload a file
const put = await s3.send(new PutObjectCommand({
  Bucket: "my-project",
  Key: "hello.json",
  Body: JSON.stringify({ hello: "IPFS" }),
  ContentType: "application/json"
}));

console.log("CID:", put.Metadata?.cid);
// CID: QmXnnyufdzAWL5CqZ2RnSNgPbvCc1ALT73s6epPrRnZ1Xy

Bucket = foldery

Buckety S3 odpowiadają Twoim folderom IPFS Ninja. Gdy przesyłasz plik do bucketa, jest on przechowywany w odpowiednim folderze. Gdy wyświetlasz obiekty w buckecie, widzisz pliki w tym folderze.

Operacja S3	Odpowiednik IPFS Ninja
CreateBucket	Utwórz nowy folder
ListBuckets	Wyświetl swoje foldery
DeleteBucket	Usuń folder i wszystkie pliki w nim
PutObject do bucketa	Prześlij plik do folderu
ListObjectsV2 na buckecie	Wyświetl pliki w folderze

import { ListBucketsCommand, CreateBucketCommand, PutObjectCommand } from "@aws-sdk/client-s3";

// Create a bucket (= create a folder)
await s3.send(new CreateBucketCommand({ Bucket: "nft-metadata" }));

// Upload a file into the folder
await s3.send(new PutObjectCommand({
  Bucket: "nft-metadata",      // ← folder name
  Key: "token-42.json",        // ← filename within the folder
  Body: JSON.stringify({ name: "My NFT #42" })
}));

// List buckets (= list your folders)
const { Buckets } = await s3.send(new ListBucketsCommand({}));
console.log(Buckets);
// [{ Name: "nft-metadata", CreationDate: "2026-04-13T..." }]

TIP

Foldery utworzone przez S3 API to te same foldery widoczne w Twoim Dashboard. Możesz organizować pliki zarówno przez S3 API, REST API, jak i interfejs webowy — wszystkie współdzielą ten sam system folderów.

INFO

W przeciwieństwie do Amazon S3, foldery IPFS Ninja są domyślnie płaskie. Aby tworzyć zagnieżdżone struktury, użyj endpointów folderów REST API z parentFolderId. Z S3 API użyj prefiksów kluczy (np. images/photo.png), aby organizować pliki w folderze.

Obsługiwane operacje

PutObject

Prześlij plik na IPFS. Plik jest przypinany, skanowany pod kątem bezpieczeństwa, a CID jest zwracany w nagłówkach ETag i x-amz-meta-cid.

import { PutObjectCommand } from "@aws-sdk/client-s3";
import fs from "fs";

const result = await s3.send(new PutObjectCommand({
  Bucket: "my-project",
  Key: "photo.png",
  Body: fs.readFileSync("photo.png"),
  ContentType: "image/png"
}));

console.log("CID:", result.ETag);

# curl equivalent
curl -X PUT "https://s3.ipfs.ninja/my-project/photo.png" \
  --data-binary @photo.png \
  -H "Content-Type: image/png" \
  --aws-sigv4 "aws:amz:us-east-1:s3" \
  --user "bws_628bba35:bws_628bba35e9e0079d9ff9c392b1b55a7b"

GetObject

Pobierz plik po kluczu (nazwie pliku) lub CID.

import { GetObjectCommand } from "@aws-sdk/client-s3";

const result = await s3.send(new GetObjectCommand({
  Bucket: "my-project",
  Key: "photo.png"
}));

const body = await result.Body.transformToByteArray();
console.log("Size:", body.length);
console.log("CID:", result.Metadata?.cid);

HeadObject

Pobierz metadane pliku bez pobierania zawartości.

import { HeadObjectCommand } from "@aws-sdk/client-s3";

const head = await s3.send(new HeadObjectCommand({
  Bucket: "my-project",
  Key: "photo.png"
}));

console.log("Size:", head.ContentLength);
console.log("Type:", head.ContentType);
console.log("CID:", head.Metadata?.cid);

DeleteObject

Odepnij plik z IPFS i usuń go ze swojego konta.

import { DeleteObjectCommand } from "@aws-sdk/client-s3";

await s3.send(new DeleteObjectCommand({
  Bucket: "my-project",
  Key: "photo.png"
}));

ListObjectsV2

Wyświetl pliki w buckecie z opcjonalnym filtrowaniem prefiksów i paginacją.

import { ListObjectsV2Command } from "@aws-sdk/client-s3";

const list = await s3.send(new ListObjectsV2Command({
  Bucket: "my-project",
  Prefix: "images/",
  MaxKeys: 100
}));

for (const obj of list.Contents ?? []) {
  console.log(obj.Key, obj.Size, obj.ETag); // ETag = CID
}

Multipart Upload

Przesyłaj duże pliki (do 5 GB) za pomocą przesyłania wieloczęściowego. AWS SDK obsługuje to automatycznie:

import { Upload } from "@aws-sdk/lib-storage";
import fs from "fs";

const upload = new Upload({
  client: s3,
  params: {
    Bucket: "my-project",
    Key: "large-dataset.tar.gz",
    Body: fs.createReadStream("large-dataset.tar.gz"),
    ContentType: "application/gzip"
  },
  partSize: 10 * 1024 * 1024, // 10 MB per part
});

upload.on("httpUploadProgress", (progress) => {
  console.log(`Uploaded ${progress.loaded} of ${progress.total} bytes`);
});

const result = await upload.done();
console.log("CID:", result.ETag);

Lub ręcznie kontroluj części:

import {
  CreateMultipartUploadCommand,
  UploadPartCommand,
  CompleteMultipartUploadCommand
} from "@aws-sdk/client-s3";

// 1. Start
const { UploadId } = await s3.send(new CreateMultipartUploadCommand({
  Bucket: "my-project",
  Key: "big-file.bin"
}));

// 2. Upload parts
const part1 = await s3.send(new UploadPartCommand({
  Bucket: "my-project",
  Key: "big-file.bin",
  UploadId,
  PartNumber: 1,
  Body: chunk1
}));

// 3. Complete
const result = await s3.send(new CompleteMultipartUploadCommand({
  Bucket: "my-project",
  Key: "big-file.bin",
  UploadId,
  MultipartUpload: {
    Parts: [{ PartNumber: 1, ETag: part1.ETag }]
  }
}));

Przykład Python

import boto3

s3 = boto3.client(
    "s3",
    endpoint_url="https://s3.ipfs.ninja",
    aws_access_key_id="bws_628bba35",
    aws_secret_access_key="bws_628bba35e9e0079d9ff9c392b1b55a7b",
    region_name="us-east-1"
)

# Upload
s3.put_object(
    Bucket="my-project",
    Key="data.json",
    Body=b'{"hello": "IPFS"}',
    ContentType="application/json"
)

# List files
response = s3.list_objects_v2(Bucket="my-project")
for obj in response.get("Contents", []):
    print(obj["Key"], obj["Size"])

# Download
result = s3.get_object(Bucket="my-project", Key="data.json")
print(result["Body"].read())

Przykład Go

package main

import (
    "context"
    "fmt"
    "strings"

    "github.com/aws/aws-sdk-go-v2/aws"
    "github.com/aws/aws-sdk-go-v2/credentials"
    "github.com/aws/aws-sdk-go-v2/service/s3"
)

func main() {
    client := s3.New(s3.Options{
        BaseEndpoint: aws.String("https://s3.ipfs.ninja"),
        Region:       "us-east-1",
        Credentials:  credentials.NewStaticCredentialsProvider("bws_628bba35", "bws_628bba35e9e0...", ""),
        UsePathStyle: true,
    })

    _, err := client.PutObject(context.TODO(), &s3.PutObjectInput{
        Bucket:      aws.String("my-project"),
        Key:         aws.String("hello.txt"),
        Body:        strings.NewReader("Hello, IPFS!"),
        ContentType: aws.String("text/plain"),
    })
    if err != nil {
        panic(err)
    }
    fmt.Println("Uploaded!")
}

Różnice w stosunku do Amazon S3

Funkcja	Amazon S3	IPFS Ninja S3
Model przechowywania	Modyfikowalne obiekty	Adresowanie zawartością (niezmienne CID)
Zachowanie przy nadpisywaniu	Zastępuje obiekt w miejscu	Tworzy nowy CID, stary CID nadal dostępny
Wersjonowanie	Obsługiwane	Nieobsługiwane (użyj CID do wersjonowania)
Szyfrowanie po stronie serwera	Obsługiwane	Nieobsługiwane (zawartość jest w IPFS)
Polityki cyklu życia	Obsługiwane	Nieobsługiwane
Polityki bucketów / ACL	Obsługiwane	Użyj trybów dostępu gateway
Wstępnie podpisane URL-e	Obsługiwane	Użyj podpisanych tokenów przesyłania
Maksymalny rozmiar obiektu	5 TB	5 GB (wieloczęściowe), 100 MB (pojedynczy PUT)
Regiony	Wiele regionów	Tylko us-east-1
Wartość ETag	MD5 hash	IPFS CID
Dodatkowe nagłówki	Standardowe S3	x-amz-meta-cid (IPFS CID)

Migracja z Amazon S3

Zamień konfigurację klienta S3:

 const s3 = new S3Client({
+  endpoint: "https://s3.ipfs.ninja",
   credentials: {
-    accessKeyId: "AKIA...",
-    secretAccessKey: "wJalrX..."
+    accessKeyId: "bws_628bba35",
+    secretAccessKey: "bws_628bba35e9e0..."
   },
   region: "us-east-1",
+  forcePathStyle: true
 });

Twoje istniejące wywołania PutObject, GetObject, ListObjectsV2 i DeleteObject działają bez zmian.

Migracja z Filebase

Zamień URL endpoint:

 const s3 = new S3Client({
-  endpoint: "https://s3.filebase.com",
+  endpoint: "https://s3.ipfs.ninja",
   credentials: {
-    accessKeyId: "FILEBASE_KEY",
-    secretAccessKey: "FILEBASE_SECRET"
+    accessKeyId: "bws_628bba35",
+    secretAccessKey: "bws_628bba35e9e0..."
   },
   region: "us-east-1",
   forcePathStyle: true
 });