dotnet

title
.NET

tigerbeetle-dotnet

TigerBeetle client for C# and .Net

Usage

A client needs to be configured with a clusterID and replicaAddresses. The Client class is thread-safe and for better performance, a single instance should be shared between multiple concurrent tasks. Multiple clients can be instantiated in case of connecting to more than one TigerBeetle cluster.

var client = new Client(clusterID: 0, replicaAddresses: new[] { "3001", "3002", "3003" });

Account Creation

All TigerBeetle's IDs are 128-bit integers, and tigerbeetle-dotnet client accepts a wide range of dotnet values: int, uint, long, ulong, Guid, byte[] and the custom type UInt128.

var accounts = new[] {
    new Account
    {
        Id = 1,
        UserData = Guid.NewGuid(),
        Code = 2,
        Ledger = 720,
    },     
};

var errors = client.CreateAccounts(accounts);

Successfully executed events return an empty array whilst unsuccessful ones return an array with errors for only the ones that failed. An error will point to the index in the submitted array of the failed event.

Creating a Transfer

Amounts are 64-bit unsigned integers values.

transfers = new[] {
    new Transfer
    {
        Id = 100,
        DebitAccountId = accountA.Id,
        CreditAccountId = accountB.Id,
        Code = 1,
        Ledger = 720,
        Amount = 100,
    },
}

var errors = await client.CreateTransfersAsync(accounts);

Build from source

Prerequisites:

dotnet 6

Dotnet 6 is needed only to build and run the tests, this library can be used from any .Net Standard 2.1 compatible runtime (.Net Core, Xamarin, etc) For Windows users, there is a .sln solution file that can be opened with Microsoft Visual Studio 2022.

1. Clone this repository

git clone https://github.com/tigerbeetledb/tigerbeetle.git
cd tigerbeetle

2. Install Zig and Tigerbeetle

Linux and macOS

./scripts/install.sh

Windows

.\scripts\install.bat

3. Build dotnet client

Linux and macOS

cd src/clients/dotnet
dotnet build

Windows

cd src\clients\dotnet
dotnet build

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use these files except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.