Comment on page
⏩
Publish an audit
Once you're registered as an auditor on Trustblock, you will be able to publish your audits. Upon registration, you had to provide a wallet address which will be authorized to sign in and submit your audits.
All the publishing costs you nothing since we use gasless transactions.
There are two methods to publish your audits:
First, you'll have to connect your wallet.
You can find the "Connect your wallet" button on the bottom of the homepage or on your auditor's profile page
Once connected, head to your profile page which should be located under the following URL: https://beta.trustblock.run/auditor/REGISTERED_WALLET_ADDRESS
Once your connected, the following appears within your profile's page
At the bottom of your profile's page, you'll see a "Publish an audit" button redirecting you to the audit publication form once you click on it.
Publish audit form
There you will be able to complete the publishing audit form. Bear in mind that no one, including you and us, will be able to edit the content of the audit ever after it has been published.
If you have cargo installed, you can install our CLI via:
cargo install trustblock-cli
For other installation methods please refer to:
To see available subcommands, use the
help flag:trustblock help
For more information and help with specific subcommands, use the
--help flag:trustblock <subcommand> --help
- 1.Run the following command to initialize the Trustblock CLI, which will create a
~/.trustblock/.envfile:
trustblock init
- 2.Authenticate on https://beta.trustblock.run. Connect to the platform as you would normally do, and then head to your profile by clicking on "Go to my profile". Then, click on "Edit my information" to see your
API KEYbelow; copy theAPI KEYvalue and add it to the~/.trustblock/.envfile.
To publish an audit, run the following commands:
PDF Report:
trustblock publish-audit -a audit.json -r ./Audit_Report.pdf
Web audit report:
trustblock publish-audit -a audit.json -u https://trustblock.run/audit-report
-a, --audit-data <AUDIT DATA JSON FILE>: is the path to your audit.json file with the following schema:
{
"project": {
"name": String,
"links": {
"website": URL String,
"twitter": URL String,
"telegram": URL String
},
"contact": {
"email": Email String
}
},
"issues": {
"FIXED": {
"LOW": uint,
"MEDIUM": uint,
"HIGH": uint,
"CRITICAL": uint
},
"RISK_ACCEPTED": {
"LOW": uint,
"MEDIUM": uint,
"HIGH": uint,
"CRITICAL": uint
}
},
"tags": [ "TOKEN" | "FINANCE" | "COLLECTIBLES" | "GAMING" | "GOVERNANCE" | "SOCIAL" | "OTHER"],
"contracts": [
{
"evmAddress": Evm Address String,
"chain": "ETHEREUM" | "POLYGON" | "AVALANCHE" | "BNBCHAIN"
}
],
"description": {
"summary": Markdown String
},
"name": String
}
You can check out an example
audit.json file from https://github.com/Trustblock-Inc/trustblock-cli/blob/main/src/data/audit.json. You should fill in the fields with the appropriate information from your audit.Trustblock CLI supports both PDF and Web audit reports. Hence, you can either enter a path to the pdf file or the URL pointing to your web report
-r, --report-pdf <AUDIT REPORT PDF FILE>: is the path to your report file,-u, --report-url <AUDIT REPORT URL>: is the URL pointing to your web report,
Trustblock CLI can still be used without adding data to the
.env file if the required information is passed as arguments.
To include API key and private key:-a, --api-key
publish-audit: Publishes an audit to Trustblock.init: Initialize the.trustblockfolder.clean: Cleans the.trustblockfolder.help: Print this message or the help of the given subcommand(s).
That's it!
Your audit is published and publicly accessible through our platform.
We refresh metrics on Trustblock every day at a fixed time, and as such, your profile should be updated pretty soon after publishing your audits with the newest metrics.
The audit you publish will now be available from labels and API. Check the links below for more information.
Last modified 4mo ago