Canis Major test commands #92

asmataamallah25 · 2024-12-06T13:25:31Z

This document provides a comprehensive guide for testing the Canis Major blockchain adaptor's functionality. It outlines a sequence of test commands and their expected responses for:

Entity Management

Creating a building entity using POST requests
Verifying entity types in the Context Broker
Retrieving transaction receipts

Transaction Verification

Checking blockchain transaction details
Viewing DLTtxReceipts in NGSI-LD format
Querying specific building receipts

flopezag · 2024-12-07T13:16:21Z

validator/Tests.md

@@ -0,0 +1,114 @@
+# Canis Major test
+
+Canis Major serves as a blockchain adaptor within the FIWARE ecosystem, providing secure data persistence across blockchain networks and the Context Broker. The workflow is straightforward: clients submit transactions containing payload data and wallet credentials, which undergo authentication through Wilma PEP Proxy and KeyRock Identity Management. Once validated, the data is stored in the Orion Context Broker and simultaneously processed into a Merkle-Tree structure for blockchain integration. The system then signs the transaction using the provided wallet credentials and submits it to an Oketh-compatible blockchain. Let's explore the practical implementation through a series of test commands.


Canis Major is a blockchain adapter within the FIWARE ecosystem, providing secure data persistence across blockchain networks and the Context Broker. The workflow is straightforward:

Clients submit transactions containing payload data and wallet credentials.

These data are authenticated through a PEP Proxy and KeyRock Identity Management.

Once validated, the data is stored in an ETSI Broker (e.g., Orion-LD Broker) and simultaneously processed into a Merkle tree structure for blockchain integration.

The system then signs the transaction using the provided wallet credentials and submits it to an Oketh-compatible blockchain.

Let's explore the practical implementation through a series of test commands. First, it is needed the execution of the integration tests executing the following commands:

cd it docker-compose -f docker-compose/docker-compose-env.yaml -f docker-compose/docker-compose-java.yaml up NGSI_ADDRESS=localhost:4000 mvn clean test

After running the integration tests, ...

flopezag · 2024-12-07T13:24:44Z

validator/Tests.md

+    }
+}'
+```
+


Before going to the next point, you need to describe the header keys and the corresponding values, precisely:

Wallet-Type: vault

Wallet-Token: vault-plaintext-root-token

Wallet-Address: http://vault:8200/v1/ethereum/accounts/mira

NGSILD-TENANT: orion

flopezag · 2024-12-07T13:25:23Z

validator/Tests.md

+}'
+```
+
+To retrieve the available entity types in the context broker run the following command:


Context Broker

flopezag · 2024-12-07T13:26:10Z

validator/Tests.md

+
+To retrieve the available entity types in the context broker run the following command:
+```bash
+curl -L 'http://<Canis Major>:1026/ngsi-ld/v1/types' \


Not sure if it is , should not be ?

flopezag · 2024-12-07T13:28:23Z

validator/Tests.md

+```
+The command returns the following response, demonstrating the available entity types in the Context Broker:
+```bash
+{


{ "@context": "https://raw.githubusercontent.com/smart-data-models/dataModel.DistributedLedgerTech/master/context.jsonld", "id": "urn:ngsi-ld:EntityTypeList:d77ccfa0-b3cd-11ef-ae1b-0242ac120005", "type": "EntityTypeList", "typeList": ["DLTtxReceipt"] }

flopezag · 2024-12-07T13:34:29Z

validator/Tests.md

+                    "blockHash":"0x86082426228ee23ea8927607c7f731194ebc1dc7ca69a6321ff46e91b0fdbe2a","blockNumber":190,"blockNumberRaw":"0xbe","cumulativeGasUsed":23866,"cumulativeGasUsedRaw":"0x5d3a","from":"0x34e5b3f990e55d0651b35c817bafb89d2877cb95","gasUsed":23866,"gasUsedRaw":"0x5d3a","logs":[
+                        {"address":"0x476059cd57800db8eb88f67c2aa38a6fcf8251e0","blockHash":"0x86082426228ee23ea8927607c7f731194ebc1dc7ca69a6321ff46e91b0fdbe2a","blockNumber":190,"blockNumberRaw":"0xbe","data":"0x","logIndex":0,"logIndexRaw":"0x0","removed":false,"topics":["0xa3865c00e01495fc2b86502cae36a4edb139f748682e7d80725a3d6571a482fa","0x9aeb7ab140e1449806e11e52ca85dacb6a028ae5feb8d431e7d927e7971e4d2d","0xb1a82faaa61a7bfbc90c42129b2049d408f20b8f43ae99e8b6aa6cc7e7b0b944"],"transactionHash":"0x18b8c942735e869a42fff06393ebb12824ec44ed030e9e6a579f8f839c59a5de","transactionIndex":0,"transactionIndexRaw":"0x0","type":"mined"}],"logsBloom":"0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000008000200000000000000000000010000000000004000000000000000000000000000110000000000000004000000000000000000000000000000000000000000000020000000001000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000020000000000000000000000000000000000000000000000000000000000000000000000000","status":"0x1","statusOK":true,"to":"0x476059cd57800db8eb88f67c2aa38a6fcf8251e0","transactionHash":"0x18b8c942735e869a42fff06393ebb12824ec44ed030e9e6a579f8f839c59a5de","transactionIndexRaw":"0x0"}]
+}%  
+```


