Improve README, add deploy_script

Author: DannyVRSE

README.md

@@ -3,34 +3,33 @@
 ## 🚀 Features
 
 - **Contract Creation**  
-  Create and manage legally binding contracts with vendors.
+  Create and manage legally binding vendor agreements.
 
 - **Participant Invitation**
-  Invite all stakeholders to collaborate on the contract.
+  Invite all stakeholders to collaborate on the contract (Buyer, Supplier, Third-Party)
 
 - **E-signing of Contracts**
   Sign contracts electronically, eliminating the need for physical paperwork.
 
 - **Delivery Note Generation**
   Automatically generate delivery notes as proof of delivery.
 
-- **Invoice Generation**
-  Create invoices directly from contract or delivery data.
+- **Invoices**
+  Create invoices and pay invoices directly from contract or delivery data.
 
 - **Locking of Assets in Escrow**
-  Secure payment and asset exchange through escrow integration.
+  Secure payments through escrow integration.
 
 - **Flexible Payment Terms**
   Supports various payment configurations:
   1. On Delivery  
-  2. Standard payment periods: 7, 14, 30 Day, Net 60/90 
-  3. Custom payment periods
+  2. Custom payment periods
 
 - **Discounts and Penalties**
   Configure dynamic pricing based on early payment or late delivery.
 
 - **Automatic Asset Transfer**
-  Transfer funds automatically on contract fulfillment.
+  Transfer funds automatically on contract fulfillment. (On Delivery payment term)
 
 - **Dispute Resolution**
   Built-in mechanisms to manage and resolve disputes efficiently.
@@ -39,42 +38,19 @@
   Connection to crypto wallet
 
 
-
-## Running the project locally
-
-If you want to test your project locally, you can use the following commands:
-
-```bash
-# Starts the replica, running in the background
-dfx start --background
-
-# Deploys your canisters to the replica and generates your candid interface
-dfx deploy
-```
-
-Once the job completes, your application will be available at `http://localhost:4943?canisterId={asset_canister_id}`.
-
-If you have made changes to your backend canister, you can generate a new candid interface with
-
-```bash
-npm run generate
-```
-
-at any time. This is recommended before starting the frontend development server, and will be run automatically any time you run `dfx deploy`.
-
-If you are making frontend changes, you can start a development server with
-
+## 🚀 Running locally
+1. **Clone the repository**
 ```bash
-npm start
+git clone <repo-url>
+cd <repo-url>
 ```
+2. **Deploy**
+Run local_deploy.sh script. This will create identities and deploy all canisters.
 
-Which will start a server at `http://localhost:8080`, proxying API requests to the replica at port 4943.
+In the CLM_backend candid interface:
 
-### Note on frontend environment variables
+1. Fund escrow canister. Transfer dummy tokens to escrow canister using ```transfer``` function. These will be used to cover transfer fees for operations.
 
-If you are hosting frontend code somewhere without using DFX, you may need to make one of the following adjustments to ensure your project does not fetch the root key in production:
+2. Once users are created in the frontend, use the ```transferToUsers``` function to allocate dummy tokens to user accounts.
 
-- set`DFX_NETWORK` to `ic` if you are using Webpack
-- use your own preferred method to replace `process.env.DFX_NETWORK` in the autogenerated declarations
-  - Setting `canisters -> {asset_canister_id} -> declarations -> env_override to a string` in `dfx.json` will replace `process.env.DFX_NETWORK` with the string in the autogenerated declarations
-- Write your own `createActor` constructor
+This enables users to participate in transactions.

local_deploy.sh

@@ -0,0 +1,46 @@
+# Set principal variables
+DEFAULT=$(dfx identity get-principal --identity default)
+MINTER=$(dfx identity get-principal --identity minter)
+CONTROLLER=$(dfx identity get-principal --identity archive_controller)
+
+dfx stop
+dfx start --clean --background
+# Set principal variables
+DEFAULT=$(dfx identity get-principal --identity default)
+MINTER=$(dfx identity get-principal --identity minter)
+CONTROLLER=$(dfx identity get-principal --identity archive_controller)
+
+dfx deploy CLM_backend
+BACKEND=$(dfx canister id CLM_backend)
+
+# Deploy the ICRC-1 ledger canister
+dfx deploy icrc1_ledger_canister --argument "(variant { Init = record {
+    token_symbol = \"KEST\";
+    token_name = \"Tether KE\";
+    minting_account = record { owner = principal \"$MINTER\" };
+    transfer_fee = 10_000;
+    metadata = vec {};
+    feature_flags = opt record { icrc2 = true };
+    initial_balances = vec {
+        record { record { owner = principal \"$DEFAULT\"; }; 10_000_000_000; };
+        record { record { owner = principal \"$BACKEND\"; }; 50_000_000_000; };
+    };
+    archive_options = record {
+        num_blocks_to_archive = 1000;
+        trigger_threshold = 2000;
+        controller_id = principal \"$CONTROLLER\";
+        cycles_for_archive_creation = opt 10000000000000;
+    };
+}})"
+
+# Get the deployed ledger canister ID
+LEDGER=$(dfx canister id icrc1_ledger_canister)
+
+# Deploy the index canister, referencing the ledger canister principal
+#index canister is used to query ledger transactions
+dfx deploy icrc1_index_canister --argument "(opt variant { Init = record { ledger_id = principal \"$LEDGER\"; retrieve_blocks_from_ledger_interval_seconds = opt 10; } })"
+
+# Deploy other canisters
+dfx deploy escrow
+dfx deploy internet_identity
+dfx deploy CLM_frontend

src/CLM_backend/main.mo

@@ -24,7 +24,7 @@ actor class CLM() = {
     { hash = Principal.hash p; key = p };
   };
 
-  //🚩 For testing purposes only
+  //🚩Functions or testing purposes only
   //transfer tokens to all users
   public shared ({ caller }) func transferToUsers(amount : Nat) : async Result.Result<Text, Text> {
     let usersArray = Trie.toArray<Principal, T.User, Principal>(
@@ -99,6 +99,7 @@ actor class CLM() = {
       };
     };
   };
+  //end of testing functions
 
   // Adjacency list for user-user connections: principal -> list of connected principals
   stable var connections : Trie.Trie<Principal, Trie.Trie<Principal, T.ConnectionStatus>> = Trie.empty();