Archives & Tarchives

Archives are used to group multiple files together on the Autonomi Network, allowing them to be retrieved by name.

Data Flow

Create Public Archive

Creating a public archive involves uploading multiple files as multipart/form-data. AntTP handles chunking each file and generating an archive index.

sequenceDiagram
    participant Client
    participant AntTP
    participant Autonomi

    Client->>AntTP: POST /anttp-0/multipart/public_archive
    loop For each file
        AntTP->>Autonomi: Store Chunks
    end
    AntTP->>AntTP: Generate Index
    AntTP->>Autonomi: Store Index
    Autonomi-->>AntTP: Archive Address
    AntTP-->>Client: Upload Summary

Retrieve from Archive

Retrieving a file from an archive requires fetching the index first.

sequenceDiagram
    participant Client
    participant AntTP
    participant Cache
    participant Autonomi

    Client->>AntTP: GET /[ARCHIVE_ADDRESS]/file.txt
    AntTP->>Cache: Check Index Cache
    alt Index Not Cached
        AntTP->>Autonomi: Retrieve Index
        Autonomi-->>AntTP: Index
        AntTP->>Cache: Cache Index
    end
    AntTP->>AntTP: Lookup XOR for 'file.txt'
    AntTP->>Client: Stream File Data (XOR)

API Endpoints

REST API

• Public Archive:
  • POST /anttp-0/multipart/public_archive: Create a new archive.
  • PUT /anttp-0/multipart/public_archive/{address}: Update an existing archive.
• Tarchive:
  • POST /anttp-0/multipart/tarchive: Create a new tarchive.
  • PUT /anttp-0/multipart/tarchive/{address}: Update an existing tarchive.

MCP Tools

• create_archive: Creates an archive of files.
• update_archive: Updates an existing archive.

gRPC API

• PutPublicArchive: Create or update a public archive.
• PutTarchive: Create or update a tarchive.

Archive Types

• Public Archive: A collection of independent files and an index. Best for general-purpose file hosting.
• Tarchive: A tarball with an appended index. Highly efficient for many small files and maintaining chronological order.

---

<< Previous | Up | Next >>