Browse Source

docs(blockchain): improve audit style and titles

pull/1681/head
Michele Sessa 2 years ago committed by Michele
parent
commit
cc657aa7c3
  1. 22
      subjects/blockchain/financial-instruments/audit/README.md
  2. 2
      subjects/blockchain/nft-marketplace/audit/README.md
  3. 22
      subjects/blockchain/node-dashboard/audit/README.md
  4. 14
      subjects/blockchain/non-fungible-cats/audit/README.md
  5. 2
      subjects/blockchain/payment-channel/audit/README.md
  6. 2
      subjects/blockchain/sign-service/audit/README.md
  7. 2
      subjects/blockchain/tracking-network/audit/README.md

22
subjects/blockchain/financial-instruments/audit/README.md

@ -1,35 +1,55 @@
## Financial Instruments Audit #### Financial Instruments Audit
##### Read the documentation ##### Read the documentation
###### Does the README file contain or redirect to the instructions to launch the project? ###### Does the README file contain or redirect to the instructions to launch the project?
###### Are the instructions to install and deploy the project usable to you? ###### Are the instructions to install and deploy the project usable to you?
###### Does the documentation contain a description of the architecture of the project? ###### Does the documentation contain a description of the architecture of the project?
###### Does the documentation contain details on the API and smart contract functions? ###### Does the documentation contain details on the API and smart contract functions?
##### Launch the project ##### Launch the project
###### Is a blockchain network running? ###### Is a blockchain network running?
###### Can you display the web interface? ###### Can you display the web interface?
###### Does the homepage allow you to connect a wallet? ###### Does the homepage allow you to connect a wallet?
##### Connect a wallet ##### Connect a wallet
###### Were you asked to provide a name and upload a passport picture? ###### Were you asked to provide a name and upload a passport picture?
###### Does your wallet appear to be connected? ###### Does your wallet appear to be connected?
##### Use the provided script to populate the platform ##### Use the provided script to populate the platform
###### Was the documentation clear enough to launch the populating script? ###### Was the documentation clear enough to launch the populating script?
###### Does the website show the various digital assets? ###### Does the website show the various digital assets?
###### Did the two accounts receive the corresponding asset looking at the portfolio page once connected? ###### Did the two accounts receive the corresponding asset looking at the portfolio page once connected?
##### As the first user, Aya, opens the CLV page and offers to sell 10 CLV at 9 TRG ##### As the first user, Aya, opens the CLV page and offers to sell 10 CLV at 9 TRG
###### Does the interface reflect the amount of CLV available to Aya? ###### Does the interface reflect the amount of CLV available to Aya?
###### Does the order validation trigger a transfer of funds? ###### Does the order validation trigger a transfer of funds?
##### As the second user, Beatriz, open the CLV page and buys 10 CLV at market price ##### As the second user, Beatriz, open the CLV page and buys 10 CLV at market price
###### Does the platform correctly offer to buy at 9 TRG? ###### Does the platform correctly offer to buy at 9 TRG?
###### Does the trade seem to execute? ###### Does the trade seem to execute?
###### Does Beatriz have 60 TRG and 10 CLV now? ###### Does Beatriz have 60 TRG and 10 CLV now?
###### Does Beatriz portfolio display a withdrawal button for CLV? ###### Does Beatriz portfolio display a withdrawal button for CLV?
##### From the portfolio page, click on withdraw for CLV ##### From the portfolio page, click on withdraw for CLV
###### Does the transaction execute? ###### Does the transaction execute?
###### Does Beatriz now have full possession of its assets (in the second column)? ###### Does Beatriz now have full possession of its assets (in the second column)?

2
subjects/blockchain/nft-marketplace/audit/README.md

@ -1,4 +1,4 @@
## NFT Marketplace #### NFT Marketplace
##### Read the documentation ##### Read the documentation

22
subjects/blockchain/node-dashboard/audit/README.md

