Skip to content

Commit

Permalink
Merge pull request #735 from datatrails/archive-scitt-receipts-remove…
Browse files Browse the repository at this point in the history
…-scitt-refs

Archive scitt receipts remove scitt refs
  • Loading branch information
SteveLasker committed Dec 11, 2023
2 parents 1748eb3 + dee3ec9 commit 9c5c8e8
Show file tree
Hide file tree
Showing 10 changed files with 194 additions and 20 deletions.
16 changes: 16 additions & 0 deletions archetypes/archive.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: "{{ replace .Name "-" " " | title }}"
description: ""
lead: ""
date: {{ .Date }}
lastmod: {{ .Date }}
draft: false
images: []
menu:
archive:
parent: ""
weight: 999
toc: true
---

{{< img src="{{ .Name | urlize }}.jpg" alt="{{ replace .Name "-" " " | title }}" caption="{{ replace .Name "-" " " | title }}" >}}
7 changes: 6 additions & 1 deletion config/_default/menus.toml
Original file line number Diff line number Diff line change
Expand Up @@ -68,10 +68,15 @@

[[glossary]]
name = "Glossary"
weight = 50
weight = 10
identifier = "glossary"
url = "/glossary/"

[[archive]]
name = "Archive"
weight = 10
identifier = "archive"
url = "/archive/"


[[main]]
Expand Down
15 changes: 15 additions & 0 deletions content/archive/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: "Archive"
description: "Archive section for old articles that we want to keep."
lead: ""
date: 2023-12-11T09:25:37+01:00
lastmod: 2023-12-11T09:25:37+01:00
draft: false
images: []
weight: 999
toc: true
aliases:
---
This section is intended to be a space for articles that are no longer needed but still have content that we do not want to delete.

It is not linked to by any public facing parts of the docs.
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
---
title: "Verify DataTrails SCITT Receipts"
description: "Proof of Posting Receipts for SCITT"
lead: "Proof of Posting Receipts for SCITT"
date: 2021-05-18T14:52:25+01:00
lastmod: 2021-05-18T14:52:25+01:00
draft: false
images: []
menu:
platform:
parent: "overview"
weight: 39
toc: true
title: "Verify DataTrails Receipts"
description: "Proof of Posting Receipts for DataTrails"
lead: "Proof of Posting Receipts for DataTrails"
date: 2021-05-18T14:52:25+01:00
lastmod: 2021-05-18T14:52:25+01:00
draft: false
images: []
menu:
archive:
parent: "archive"
weight: 10
---
# This article is deprecated

## What are receipts?

Expand All @@ -29,25 +29,33 @@ Receipts for Public Events can be obtained by any authenticated API request.

## What is in a receipt?

