Merge pull request #30 from ORIGYN-SA/0.1.2

0.1.2

README.md

@@ -79,6 +79,10 @@ Node script that stages and mints NFTs with the input of a JSON metadata file.
 
 See also: https://github.com/ORIGYN-SA/minting-starter
 
+### Logs & Metrics
+
+[Logs and metrics documentation](./docs/logs_and_metrics.md)
+
 ### Audit
 
-[Audit Doc](./docs/sample_calls.md)
+[Audit document](./docs/audit.md)

canister_ids.json

@@ -0,0 +1,61 @@
+{
+  "__Candid_UI": {
+    "local": "qoctq-giaaa-aaaaa-aaaea-cai"
+  },
+  "all_ref": {
+    "local": "rrkah-fqaaa-aaaaa-aaaaq-cai"
+  },
+  "dfxledger": {
+    "local": "ryjl3-tyaaa-aaaaa-aaaba-cai",
+    "ic": "ryjl3-tyaaa-aaaaa-aaaba-cai"
+  },
+  "ledger": {
+    "local": "r7inp-6aaaa-aaaaa-aaabq-cai",
+    "ic": "ryjl3-tyaaa-aaaaa-aaaba-cai"
+  },
+  "origyn_nft_reference": {
+    "local": "rkp4c-7iaaa-aaaaa-aaaca-cai",
+    "ic": "twdpa-6qaaa-aaaaj-adeuq-cai"
+
+  },
+  "origyn_nft_reference_dev": {
+    "ic": "frfol-iqaaa-aaaaj-acogq-cai"
+  },
+
+  "egg": {
+    "ic": "zkpdr-hqaaa-aaaak-ac4lq-cai"
+  },
+  "dev_mintpass_ogy_reference": {
+    "ic": "s43ul-uiaaa-aaaaj-afksq-cai"
+  },
+  "prod_mintpass_ogy_reference": {
+    "ic": "s32s7-zqaaa-aaaaj-afksa-cai"
+  },
+  "prod_uefa_ogy_reference": {
+    "ic": "twdpa-6qaaa-aaaaj-adeuq-cai"
+  },
+  "prod_f50_ogy_reference": {
+    "ic": "orr5v-rqaaa-aaaaj-al2qq-cai"
+  },
+  "origyn_nft_reference_stage": {
+    "ic": "r5m5i-tiaaa-aaaaj-acgaq-cai"
+  },
+  "origyn_nft_reference_assets": {
+    "local": "rno2w-sqaaa-aaaaa-aaacq-cai"
+  },
+  "test_runner": {
+    "local": "renrk-eyaaa-aaaaa-aaada-cai"
+  },
+  "test_runner_nft": {
+    "local": "rdmx6-jaaaa-aaaaa-aaadq-cai"
+  },
+  "phone_book": {
+    "ic": "ngrpb-5qaaa-aaaaj-adz7a-cai"
+  },
+  "bmdev": {
+    "ic": "frfol-iqaaa-aaaaj-acogq-cai"
+  },
+  "dev_sales_canister": {
+    "ic": "4wwlz-ciaaa-aaaaj-ae2cq-cai"
+  }
+}

dapps-test.pem

@@ -0,0 +1,6 @@
+-----BEGIN EC PARAMETERS-----
+BgUrgQQACg==
+-----END EC PARAMETERS-----
+-----BEGIN EC PRIVATE KEY-----
+MHQCAQEEICX+u13fqttnLVTy9zd+zacIN0f9zQJDwcU7nI6LV8pEoAcGBSuBBAAKoUQDQgAEtMqqnsGW3e+xztp2pHdxTzABdPVYldQBUw+uU5THqkRbCTnzmO7m8anjtFmlNMYS+pqQh6IXZHHe7BLNs2sQWw==
+-----END EC PRIVATE KEY-----

dfx.json

@@ -5,10 +5,38 @@
             "main": "src/origyn_nft_reference/main.mo",
             "type": "motoko"
         },
+        "egg": {
+          "main": "src/origyn_nft_reference/main.mo",
+          "type": "motoko"
+      },
+      "bmdev": {
+        "main": "src/origyn_nft_reference/main.mo",
+        "type": "motoko"
+      },
         "origyn_sale_reference": {
             "main": "src/origyn_sale_reference/main.mo",
             "type": "motoko"
         },
+        "storage_canister_1": {
+            "main": "src/origyn_storage_reference/storage_canister.mo",
+            "type": "motoko"
+        },
+        "storage_canister_2": {
+            "main": "src/origyn_storage_reference/storage_canister.mo",
+            "type": "motoko"
+        },
+        "storage_canister_3": {
+            "main": "src/origyn_storage_reference/storage_canister.mo",
+            "type": "motoko"
+        },
+        "storage_canister_4": {
+            "main": "src/origyn_storage_reference/storage_canister.mo",
+            "type": "motoko"
+        },
+        "storage_canister_5": {
+            "main": "src/origyn_storage_reference/storage_canister.mo",
+            "type": "motoko"
+        },
         "test_runner": {
             "main": "src/tests/test_runner.mo",
             "type": "motoko",

docs/audit.md

@@ -160,4 +160,3 @@ We will be expanding logging and refactoring in the next version of the referenc
 22. The two functions handle_library and mint_nft_origyn (in src/origyn_nft_reference/mint.mo) swallow errors from Metadata.getNFTLibrary.
 
 This is intended functionality as we only want to handle the return from these items if the values are returned without error.
-

docs/logs_and_metrics.md

@@ -0,0 +1,43 @@
+# Logs & Metrics
+
+🚀 Status, quality logs, cycles and memory tracking in the Origyn NFT canister that allow users to gather important information about events happening in the backend.
+
+## User features
+
+- Get status in realtime
+- Track cycles and memory
+- Get logs and filter by time or specific event
+- UI dashboard
+
+## Getting started
+
+- Make sure you run the Brain Matter project first
+```bash
+yes yes | bash ./projects/bm/deploybm-local.sh
+```
+- Run `dfx canister id origyn_nft_reference` and copy the origyn_nft_reference canister id, keep it handy.
+- Clone the following repo that contains the [Logs & Metrics Dashboard](https://github.com/ORIGYN-SA/canistergeek-ui)
+- Open the Logs & Metrics dashboard project and run it
+```node
+# Install all dependencies
+npm install
+# Build
+npm run build
+# Start local server on port 3001
+npm run start
+# If you get webpack-cli error run the following then do the npm run start
+npm install --save-dev webpack-cli
+```
+- Open browser and paste the following url: `http://localhost:3001/`
+- Navigate to the settings tab
+- Click the example button to copy default settings
+- Under canisters replace the `canistedId` with the origyn_nft_reference id and change the name to Origyn NFT.
+- Delete the second entry object that contains a blackhole reference
+- Click the save button. It should take you to the metrics page
+- At this you should be able to see logs & metrics for the origyn_nft_refence
+- Click on the Origyn NFT subtab to see more info
+- Navigate to the Logs tab
+- You should see a number of logs under the Logs header
+- Navigate to the Realtime tab and enter the word `stage` into the text input then click the show button ( Notice that by entering the word stage the system will filter all the latest logs that contains that word. The filter is designed to search by function name or part of it like is in the case of 'stage' )
+- Click on any item and you should see more info related to that entry
+- Swap to the History tab and you can filter by time and/or by function name