fix: apply consistent naming for canister, directory and project (#26)

Co-authored-by: Stephen Antoni <[email protected]> Co-authored-by: Agustinus Theodorus <[email protected]>
garudaidr · Aug 8, 2024 · 8a01ebe · 8a01ebe
1 parent a2151ce
commit 8a01ebe
Show file tree

Hide file tree

Showing 20 changed files with 23 additions and 26 deletions.
diff --git a/.github/workflows/build-and-test.yml b/.github/workflows/build-and-test.yml
@@ -33,7 +33,7 @@ jobs:
         run: cargo clippy -- -D warnings
 
       - name: Build with cargo
-        run: cargo build --release --target wasm32-unknown-unknown --package icp_prototype_backend
+        run: cargo build --release --target wasm32-unknown-unknown --package icp_subaccount_indexer
 
       - name: Run tests with cargo
         run: cargo test --features "happy_path" && cargo test --features "sad_path"
diff --git a/.maintain/README.md b/.maintain/README.md
@@ -57,7 +57,7 @@ Create or modify `canister_ids.json` in the project root:
 
 ```json
 {
-  "icp_prototype_backend": {
+  "icp_subaccount_indexer": {
     "ic": "upy4y-myaaa-aaaaal-qjbxa-cai"
   }
 }
@@ -97,7 +97,7 @@ Use the `deploy.sh` script for deployment:
 Alternatively, you can use the dfx command directly:
 
 ```bash
-dfx deploy icp_prototype_backend --network ic --no-wallet --argument "(variant { Mainnet }, 15 : nat64, 10 : nat32, \"ryjl3-tyaaa-aaaaa-aaaba-cai\", \"$CUSTODIAN_PRINCIPAL\")"
+dfx deploy icp_subaccount_indexer --network ic --no-wallet --argument "(variant { Mainnet }, 15 : nat64, 10 : nat32, \"ryjl3-tyaaa-aaaaa-aaaba-cai\", \"$CUSTODIAN_PRINCIPAL\")"
 ```
 
 Note: If you encounter issues with the `wasm32-unknown-unknown` target, install it:

diff --git a/.maintain/deploy.sh b/.maintain/deploy.sh
@@ -105,9 +105,9 @@ print_colored "$GREEN" "Custodian Principal: $CUSTODIAN_PRINCIPAL"
 # Deploy the backend canister
 print_colored "$YELLOW" "Deploying backend canister..."
 if [ "$NETWORK" = "ic" ]; then
-    dfx deploy icp_prototype_backend --network ic --no-wallet --argument "(variant { Mainnet }, 15 : nat64, 10 : nat32, \"ryjl3-tyaaa-aaaaa-aaaba-cai\", \"$CUSTODIAN_PRINCIPAL\")"
+    dfx deploy icp_subaccount_indexer --network ic --no-wallet --argument "(variant { Mainnet }, 15 : nat64, 10 : nat32, \"ryjl3-tyaaa-aaaaa-aaaba-cai\", \"$CUSTODIAN_PRINCIPAL\")"
 else
-    dfx deploy icp_prototype_backend --network "$NETWORK" --argument "(variant { Local }, 15 : nat64, 10 : nat32, \"ryjl3-tyaaa-aaaaa-aaaba-cai\", \"$CUSTODIAN_PRINCIPAL\")"
+    dfx deploy icp_subaccount_indexer --network "$NETWORK" --argument "(variant { Local }, 15 : nat64, 10 : nat32, \"ryjl3-tyaaa-aaaaa-aaaba-cai\", \"$CUSTODIAN_PRINCIPAL\")"
 fi
 check_command "Deploy backend canister"
 

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,5 +1,5 @@
 [workspace]
 members = [
-    "src/icp_prototype_backend"
+    "src/icp_subaccount_indexer"
 ]
 resolver = "2"
diff --git a/README.md b/README.md
@@ -67,7 +67,7 @@ ICSI is built with a focus on modularity and extensibility. The core components
 ## Canister Methods
 
 The canister provides several methods to assist with ICP-token deposit management. The complete methods can be observed inside
-[Candid File](./src/icp_prototype_backend/icp_prototype_backend.did)
+[Candid File](./src/icp_subaccount_indexer/icp_subaccount_indexer.did)
 
 ```
 add_subaccount : () -> (variant { Ok : text; Err : Error });

diff --git a/canister_ids.json b/canister_ids.json
@@ -1,8 +1,5 @@
 {
-  "icp_prototype_backend": {
+  "icp_subaccount_indexer": {
     "ic": "uiz2m-baaaa-aaaal-qjbxq-cai"
-  },
-  "www": {
-    "ic": "upy4y-myaaa-aaaal-qjbxa-cai"
   }
 }
diff --git a/dfx.json b/dfx.json
@@ -10,9 +10,9 @@
         }
       }
     },
-    "icp_prototype_backend": {
-      "candid": "src/icp_prototype_backend/icp_prototype_backend.did",
-      "package": "icp_prototype_backend",
+    "icp_subaccount_indexer": {
+      "candid": "src/icp_subaccount_indexer/icp_subaccount_indexer.did",
+      "package": "icp_subaccount_indexer",
       "type": "rust"
     }
   },
@@ -31,14 +31,14 @@
   "environments": {
     "local": {
       "canisters": {
-        "icp_prototype_backend": {
+        "icp_subaccount_indexer": {
           "dependencies": ["icp_ledger_canister"]
         }
       }
     },
     "ic": {
       "canisters": {
-        "icp_prototype_backend": {}
+        "icp_subaccount_indexer": {}
       }
     }
   },

diff --git a/docs/canister-deployment-guideline.md b/docs/canister-deployment-guideline.md
@@ -85,7 +85,7 @@ Within your project’s root directory, add or adjust the following file `canist
 
 ```json
 {
-  "icp_prototype_backend": {
+  "icp_subaccount_indexer": {
     "ic": "upy4y-myaaa-aaaal-qjbxa-cai"
   }
 }
@@ -112,7 +112,7 @@ dfx cycles convert 0.3 --network ic
 Ensure the currently active identity is the correct `custodian` identity linked as the controller on NNS from previous steps. Don’t forget to export the value for `CUSTODIAN_PRINCIPAL` using the sub-step from step 5.
 
 ```bash
-dfx deploy icp_prototype_backend --network ic --no-wallet --argument "(variant { Mainnet }, 15 : nat64, 10 : nat32, \"ryjl3-tyaaa-aaaaa-aaaba-cai\", \"$(echo $CUSTODIAN_PRINCIPAL)\")"
+dfx deploy icp_subaccount_indexer --network ic --no-wallet --argument "(variant { Mainnet }, 15 : nat64, 10 : nat32, \"ryjl3-tyaaa-aaaaa-aaaba-cai\", \"$(echo $CUSTODIAN_PRINCIPAL)\")"
 ```
 
 Some roadblocks you may encounter:

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "icp_prototype",
+  "name": "icp_subaccount_indexer",
   "type": "module",
   "scripts": {
     "build": "webpack",
@@ -8,10 +8,10 @@
     "start:local:env": "dfx start --clean --host 127.0.0.1:8000 --use-old-metering",
     "deploy:local": ".maintain/deploy.sh",
     "deploy:ic": "dfx deploy --network=ic",
-    "generate": "npm run generate:did && dfx generate icp_prototype_backend",
+    "generate": "npm run generate:did && dfx generate icp_subaccount_indexer",
     "generate:did": "npm run generate:did:backend && npm run generate:did:ts",
-    "generate:did:ts": "didc bind src/icp_prototype_backend/icp_prototype_backend.did -t ts > src/icp_prototype_backend/icp_prototype_backend.did.ts",
-    "generate:did:backend": "cargo build --release --target wasm32-unknown-unknown --package icp_prototype_backend && candid-extractor target/wasm32-unknown-unknown/release/icp_prototype_backend.wasm > src/icp_prototype_backend/icp_prototype_backend.did",
+    "generate:did:ts": "didc bind src/icp_subaccount_indexer/icp_subaccount_indexer.did -t ts > src/icp_subaccount_indexer/icp_subaccount_indexer.did.ts",
+    "generate:did:backend": "cargo build --release --target wasm32-unknown-unknown --package icp_subaccount_indexer && candid-extractor target/wasm32-unknown-unknown/release/icp_subaccount_indexer.wasm > src/icp_subaccount_indexer/icp_subaccount_indexer.did",
     "format": "cargo fmt && prettier --write .",
     "test:happy_path": "cargo test --features 'happy_path'",
     "test:sad_path": "cargo test --features 'sad_path'",

diff --git a/src/icp_prototype_backend/Cargo.toml → src/icp_subaccount_indexer/Cargo.toml b/src/icp_prototype_backend/Cargo.toml → src/icp_subaccount_indexer/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "icp_prototype_backend"
+name = "icp_subaccount_indexer"
 version = "0.1.0"
 edition = "2021"
 

diff --git a/...type_backend/icp_prototype_backend.did.ts → ...ount_indexer/icp_prototype_backend.did.ts b/...type_backend/icp_prototype_backend.did.ts → ...ount_indexer/icp_prototype_backend.did.ts
diff --git a/...ototype_backend/icp_prototype_backend.did → ...ccount_indexer/icp_subaccount_indexer.did b/...ototype_backend/icp_prototype_backend.did → ...ccount_indexer/icp_subaccount_indexer.did
diff --git a/src/icp_prototype_backend/src/hashof.rs → src/icp_subaccount_indexer/src/hashof.rs b/src/icp_prototype_backend/src/hashof.rs → src/icp_subaccount_indexer/src/hashof.rs
diff --git a/src/icp_prototype_backend/src/ledger.rs → src/icp_subaccount_indexer/src/ledger.rs b/src/icp_prototype_backend/src/ledger.rs → src/icp_subaccount_indexer/src/ledger.rs
diff --git a/src/icp_prototype_backend/src/lib.rs → src/icp_subaccount_indexer/src/lib.rs b/src/icp_prototype_backend/src/lib.rs → src/icp_subaccount_indexer/src/lib.rs
diff --git a/src/icp_prototype_backend/src/memory.rs → src/icp_subaccount_indexer/src/memory.rs b/src/icp_prototype_backend/src/memory.rs → src/icp_subaccount_indexer/src/memory.rs
diff --git a/src/icp_prototype_backend/src/tests.rs → src/icp_subaccount_indexer/src/tests.rs b/src/icp_prototype_backend/src/tests.rs → src/icp_subaccount_indexer/src/tests.rs
diff --git a/src/icp_prototype_backend/src/types.rs → src/icp_subaccount_indexer/src/types.rs b/src/icp_prototype_backend/src/types.rs → src/icp_subaccount_indexer/src/types.rs