The Receipts API is provided as an integration with emerging standards driven by [Supply Chain Integrity, Transparency, and Trust (SCITT)](https://www.datatrails.ai/what-is-scitt-and-how-does-datatrails-help/).
This page discusses receipts in the context of verifying events recorded on the DataTrails platform.

Regardless of how the standards evolve, any receipt you obtain today will remain valid proof of posting for the Event.
For a discussion of how DataTrails supports SCITT Transparent Statements and their corresponding SCITT Receipts see [Supply Chain Integrity, Transparency, and Trust (SCITT)](https://www.datatrails.ai/what-is-scitt-and-how-does-rkvst-help/).

Any DataTrails receipt you obtain today will remain valid proof of posting for the Event.

{{< warning >}}
**Warning:** The complete contents of the Event are present in the receipt in clear text. If the Event information is sensitive, the receipt should be regarded as sensitive material as well.
{{< / warning >}}

<br>

The `/archivist/v1/notary/claims/events` API creates a SCITT claim for a DataTrails event.
The `/archivist/v1/notary/claims/events` API creates a claim for a DataTrails event.

A claim is a commitment signed by you attesting to the contents of the event.

The response is receipt which is signed by DataTrails using a key specific to your DataTrails tenancy. This receipt attests to the inclusion of your statement in a verifiable log.

In this instance the verifiable log is a private ledger and the signing key is an ECDSA ethereum wallet key. The log (ledger) can not be changed without visibly and immediately breaking the record of all DataTrails tenants.

In the SCITT model, this claim is then presented to a transparency service to obtain a receipt. When you present a claim to the `/archivist/v1/notary/receipts` API to obtain your receipt, DataTrails is acting as the transparency service and returns a (draft) standards-compatible receipt proving that you recorded your Event on the DataTrails Blockchain.
Because DataTrails exposes an api to collect the block headers from the private ledger it is possible for anyone to hold DataTrails to account.

## How do I retrieve and verify a receipt?

Once retrieved, receipts are fully verifiable offline and without calls to the DataTrails system using independent OSS tooling.
Once retrieved, receipts are fully verifiable offline and without calls to the DataTrails system using independent OSS tooling in a manner consistent with the standards established by the ethereum ecosystem.

However, for your convenience DataTrails provides a Python script that can be used to retrieve and verify a receipt. For full details, please visit our [Python documentation](https://python-scitt.datatrails.ai/index.html).
For your convenience DataTrails provides a Python script that can be used to retrieve and verify a receipt. For full details, please visit our [Python documentation](https://python-scitt.datatrails.ai/index.html).

Receipts can also be retrieved offline using curl commands. To get started, make sure you have an [Access Token](/developers/developer-patterns/getting-access-tokens-using-app-registrations/), [Event ID](/platform/overview/creating-an-event-against-an-asset/), and [jq](https://github.com/stedolan/jq/wiki/Installation) installed.

Expand Down
2 changes: 1 addition & 1 deletion content/platform/overview/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ aliases:
<a href="/platform/overview/creating-an-event-against-an-asset/">Creating an Event Against an Asset &rarr;</a><br>
<a href="/platform/overview/registering-a-document-profile-asset/">Registering a Document Profile Asset &rarr;</a><br>
<a href="/platform/overview/public-attestation/">Public Attestation &rarr;</a><br>
<a href="/platform/overview/scitt-receipts/">Verify DataTrails SCITT Receipts &rarr;</a><br>
<a href="/platform/overview/verify-receipts/">Verify DataTrails Receipts &rarr;</a><br>
<a href="/platform/overview/instaproof/">Instaproof &rarr;</a></p>
</div>
</div>
20 changes: 20 additions & 0 deletions layouts/archive/list.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{{ define "main" }}
<div class="row justify-content-center">
<div class="col-md-12 col-lg-10 col-xl-8">
<article>
<h1 class="text-left">{{ .Title }}</h1>
<div class="text">{{ .Content }}</div>
<div>
{{ $currentSection := .CurrentSection }}
{{ range where .Site.RegularPages.ByTitle "Section" .Section }}
{{ if in (.RelPermalink | string) $currentSection.RelPermalink }}
<div>
<a href="{{ .RelPermalink }}">{{ .Params.title | title }} &rarr;</a>
</div>
{{ end }}
{{ end }}
</div>
</article><br>
</div>
</div>
{{ end }}
41 changes: 41 additions & 0 deletions layouts/archive/single.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
{{ define "main" }}
<div class="row flex-xl-nowrap">
<div class="col-lg-5 col-xl-4 docs-sidebar">
<nav class="docs-links" aria-label="Main navigation">
{{ partial "sidebar/archive-menu.html" . }}
</nav>
</div>
{{ if ne .Params.toc false -}}
<nav class="docs-toc d-none d-xl-block col-xl-3" aria-label="Secondary navigation">
{{ partial "sidebar/archive-toc.html" . }}
</nav>
{{ end -}}
{{ if .Params.toc -}}
<main class="docs-content col-lg-11 col-xl-9">
{{ else -}}
<main class="docs-content col-lg-11 col-xl-9 mx-xl-auto">
{{ end -}}
{{ if .Site.Params.options.breadCrumb -}}
<!-- https://discourse.gohugo.io/t/breadcrumb-navigation-for-highly-nested-content/27359/6 -->
<nav aria-label="breadcrumb">
<ol class="breadcrumb">
{{ partial "main/breadcrumb" . -}}
<li class="breadcrumb-item active" aria-current="page">{{ .Title }}</li>
</ol>
</nav>
{{ end }}
{{ if not .Site.Params.options.collapsibleSidebar -}}
{{ partial "main/archive-navigation.html" . }}
{{ else -}}
<div class="my-n3"></div>
{{ end -}}
<h1>{{ .Title }}</h1>
<p class="lead">{{ .Params.lead | safeHTML }}</p>
{{ partial "main/headline-hash.html" .Content }}
{{ if .Site.Params.editPage -}}
{{ partial "main/edit-page.html" . }}
{{ end -}}
{{ partial "main/archive-navigation.html" . }}
</main>
</div>
{{ end }}
24 changes: 24 additions & 0 deletions layouts/partials/main/archive-navigation.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{{ if or .Prev .Next -}}
<div class="docs-navigation d-flex justify-content-between">
<!-- https://www.feliciano.tech/blog/custom-sort-hugo-single-pages/ -->
{{ $pages := where site.RegularPages "Section" .Section -}}
{{ with $pages.Next . -}}
<a href="{{ .RelPermalink }}">
<div class="card my-1">
<div class="card-body py-2">
&larr; {{ .Title }}
</div>
</div>
</a>
{{ end -}}
{{ with $pages.Prev . -}}
<a class="ms-auto" href="{{ .RelPermalink }}">
<div class="card my-1">
<div class="card-body py-2">
{{ .Title }} &rarr;
</div>
</div>
</a>
{{ end -}}
</div>
{{ end -}}
39 changes: 39 additions & 0 deletions layouts/partials/sidebar/archive-menu.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
{{ if .Site.Params.options.collapsibleSidebar -}}
<ul class="list-unstyled collapsible-sidebar">
{{ $currentPage := . -}}
{{ range $index, $element := .Site.Menus.archive -}}
{{- $active := or ($currentPage.IsMenuCurrent "archive" .) ($currentPage.HasMenuCurrent "archive" .) -}}
{{- $active = or $active (eq $currentPage.Section .Identifier) -}}
<li class="mb-1">
<button class="btn btn-toggle align-items-center rounded collapsed" data-bs-toggle="collapse" data-bs-target="#{{ .Identifier }}" aria-expanded="{{ if $active }}true{{ else }}false{{ end }}">
{{ .Name }}
</button>
{{ if .HasChildren -}}
<div class="collapse{{ if $active }} show{{ end }}" id="{{ .Identifier }}">
<ul class="btn-toggle-nav list-unstyled fw-normal pb-1 small">
{{ range .Children -}}
{{- $active := or ($currentPage.IsMenuCurrent "archive" .) ($currentPage.HasMenuCurrent "archive" .) -}}
{{- $active = or $active (eq $currentPage.Section .Identifier) -}}
<li><a class="docs-link rounded{{ if $active }} active{{ end }}" href="{{ .URL | relURL }}">{{ .Name }}</a></li>
{{ end -}}
</ul>
</div>
{{ end -}}
</li>
{{ end -}}
</ul>
{{ else -}}
{{ $currentPage := . -}}
{{ range .Site.Menus.archive -}}
<h3>{{ .Name }}</h3>
{{ if .HasChildren -}}
<ul class="list-unstyled">
{{ range .Children -}}
{{- $active := or ($currentPage.IsMenuCurrent "archive" .) ($currentPage.HasMenuCurrent "archive" .) -}}
{{- $active = or $active (eq $currentPage.Section .Identifier) -}}
<li><a class="docs-link{{ if $active }} active{{ end }}" href="{{ .URL | relURL }}">{{ .Name }}</a></li>
{{ end -}}
</ul>
{{ end -}}
{{ end -}}
{{ end -}}
6 changes: 6 additions & 0 deletions layouts/partials/sidebar/archive-toc.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{{ if ne .Params.toc false -}}
<div class="page-links">
<h3>On this page</h3>
{{ .TableOfContents }}
</div>
{{ end -}}

0 comments on commit 9c5c8e8

Please sign in to comment.