Merge pull request #7 from hashed-io/feature/pallet/fund-admin/records

Feature/pallet/fund admin/records

Author: tlacloc

.github/workflows/opencommit.yml

@@ -0,0 +1,42 @@
+name: 'OpenCommit Action'
+
+on:
+  push:
+    # this list of branches is often enough,
+    # but you may still ignore other public branches
+    branches: 
+      - '!main'
+      - '!master'
+      - '!dev'
+      - '!develop'
+
+jobs:
+  opencommit:
+    name: OpenCommit
+    runs-on: ubuntu-latest
+    permissions: write-all
+    steps:
+      - name: Setup Node.js Environment
+        uses: actions/setup-node@v2
+        with:
+          node-version: '16'
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: di-sukharev/[email protected]
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+        env:
+          # set openAI api key in repo actions secrets,
+          # for openAI keys go to: https://platform.openai.com/account/api-keys
+          # for repo secret go to: <your_repo_url>/settings/secrets/actions
+          OCO_OPENAI_API_KEY: ${{ secrets.OCO_OPENAI_API_KEY }}
+
+          # customization
+          OCO_OPENAI_MAX_TOKENS: 500
+          OCO_OPENAI_BASE_PATH: ''
+          OCO_DESCRIPTION: true
+          OCO_EMOJI: true
+          OCO_MODEL: gpt-3.5-turbo
+          OCO_LANGUAGE: en

Cargo.lock

@@ -8,6 +8,8 @@ members = [
     'pallets/fruniques',
     'pallets/gated-marketplace',
     # 'parachain-runtime',
+    'pallets/fund-admin',
+    'pallets/fund-admin-records',
     'runtime',
 ]
 [profile.release]

Cargo.toml

@@ -0,0 +1,45 @@
+[package]
+name = "pallet-fund-admin-records"
+version = "4.0.0-dev"
+description = "Proxy Financial Pallet Records"
+authors = ["Hashed <https://github.com/hashed-io"]
+homepage = "https://hashed.io"
+edition = "2021"
+license = "Unlicense"
+publish = false
+repository = "https://github.com/hashed-io/hashed-substrate"
+
+[package.metadata.docs.rs]
+targets = ["x86_64-unknown-linux-gnu"]
+
+[dependencies]
+log = "0.4"
+codec = { package = "parity-scale-codec", version = "3.0.0", default-features = false, features = [
+	"derive",
+] }
+scale-info = { version = "2.0.1", default-features = false, features = [
+	"derive"
+] }
+frame-support = { default-features = false, git = "https://github.com/paritytech/substrate.git", branch = "polkadot-v0.9.38" }
+frame-system = { default-features = false, git = "https://github.com/paritytech/substrate.git", branch = "polkadot-v0.9.38" }
+frame-benchmarking = { default-features = false, git = "https://github.com/paritytech/substrate.git", branch = "polkadot-v0.9.38", optional = true }
+sp-runtime = { default-features = false, version = "7.0.0", git = "https://github.com/paritytech/substrate.git", branch = "polkadot-v0.9.38" }
+pallet-timestamp = { default-features = false, version = "4.0.0-dev", git = "https://github.com/paritytech/substrate.git", branch = "polkadot-v0.9.38" }
+
+[dev-dependencies]
+sp-core = { default-features = false, version = "7.0.0", git = "https://github.com/paritytech/substrate.git", branch = "polkadot-v0.9.38" }
+sp-io = { default-features = false, git = "https://github.com/paritytech/substrate.git", branch = "polkadot-v0.9.38" }
+
+[features]
+default = ["std"]
+std = [
+	"codec/std",
+	"scale-info/std",
+	"frame-support/std",
+	"frame-system/std",
+	"frame-benchmarking/std",
+	"pallet-timestamp/std"
+]
+
+runtime-benchmarks = ["frame-benchmarking/runtime-benchmarks"]
+try-runtime = ["frame-support/try-runtime"]

pallets/fund-admin-records/Cargo.toml

