Skip to content

Commit

Permalink
fix: ekoke archive docs
Browse files Browse the repository at this point in the history
  • Loading branch information
veeso committed Feb 21, 2024
1 parent cdbabdd commit 914c9e2
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
42 changes: 42 additions & 0 deletions docs/canisters/ekoke-archive.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 914c9e2

Please sign in to comment.