From 914c9e256acd6f9adfff764beafdbe0983cff14a Mon Sep 17 00:00:00 2001
From: veeso <christian.visintin@veeso.dev>
Date: Wed, 21 Feb 2024 18:29:04 +0100
Subject: [PATCH] fix: ekoke archive docs

---
 docs/README.md                  |  1 +
 docs/canisters/ekoke-archive.md | 42 +++++++++++++++++++++++++++++++++
 2 files changed, 43 insertions(+)
 create mode 100644 docs/canisters/ekoke-archive.md

diff --git a/docs/README.md b/docs/README.md
index 5c147dc..7f408d0 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -3,6 +3,7 @@
 ## Canisters
 
 - [Deferred](./canisters/deferred.md)
+- [EKOKE-archive](./canisters/ekoke-archive.md)
 - [EKOKE-index](./canisters/ekoke-index.md)
 - [Marketplace](./canisters/marketplace.md)
 
diff --git a/docs/canisters/ekoke-archive.md b/docs/canisters/ekoke-archive.md
new file mode 100644
index 0000000..2da61a4
--- /dev/null
+++ b/docs/canisters/ekoke-archive.md
@@ -0,0 +1,42 @@
+# EKOKE-archive
+
+- [EKOKE-archive](#ekoke-archive)
+
+## Introduction
+
+The ekoke-index canister takes care of providing the transaction history for each account.
+
+## API
+
+See the full documentation on the [DID](../../src/ekoke_archive/ekoke-archive.did)
+
+This API implements the archive canister standard according to the SNS DAO.
+
+### append_blocks
+
+It is called by ekoke-ledger to append blocks.
+
+> Currently this method is not used or implemented. Currently we use just the commit method to achieve this
+
+### get_blocks
+
+Get blocks.
+
+> Currently, this method is not implemented and no matter what, it returns always an empty vec
+
+### get_transaction
+
+Get transaction by id
+
+### get_transactions
+
+Get transactions by count and offset
+
+### remaining_capacity
+
+Get block remaining capacity (Max is 10GB).
+
+### commit
+
+This endpoint is called by the ekoke-ledger to commit a transaction into the index.
+Sequentially, it calls `commit` on the ekoke-index to synchronize the indexes.