add new line after the ```

flopezag · 2024-12-07T13:34:52Z

validator/Tests.md

+
+Each transaction contains detailed blockchain information including block hashes, gas usage, logs, and transaction hashes, but they all relate to the same building entity.
+
+To ask the context brker Orion-LD about the receipt of a specific building use the following command:


add new line after the colon

flopezag · 2024-12-07T13:41:41Z

validator/Tests.md

+
+To ask the context brker Orion-LD about the receipt of a specific building use the following command:
+```bash 
+curl -L 'http://<Canis Major>:1026/ngsi-ld/v1/entities/?type=DLTtxReceipt&q=refEntity%3D%3D%22urn%3Angsi-ld%3ABuilding%3Afarm002%22&attrs=TxReceipts' \


Are you sure that the IP should be and not ?

You should explain that you are using the query language of ETSI NGSI-LD API to request the data:

you request all the Entities whose type is DLTtxReceipt;

From them, only the entity or entities whose property refEntity value is equal to %22urn%3Angsi-ld%3ABuilding%3Afarm002%22 ("urn:ngsi-ld:Building:farm002"), and;

you want to receive only the property TxReceipts.

flopezag · 2024-12-07T13:41:56Z

validator/Tests.md

+-H 'NGSILD-Tenant: orion'
+```
+The outpot will be similar to the following response:
+```bash


Not bash -> json

flopezag · 2024-12-07T13:43:27Z

validator/Tests.md

+
+Both transactions were successful (statusOK: true). Each receipt contains detailed blockchain information including logs, bloom filters, and raw transaction data.
+
+


To say that the values are the same, you need to compare the output of the Context Broker with the output of the Canis Major.

This part is the function that the validator should provide. If both outputs are the same, we should get true.
This is what I am working on.

asmataamallah25 added 2 commits December 6, 2024 14:02

docs: Add Canis Major workflow test commands

5fc76ea

Updates Canis Major workflow test commands

481b382

asmataamallah25 requested review from flopezag and jason-fox December 6, 2024 13:25

flopezag requested changes Dec 7, 2024

View reviewed changes

asmataamallah25 and others added 8 commits December 9, 2024 15:36

Validation service: first iteration

4e5dfc3

Updated test commands documentation and changed code location

95b565b

Delete validator/Tests.md -

9cc270d

Update Tests.md

e0551ca

Delete validator/Tests.md

8942860

Upload the most recent version of Tests.md

fec88d0

Delete validator/Tests.md

ee5749e

Rename the file as README.md

4ba7cb3

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Canis Major test commands #92

Canis Major test commands #92

asmataamallah25 commented Dec 6, 2024

flopezag Dec 7, 2024

asmataamallah25 Dec 9, 2024

flopezag Dec 7, 2024

asmataamallah25 Dec 9, 2024

flopezag Dec 7, 2024

flopezag Dec 7, 2024

flopezag Dec 7, 2024

flopezag Dec 7, 2024

asmataamallah25 Dec 9, 2024

flopezag Dec 7, 2024

asmataamallah25 Dec 9, 2024

flopezag Dec 7, 2024

flopezag Dec 7, 2024

asmataamallah25 Dec 9, 2024

flopezag Dec 7, 2024

asmataamallah25 Dec 9, 2024

		@@ -0,0 +1,114 @@
		# Canis Major test

		Canis Major serves as a blockchain adaptor within the FIWARE ecosystem, providing secure data persistence across blockchain networks and the Context Broker. The workflow is straightforward: clients submit transactions containing payload data and wallet credentials, which undergo authentication through Wilma PEP Proxy and KeyRock Identity Management. Once validated, the data is stored in the Orion Context Broker and simultaneously processed into a Merkle-Tree structure for blockchain integration. The system then signs the transaction using the provided wallet credentials and submits it to an Oketh-compatible blockchain. Let's explore the practical implementation through a series of test commands.


		Each transaction contains detailed blockchain information including block hashes, gas usage, logs, and transaction hashes, but they all relate to the same building entity.

		To ask the context brker Orion-LD about the receipt of a specific building use the following command:


		Both transactions were successful (statusOK: true). Each receipt contains detailed blockchain information including logs, bloom filters, and raw transaction data.

Canis Major test commands #92

Are you sure you want to change the base?

Canis Major test commands #92

Conversation

asmataamallah25 commented Dec 6, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment