Pointers

Pointers are a mutable data type on the Autonomi Network that allow you to create a persistent address which can point to any other network address (mutable or immutable).

Data Flow

Create/Update Pointer Flow

A pointer is created using a private key (x-data-key). Only the holder of this key can update the pointer.

sequenceDiagram
    participant Client
    participant AntTP
    participant Autonomi

    Client->>AntTP: POST/PUT /anttp-0/pointer (JSON + x-data-key)
    AntTP->>Autonomi: Create/Update Pointer
    Autonomi-->>AntTP: Success
    AntTP-->>Client: Pointer Address

Resolve Pointer Flow

When AntTP encounters a pointer address in a URL, it resolves it to find the target address it points to.

sequenceDiagram
    participant Client
    participant AntTP
    participant Cache
    participant Autonomi

    Client->>AntTP: GET /[POINTER_ADDRESS]
    AntTP->>Cache: Check Pointer Cache
    alt Cache Hit
        Cache-->>AntTP: Target Address
    else Cache Miss
        AntTP->>Autonomi: Retrieve Pointer
        Autonomi-->>AntTP: Target Address
        AntTP->>Cache: Cache Pointer
    end
    AntTP->>AntTP: Resolve Target Address (File/Archive)
    AntTP-->>Client: Return Target Data

API Endpoints

REST API

• POST /anttp-0/pointer: Create a new pointer.
• PUT /anttp-0/pointer/{address}: Update an existing pointer.
• GET /anttp-0/pointer/{address}: Retrieve the target address of a pointer.

MCP Tools

• create_pointer: Creates a new pointer.
• update_pointer: Updates an existing pointer.
• get_pointer: Retrieves a pointer by its address.

gRPC API

• PutPointer: Create or update a pointer.
• GetPointer: Retrieve a pointer.

Private Keys (x-data-key)

When working with pointers, you must specify which private key to use:

• personal: Uses the app private key provided at startup.
• resolver: Uses the PNR shared resolver key.
• [Hex String]: Uses a custom hex-encoded private key.

---

<< Previous | Up | Next >>