arkiv-sdk 0.2.2

Arkiv Python SDK.

Arkiv

This is part of the Arkiv project, which is designed as a Layer2 Network deployed on Ethereum, acting as a gateway to various Layer 3 Database Chains (DB-Chains).

For an overview of Arkiv, check out our Litepaper.

Arkiv SDK for Python

This SDK allows you to use Arkiv from Python. It is available on PyPI.

We also publish generated documentation.

The repo also contains an example application to showcase how you can use this SDK.

Tip: For getting up and running quickly, we recommend the following two steps:

• Start golembase-op-geth through its docker-compose.

• Install the demo CLI and create a user.

(Note: As an alternative to installing the demo CLI, you can build the actual CLI as it's included in the golembase-op-geth repo.)

When you create a user, it will generate a private key file called wallet.json and store it in:

• ~/.config/golembase/ on Linux
• ~/Library/Application Support/golembase/ on macOS
• %LOCALAPPDATA%\golembase\ on Windows

(This is a standard folder as per the XDG specification.)

You will also need to fund the account. You can do so by typing:

golembase-demo-cli account fund 10

Getting Started Example

Here's how you can get going with the SDK. First, create a new folder to hold your project:

mkdir arkiv-sdk-practice
cd arkiv-sdk-practice

Then create and activate a virtual environment:

python3 -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

Next, install the Arkiv SDK from PyPI:

pip install arkiv-sdk

You can find some base starter code here; copy the __init__.py into your project folder.

This is a basic Python application that:

• Imports several items from the SDK (arkiv_sdk), including:

  • ArkivClient: A class that creates a client to interact with Arkiv
  • ArkivCreate: A class representing a create transaction in Arkiv
  • ArkivExtend: A class for extending entity lifetime
  • Annotation: A class for key-value annotations

• Reads the private key, which it locates using the xdg module.

• Sets up logging with the standard Python logging module.

• The main() function follows, which is where the bulk of the example code runs.

The main function demonstrates how to create, extend, and query entities:

• Creates a client object that connects to the Arkiv network (e.g., Kaolin testnet) using rpc and ws URLs, and your private key.

• Subscribes to log events from the network (create, update, delete, extend).

• Creates an entity with data "hello", BTL of 60, and an annotation of ("foo", "bar").

• Prints various metadata and state:

  • The latest block
  • Entity count before and after creation
  • Entity metadata
  • Storage value
  • Entity expiration info
  • Query results by annotation

• Extends the created entity’s lifetime using client.extend_entities.

• Lists entities owned by your account, and all known entity keys.

Building and Running from sources

You can also, from this cloned repo, build the SDK and run the example using Nix:

nix build .#arkiv-sdk-example
./result/bin/main