moving files

Author: Gwojda

src/icrc3_canisters/README.md

@@ -0,0 +1,39 @@
+# ICRC-3 Rust Implementation
+
+This repository contains a Rust implementation of the ICRC-3 standard for the Internet Computer (ICP). ICRC-3 defines a generic value type for interoperable token transactions and ledger interactions.
+
+## Project Structure
+
+### Backend canisters
+
+All the backend canisters are included in the folder [`backend/canisters`](backend/canisters/). This includes
+
+- [`icrc3`](backend/canisters/icrc3/): The core logic for the archive creation, blocks archiving.
+- [`icrc3_archive`](backend/canisters/icrc3_archive/): The archive canister that stores archived blocks.
+
+## Local development instructions
+
+### Clone this repository
+
+```sh
+git clone "ADD LINK HERE"
+```
+
+(Or from the Origyn internal Gitlab url, from which this Github repo is automatically mirrored)
+
+### Install the dependencies
+
+First, ensure that you have [`cargo`](https://doc.rust-lang.org/cargo/getting-started/installation.html) and [`ic-wasm`](https://github.com/dfinity/ic-wasm) installed, as well as [`wasmtime`](https://wasmtime.dev).  
+Then from the repository's root folder:
+
+```sh
+npm install
+```
+
+## Technical documentation
+
+- Developers documentation still :construction: WIP (See code comments for now. Documentation will be automatically generated and published at a later time)
+
+## DevOps documentation
+
+- :construction: WIP on Origyn's internal Gitlab wiki

src/icrc3_canisters/canisters/icrc3_archive/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+
+## Versions
+
+### [unreleased]
+
+### [1.0.0] - 2025-02-18
+
+#### Description
+This marks the initial release of the archive canister, which is designed to work alongside the ICRC-3 core canister.
+The archive canister **stores historical transactions**, enabling scalability by allowing the ICRC-3 core canister to **spawn new archives** as needed.
+This architecture ensures efficient transaction storage and retrieval while maintaining performance.
+
+#### Added
+- **Transaction Archiving**: Stores historical transactions offloaded from the core ICRC-3 canister.
+- **Efficient Querying**: Provides methods to retrieve stored transactions efficiently.
+- **Metadata Management**: Supports fetching archive metadata for monitoring and indexing.
+- **Data Integrity**: Ensures consistency between the core canister and its archives.

src/icrc3_canisters/canisters/icrc3_archive/api/Cargo.toml

@@ -0,0 +1,24 @@
+[package]
+name = "bity-ic-icrc3-archive-api"
+version = "0.1.0"
+description = "bity icrc3 archive api"
+edition = "2021"
+license = "MIT"
+repository = "https://github.com/BitySA/dfinity-rust-libraries"
+keywords = ["dfinity", "internet-computer", "ic", "canister", "subcanister"]
+authors = ["Bity Team", "Gautier Wojda <[email protected]>", "Freddie Hands <[email protected]>", "Victoria Horbunova <[email protected]>", "Dustin Becker <[email protected]>"]
+documentation = "https://docs.rs/bity-ic-icrc3-archive-api"
+
+[features]
+inttest = []
+
+[dependencies]
+bity-ic-types = { workspace = true }
+candid = { workspace = true }
+icrc-ledger-types = { workspace = true }
+serde = { workspace = true, features = ["derive"] }
+serde_bytes = { workspace = true }
+ic-stable-structures = { workspace = true }
+sha2 = { workspace = true }
+hex = { workspace = true }
+serde_cbor = { workspace = true }

src/icrc3_canisters/canisters/icrc3_archive/api/can.did

@@ -0,0 +1,49 @@
+type ArchiveConfig = record {
+  max_blocks_per_response : nat64;
+  block_offset : nat64;
+  max_memory_size_bytes : nat;
+};
+type ArchivedBlocks = record {
+  args : vec GetBlocksRequest;
+  callback : func (vec GetBlocksRequest) -> (GetBlocksResult) query;
+};
+type Args = variant { Upgrade : UpgradeArgs; Init : InitArgs };
+type BlockType = variant { ICRC1; Default };
+type BlockWithId = record { id : nat; block : ICRC3Value };
+type BuildVersion = record { major : nat32; minor : nat32; patch : nat32 };
+type GetBlocksRequest = record { start : nat; length : nat };
+type GetBlocksResult = record {
+  log_length : nat;
+  blocks : vec BlockWithId;
+  archived_blocks : vec ArchivedBlocks;
+};
+type ICRC3Value = variant {
+  Int : int;
+  Map : vec record { text; ICRC3Value };
+  Nat : nat;
+  Blob : blob;
+  Text : text;
+  Array : vec ICRC3Value;
+};
+type InitArgs = record {
+  master_canister_id : principal;
+  test_mode : bool;
+  block_type : BlockType;
+  archive_config : ArchiveConfig;
+  authorized_principals : vec principal;
+  version : BuildVersion;
+  commit_hash : text;
+};
+type Response = variant { Error : text; Success };
+type UpgradeArgs = record {
+  block_type : BlockType;
+  version : BuildVersion;
+  commit_hash : text;
+};
+service : (Args) -> {
+  get_version : (null) -> (BuildVersion) query;
+  icrc3_get_blocks : (vec GetBlocksRequest) -> (GetBlocksResult) query;
+  insert_blocks : (vec blob) -> (Response);
+  remaining_capacity : (null) -> (nat) query;
+  total_transactions : (null) -> (nat64) query;
+}

src/icrc3_canisters/canisters/icrc3_archive/api/src/lib.rs

@@ -0,0 +1,11 @@
+pub mod lifecycle;
+pub mod queries;
+pub mod types;
+pub mod updates;
+
+pub use lifecycle::*;
+pub use queries::*;
+pub use types::*;
+pub use updates::*;
+
+pub const VERSION: &str = env!("CARGO_PKG_VERSION");

src/icrc3_canisters/canisters/icrc3_archive/api/src/lifecycle/init.rs

@@ -0,0 +1,31 @@
+use crate::archive_config::ArchiveConfig;
+use crate::lifecycle::BlockType;
+
+use bity_ic_types::BuildVersion;
+use candid::{CandidType, Principal};
+use serde::{Deserialize, Serialize};
+
+#[derive(Deserialize, Serialize, CandidType, Debug, Clone)]
+pub struct InitArgs {
+    pub test_mode: bool,
+    pub version: BuildVersion,
+    pub commit_hash: String,
+    pub authorized_principals: Vec<Principal>,
+    pub archive_config: ArchiveConfig,
+    pub master_canister_id: Principal,
+    pub block_type: BlockType,
+}
+
+impl Default for InitArgs {
+    fn default() -> Self {
+        Self {
+            test_mode: false,
+            version: BuildVersion::default(),
+            commit_hash: String::new(),
+            authorized_principals: Vec::new(),
+            archive_config: ArchiveConfig::default(),
+            master_canister_id: Principal::anonymous(),
+            block_type: BlockType::Default,
+        }
+    }
+}

src/icrc3_canisters/canisters/icrc3_archive/api/src/lifecycle/mod.rs

@@ -0,0 +1,20 @@
+use candid::CandidType;
+use init::InitArgs;
+use post_upgrade::UpgradeArgs;
+use serde::{Deserialize, Serialize};
+
+pub mod init;
+pub mod post_upgrade;
+
+#[derive(Deserialize, Serialize, CandidType, Debug, Clone)]
+pub enum BlockType {
+    Default,
+    ICRC1,
+    // TODO: add other block types
+}
+
+#[derive(CandidType, Serialize, Deserialize, Debug, Clone)]
+pub enum Args {
+    Init(InitArgs),
+    Upgrade(UpgradeArgs),
+}

src/icrc3_canisters/canisters/icrc3_archive/api/src/lifecycle/post_upgrade.rs

@@ -0,0 +1,12 @@
+use bity_ic_types::BuildVersion;
+use candid::CandidType;
+use serde::{Deserialize, Serialize};
+
+use crate::lifecycle::BlockType;
+
+#[derive(CandidType, Serialize, Deserialize, Debug, Clone)]
+pub struct UpgradeArgs {
+    pub version: BuildVersion,
+    pub commit_hash: String,
+    pub block_type: BlockType,
+}

src/icrc3_canisters/canisters/icrc3_archive/api/src/queries/get_version.rs

@@ -0,0 +1,4 @@
+use bity_ic_types::BuildVersion;
+
+pub type Args = ();
+pub type Response = BuildVersion;

src/icrc3_canisters/canisters/icrc3_archive/api/src/queries/icrc3_get_blocks.rs

@@ -0,0 +1,4 @@
+use icrc_ledger_types::icrc3::blocks::{GetBlocksRequest, GetBlocksResult};
+
+pub type Args = Vec<GetBlocksRequest>;
+pub type Response = GetBlocksResult;