Add readme

.github/workflows/contract.yml

@@ -95,7 +95,7 @@ jobs:
         curl -L https://get.gear.rs/gear-v1.5.0-x86_64-unknown-linux-gnu.tar.xz -o - | tar xJ -C extended-vft/target/tmp
 
     - name: Run tests
-      run: cargo test --manifest-path extended-vft/Cargo.toml
+      run: cargo test -r --manifest-path extended-vft/Cargo.toml -- --ignored
 
   extend-vnft:
     needs: [vnft-service]
@@ -131,6 +131,6 @@ jobs:
         curl -L https://get.gear.rs/gear-v1.5.0-x86_64-unknown-linux-gnu.tar.xz -o - | tar xJ -C extended-vnft/target/tmp
 
     - name: Run tests
-      run: cargo test --manifest-path extended-vnft/Cargo.toml
+      run: cargo test -r --manifest-path extended-vnft/Cargo.toml -- --ignored
 
 

extended-vft/README.md

@@ -0,0 +1,23 @@
+# VFT (Vara Fungible Token)
+
+The VFT program constitutes a fungible token contract that incorporates a complicated role management mechanism. It enables the creation of fungible tokens with configurable parameters, such as the token name, symbol, and decimal precision. The contract implements essential token functionalities, including minting, burning, transferring tokens, and managing allowances, while enforcing stringent role-based access controls to safeguard the system and ensure the proper delegation of authority over these operations.
+
+### 🏗️ Building
+
+```sh
+cargo b -r 
+```
+
+### ✅ Testing
+
+Run all tests, except `gclient` ones:
+```sh
+cargo t -r 
+```
+
+Run all tests:
+```sh
+# Download the node binary.
+cargo t -r -- --ignored
+```
+

extended-vft/app/tests/node_test.rs

@@ -4,6 +4,7 @@ mod utils_gclient;
 use utils_gclient::*;
 
 #[tokio::test]
+#[ignore]
 async fn test_basic_function() -> Result<()> {
     let api = GearApi::dev_from_path("../target/tmp/gear").await?;
     let john_api = get_new_client(&api, USERS_STR[0]).await;
@@ -58,6 +59,7 @@ async fn test_basic_function() -> Result<()> {
 }
 
 #[tokio::test]
+#[ignore]
 async fn test_grant_role() -> Result<()> {
     let api = GearApi::dev_from_path("../target/tmp/gear").await?;
     let john_api = get_new_client(&api, USERS_STR[0]).await;

extended-vft/wasm/.binpath

@@ -1 +1 @@
-../target/wasm32-unknown-unknown/debug/extended_vft_wasm
+../target/wasm32-unknown-unknown/release/extended_vft_wasm

extended-vnft/README.md

@@ -0,0 +1,23 @@
+# VNFT (Vara Non-Fungible Token)
+
+The VNFT program represents a non-fungible token (NFT) contract that integrates a comprehensive role management system. It facilitates the creation of NFTs with customizable metadata attributes, including name, description, media, and reference links. The contract supports core NFT operations such as minting, burning, and transferring tokens, while managing token ownership and approvals. Additionally, the contract enforces role-based access control, ensuring that permissions for minting and burning are properly delegated to authorized actors, thereby maintaining the security and integrity of the system.
+
+### 🏗️ Building
+
+```sh
+cargo b -r 
+```
+
+### ✅ Testing
+
+Run all tests, except `gclient` ones:
+```sh
+cargo t -r 
+```
+
+Run all tests:
+```sh
+# Download the node binary.
+cargo t -r -- --ignored
+```
+

extended-vnft/app/tests/node_test.rs

@@ -5,6 +5,7 @@ use extended_vnft_wasm::TokenMetadata;
 use utils_gclient::*;
 
 #[tokio::test]
+#[ignore]
 async fn test_basic_function() -> Result<()> {
     let api = GearApi::dev_from_path("../target/tmp/gear").await?;
     let john_api = get_new_client(&api, USERS_STR[0]).await;

extended-vnft/wasm/.binpath

@@ -1 +1 @@
-../target/wasm32-unknown-unknown/debug/extended_vnft_wasm
+../target/wasm32-unknown-unknown/release/extended_vnft_wasm