Settled.Sdk
0.2.0
dotnet add package Settled.Sdk --version 0.2.0
NuGet\Install-Package Settled.Sdk -Version 0.2.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Settled.Sdk" Version="0.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Settled.Sdk" Version="0.2.0" />
<PackageReference Include="Settled.Sdk" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Settled.Sdk --version 0.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Settled.Sdk, 0.2.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Settled.Sdk@0.2.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Settled.Sdk&version=0.2.0
#tool nuget:?package=Settled.Sdk&version=0.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Settled.Sdk
C# SDK for Settled, a tamper-evident audit log built on RFC 6962 Merkle trees.
Requires .NET 10+.
Installation
dotnet add package Settled.Sdk
Usage
Connecting to a Settled server
using Settled.Sdk;
using var client = new SettledClient("http://localhost:50051");
// Append an entry
var result = await client.AppendAsync(key: Encoding.UTF8.GetBytes("user:42"), data: eventBytes);
Console.WriteLine($"Assigned seq: {result.Seq}");
// Retrieve by sequence number
var entry = await client.GetAsync(result.Seq);
// Retrieve the N most-recent entries (newest first)
var recent = await client.GetLatestAsync(n: 10);
// Get the current Signed Tree Head
var sth = await client.GetSthAsync();
// Request an inclusion proof
var ip = await client.InclusionProofAsync(seq: result.Seq, treeSize: sth.TreeSize);
// Request a consistency proof between two tree sizes
var cp = await client.ConsistencyProofAsync(oldSize: 10, newSize: sth.TreeSize);
Verifying proofs locally
using Settled.Sdk;
// Verify a leaf is included in the tree
bool ok = Verifier.VerifyInclusion(leafHash, leafIndex, treeSize, proof, rootHash);
// Verify the old tree is a prefix of the new tree
bool ok = Verifier.VerifyConsistency(oldSize, newSize, proof, oldRoot, newRoot);
// Verify the Ed25519 signature on a Signed Tree Head
bool ok = Verifier.VerifyTreeHead(treeSize, rootHash, timestampNs, signature, publicKey);
License
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net10.0
- BouncyCastle.Cryptography (>= 2.4.0)
- Google.Protobuf (>= 3.27.0)
- Grpc.Net.Client (>= 2.63.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.