Skip to main content
Every project on Trustblock has a public security record: the audit reports published for it, their findings with the status each report states, and any incident on record. You can show that record where your users read about you: your site, your docs, your audits page.
Check your record first. Open your project’s page on app.trustblock.run and compare it with the reports you publish yourself. If something is wrong or missing, write to contact@trustblock.run with a link to the report. A missing audit is published by the security firm that conducted it.

Three ways

The label

What it states

The label reads the same record as your project page and changes when the record changes. It states what the audit reports on Trustblock say. It never rates the project: no score, no tick, no grade. An open critical finding or an incident is always the first line, whatever facts you choose: the label never shows “Last audit” while the record holds one. The Card layout adds your facts under the open critical line. The label links to your project’s page on Trustblock, where every report and finding can be read.

The code

Add the script once, then a div where the label goes. Your slug is the last part of your project page’s address: app.trustblock.run/project/aave has the slug aave.
With no option, the label shows your record’s three strongest facts (Automatic). The same code, with your slug and options already filled in, is on your project’s page under “Show this on your site”, and in the Playground, tab “Project label”. Both show the label as it will draw while you choose.

Options

Each option is one attribute on the div, and the same option is a URL parameter of the label image. Leave an option out to keep its default. A value the label does not know is ignored, and the default is used. The names in the first column are the editor’s. Three more attributes work on the live label only:

Facts

A fact your record does not hold is not drawn: with no finding on record, there is no Findings fixed line. When you name more facts than the layout has room for, it draws them in this order and leaves the rest out: firm, site, audits, reports, fixed, since, firms, chains. The editor names the facts left out. Example: a dark card that states the last audit, the reports and firms, the findings fixed as a percentage and the first audit year.
To find the project by its domain or by a contract address instead of its slug, see the labels widget page.

The label as an image

Some places do not run scripts from other sites: GitHub READMEs and several docs hosts. Some teams also keep every outside script off the pages where users connect a wallet. There, use the label as an image:
It takes the options above as URL parameters, such as label.svg?layout=card&theme=dark&show=reports,fixed&fixed=percent. It states the same record as the live label, open critical findings and incidents included, and refreshes within the hour. An image has no link of its own, so wrap it in one:
In the editor, “Embed as: Image” gives this code with your options.

If you remove it

Nothing happens. Your record does not change, and Trustblock does not publish that a label was removed.

The API

For a security or audits page you design yourself. One route returns your record: GET https://api.trustblock.run/v1/project/security, by slug, by domain, or by chain and address. It returns the project’s audits, the findings with their status, and any recorded incidents.
The key comes with a developer account: create one in three steps (the account type, a code sent by email, your company’s details). Each account has 1,000 credits a month, and each successful call uses one. Reading your record once a day uses about 30. Keep the key on your server, never in your page. The fields are described on the security API page. It needs no code from us and works everywhere, including GitHub READMEs and GitBook.

For security firms

Two embeds come from your work on Trustblock. Your firm widget, on your own site. It shows figures counted from your audit reports on Trustblock and links to your firm page. Choose up to four figures, in your order, in the Playground: it gives the code.
See also the security firm widget page. A label for a client. Signed in to your firm account, the section “Project label for a client” gives the label code of a project from your published audits, ready to send to that project’s team. The label carries your firm’s name when your report is the latest.

Free, and no sign-in

  • The label, its image, the firm widget and the plain link are free. They need no account, no key and no sign-in.
  • The API needs a developer account and its key.
  • Showing the label is your choice. Your record on Trustblock is the same with or without it.