@ -1,37 +1,57 @@
## Node Dashboard audit #### Node Dashboard audit
##### Read the documentation ##### Read the documentation
###### Does the README file contains the instructions to launch the project? ###### Does the README file contains the instructions to launch the project?
###### Are two different clients launched? ###### Are two different clients launched?
###### Is clique the consensus algorithm? ###### Is clique the consensus algorithm?
##### Launch the network with the `launch-network` and display its status with `infos` ##### Launch the network with the `launch-network` and display its status with `infos`
###### Does the command launch the five nodes? ###### Does the command launch the five nodes?
###### Does the interface display the latest block of each node? ###### Does the interface display the latest block of each node?
###### Does the interface display their Ethereum address and balance? ###### Does the interface display their Ethereum address and balance?
###### Does the interface display the CPU and memory consumption of each node? ###### Does the interface display the CPU and memory consumption of each node?
##### Launch scenario 0 ##### Launch scenario 0
###### Does Alice, Bob and Cassandra have a positive balance of ETH? ###### Does Alice, Bob and Cassandra have a positive balance of ETH?
##### Launch scenario 1 ##### Launch scenario 1
###### Does the command provide feedback? ###### Does the command provide feedback?
###### Does the `infos` command show the updated ETH balance? ###### Does the `infos` command show the updated ETH balance?
###### Does the `infos` command displays transactions in the mempool? ###### Does the `infos` command displays transactions in the mempool?
##### Launch scenario 2 ##### Launch scenario 2
###### Does the command provide feedback? ###### Does the command provide feedback?
###### Do Driss and Elena appear to have received 1000 BY tokens? ###### Do Driss and Elena appear to have received 1000 BY tokens?
##### Launch scenario 3 ##### Launch scenario 3
###### Does the command provide feedback? ###### Does the command provide feedback?
###### Does the `infos` command show the updated balance of Elena receiving one ETH? ###### Does the `infos` command show the updated balance of Elena receiving one ETH?
##### Run `temporary-failure Alice` and launch `infos` ##### Run `temporary-failure Alice` and launch `infos`
###### Is the node disabled in the `infos` output? ###### Is the node disabled in the `infos` output?
###### Does it come back online after 40 seconds? ###### Does it come back online after 40 seconds?
###### Does it appear to be up to date a couple of minutes later? ###### Does it appear to be up to date a couple of minutes later?
#### Bonus #### Bonus
###### +Does the `-u` option allow you to launch each command with a regular update? ###### +Does the `-u` option allow you to launch each command with a regular update?
###### +Does the tool offer the possibility of launching a node connected to one of the testnet networks? ###### +Does the tool offer the possibility of launching a node connected to one of the testnet networks?

14
subjects/blockchain/non-fungible-cats/audit/README.md

@ -2,23 +2,23 @@
##### Try to compile the two contracts ##### Try to compile the two contracts
###### The contracts compile properly ###### Does the contracts compile properly?
##### Deploy NappingCats with 10 as its initial price ##### Deploy NappingCats with 10 as its initial price
###### The contract deploys properly ###### Does the contract deploys properly?
###### TokenURI(0) returns the location of a json file ###### Does TokenURI(0) returns the location of a json file?
###### The json files contains the name and the image of the cat ###### Does the json files contains the name and the image of the cat?
##### buy cat 1 at the listed price (10wei) ##### buy cat 1 at the listed price (10wei)
###### The buy function works properly ###### Does the buy function works properly?
##### transfer cat 1 to a secondary user ##### transfer cat 1 to a secondary user
###### The transfer function works properly ###### Does the transfer function works properly?
##### buy cat 2 at the listed price (10wei) ##### buy cat 2 at the listed price (10wei)
@ -56,7 +56,7 @@
###### Did the student explicit the price of each token? ###### Did the student explicit the price of each token?
###### Are prices accurate (listed price or moving current price.) ###### Are prices accurate (listed price or moving current price)?
--- ---

2
subjects/blockchain/payment-channel/audit/README.md

@ -1,4 +1,4 @@
## Payment Channel #### Payment Channel
##### Read the documentation ##### Read the documentation

2
subjects/blockchain/sign-service/audit/README.md

@ -1,4 +1,4 @@
## Sign Service #### Sign Service
#### Preliminary #### Preliminary

2
subjects/blockchain/tracking-network/audit/README.md

@ -1,4 +1,4 @@
## Tracking Network #### Tracking Network
###### Is there a documentation provided to launch the network? ###### Is there a documentation provided to launch the network?

Loading…
Cancel
Save