@@ -0,0 +1,57 @@
+# Fund Admin Records
+
+The Fund Admin Records pallet is a Substrate-based blockchain pallet for recording and controlling different project records. It is written using Rust.
+
+## Overview 
+
+The Fund Admin Pallet provides functionalities to store, retrieve, and manage project records. Each record contains a project id, hashed information of the data stored, table type indicating the table it belongs to, record type reflecting the type of operation performed, and creation date.
+
+The unique record id is generated using a record's project id and its creation timestamp, ensuring the uniqueness of each data entry. Records are internally stored in a double map structure using the tuple (ProjectId, TableType) as the first key and the generated record ID as the second key.
+
+## Terminology
+
+- **ProjectId:** A unique identifier for each project. It's a bounded vector with a maximum length of 50 bytes.
+- **CreationDate:** Unix timestamp representing the creation time of a record.
+- **TableType:** This enum determines the type of table that the record belongs to. It can be Drawdown, RecoveryDrawdown, Revenue, or RecoveryRevenue.
+- **RecordType:** This enum determines the type of operation performed for the record. It can be Creation, Submit, Approve, Reject, Recovery, or Cancel.
+- **Records:** The storage item containing all the records. They are organized in a double map structure, which uses (ProjectId, TableType) as the first key and record ID as a second.
+
+## Interface
+
+### Types
+- **HashedInfo**: The hashed information related to the data stored.
+- **RecordCollection<T>**: A collection of records with maximum entries defined by the MaxRecordsAtTime parameter. Each record is a tuple (ProjectId, HashedInfo, TableType, RecordType).
+- **RecordData**: Structure stored in the double map for each record containing project_id, hashed_info, table_type, record_type, and creation_date.
+
+### Helper functions
+- **do_add_record:** A function responsible for validating and inserting a new record into the storage, also ensures the uniqueness of the record id.
+- **get_timestamp_in_milliseconds:** A utility function to get the current timestamp in milliseconds.
+
+### Callable functions
+- **set_signer_account:** To set the Signer account for making transactions.
+- **add_record:** Function to add a record(s) into storage.
+- **kill_storage:** Utility destructor for wiping out all the storage. Only intended for use in testing scenarios.
+
+### Errors
+- **SignerAccountNotSet:** When signer account is not set for making transactions.
+- **SenderIsNotTheSignerAccount:** The sender of the transaction is not the same as the signer account.
+- **ProjectIdIsEmpty:** If project id is empty.
+- **HashedInfoIsEmpty:** If hashed information is empty.
+- **ProjectIdExceededMaxLength:** If project id has exceeded its maximum length of 50 bytes.
+- **HashedInfoExceededMaxLength:** If hashed information has exceeded its maximum length of 400 bytes.
+- **MaxRegistrationsAtATimeReached:** If the number of added records exceeds the limit specified in the Config trait.
+
+### Events
+- **RecordAdded:** An event indicating a candidate was added, which emits the project id, table type, record type, and the generated unique record id.
+
+## Usage
+
+### Rust Developers
+To leverage this pallet, developers can either add records using the `add_record` callable function or retrieve them using the Records getter by providing the keys.
+
+### Polkadot-js Users
+The stored records can be queried through Polkadot-js CLI by providing suitable keys.
+
+## Conclusion
+
+The Fund Admin Records pallet delivers an essential set of tools to aid tracking a project's crucial records on the Substrate-based blockchain efficiently and securely. Be aware the `kill_storage` function provides irreversible data deletion, and it should only be used in testing scenarios or with extreme caution. This pallet ensures that all interactions are safeguarded with necessary permissions, ensuring stored data's integrity.

pallets/fund-admin-records/README.md

@@ -0,0 +1,20 @@
+//! Benchmarking setup for pallet-template
+
+use super::*;
+
+#[allow(unused)]
+use crate::Pallet as Template;
+use frame_benchmarking::{benchmarks, whitelisted_caller};
+use frame_system::RawOrigin;
+
+benchmarks! {
+	do_something {
+		let s in 0 .. 100;
+		let caller: T::AccountId = whitelisted_caller();
+	}: _(RawOrigin::Signed(caller), s)
+	verify {
+		assert_eq!(Something::<T>::get(), Some(s));
+	}
+
+	impl_benchmark_test_suite!(Template, crate::mock::new_test_ext(), crate::mock::Test);
+}

pallets/fund-admin-records/src/benchmarking.rs

@@ -0,0 +1,64 @@
+use super::*;
+use frame_support::pallet_prelude::*;
+use frame_support::traits::Time;
+use frame_support::sp_io::hashing::blake2_256;
+
+use crate::types::*;
+
+impl<T: Config> Pallet<T> {
+  /*---- Offchain extrinsics ----*/
+  pub fn do_add_record(
+    records: RecordCollection<T>,
+  ) -> DispatchResult{
+    for record in records.iter().cloned() {
+      // Validations
+      ensure!(!record.0.is_empty(), Error::<T>::ProjectIdIsEmpty);
+      ensure!(!record.1.is_empty(), Error::<T>::HashedInfoIsEmpty);
+
+      let project_id_validated = ProjectId::try_from(record.0.clone())
+        .map_err(|_| Error::<T>::ProjectIdExceededMaxLength)?;
+
+      let hashed_info_validated = HashedInfo::try_from(record.1.clone())
+        .map_err(|_| Error::<T>::HashedInfoExceededMaxLength)?;
+
+      // Get timestamp
+      let creation_date: CreationDate = Self::get_timestamp_in_milliseconds().ok_or(Error::<T>::TimestampError)?;
+
+      let record_id: Id = (
+        record.0.clone(),
+        record.1.clone(),
+        record.2,
+        record.3,
+        creation_date.clone()
+      ).using_encoded(blake2_256);
+
+      // Ensure the generated id is unique
+      ensure!(!Records::<T>::contains_key((record.0.clone(), record.2), record_id), Error::<T>::IdAlreadyExists);
+      
+      let record_data = RecordData {
+        project_id: project_id_validated,
+        hashed_info: hashed_info_validated,
+        table_type: record.2,
+        record_type: record.3,
+        creation_date,
+      };
+  
+      // Insert the record into the storage
+      <Records<T>>::insert(
+        (record.0.clone(), record.2),
+        &record_id,
+        record_data
+      );
+  
+      Self::deposit_event(Event::RecordAdded(record.0, record.2, record.3, record_id));
+    }
+    Ok(())
+  }
+
+  fn get_timestamp_in_milliseconds() -> Option<u64> {
+    let timestamp: u64 = T::Timestamp::now().into();
+
+    Some(timestamp)
+  }
+
+}