DotNut.BcUr 1.0.1

dotnet add package DotNut.BcUr --version 1.0.1
                    
NuGet\Install-Package DotNut.BcUr -Version 1.0.1
                    
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="DotNut.BcUr" Version="1.0.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="DotNut.BcUr" Version="1.0.1" />
                    
Directory.Packages.props
<PackageReference Include="DotNut.BcUr" />
                    
Project file
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 DotNut.BcUr --version 1.0.1
                    
#r "nuget: DotNut.BcUr, 1.0.1"
                    
#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 DotNut.BcUr@1.0.1
                    
#: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=DotNut.BcUr&version=1.0.1
                    
Install as a Cake Addin
#tool nuget:?package=DotNut.BcUr&version=1.0.1
                    
Install as a Cake Tool

DotNut.BcUr

C# native, zero-dependency implementation of the BC-UR encoding specification. Based on the reference C++ implementation by Blockchain Commons.

Installation

dotnet add package DotNut.BcUr

Usage

Single-part encoding

using DotNut.BcUr;

byte[] data = ...;

Ur ur = Ur.FromBytes(data);
string encoded = UREncoder.Encode(ur);
// "ur:bytes/hdeymejtswh..."

Ur decoded = URDecoder.Decode(encoded);
byte[] original = decoded.ToBytes();

Custom CBOR type

byte[] cbor = ...; // pre-encoded CBOR
var ur = new Ur("crypto-seed", cbor);

string encoded = UREncoder.Encode(ur);
// "ur:crypto-seed/..."

Multi-part encoding (animated QR)

For large payloads split across multiple QR codes using fountain codes.

byte[] data = ...;
var ur = Ur.FromBytes(data);
var encoder = new UREncoder(ur, maxFragmentLen: 200);
var decoder = new URDecoder();

while (!decoder.IsComplete)
{
    string part = encoder.NextPart();
    // display QR for `part`, e.g. "ur:bytes/1-9/lpadascf..."
    decoder.ReceivePart(part);
}

Multi-part decoding

var decoder = new URDecoder();

foreach (string part in scannedParts)
{
    decoder.ReceivePart(part);
    if (decoder.IsComplete) break;
}

if (decoder.IsSuccess)
    byte[] data = decoder.ResultUr!.ToBytes();
else if (decoder.IsFailure)
    Exception error = decoder.ResultError!;

Bytewords

Low-level access to the Bytewords encoding used internally by UR.

string standard = ByteWords.Encode(data, ByteWords.Style.Standard); // "able acid also..."
string uri      = ByteWords.Encode(data, ByteWords.Style.Uri);      // "able-acid-also-..."
string minimal  = ByteWords.Encode(data, ByteWords.Style.Minimal);  // "aaao..."

byte[] decoded = ByteWords.Decode(minimal, ByteWords.Style.Minimal);
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  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.
  • net8.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.1 105 3/20/2026
1.0.0 102 3/20/2026