dotnet-stellar-sdk

Stellar API SDK for .NET Core 2.x and .NET Standard 2.0


Report Bug · Request Feature · Report Security Vulnerability

Table of Contents

• About the Project
• Installation
  • Visual Studio
  • JetBrains Rider
  • Other
• Usage
• XDR
• XDR Generation
• Contributors
• License
• Acknowledgements

About The Project

dotnet-stellar-sdk is a Net Core/Standard library for communicating with a Stellar Horizon server. It is used for building Stellar apps.

This project originated as a full port of the official Java SDK API

Installation

The stellar-dotnet-sdk library is bundled in a NuGet Package.

• NuGet Package

Visual Studio

• Using the console

  • Run Install-Package stellar-dotnet-sdk in the console.

• Using the NuGet Package Manager

  • Search this package NuGet Package and install it.

JetBrains Rider

• https://www.jetbrains.com/help/rider/Using_NuGet.html#

Other

• https://docs.microsoft.com/en-us/nuget/consume-packages/overview-and-workflow#ways-to-install-a-nuget-package

Usage

Check the Tutorials page to get started.

In case of doubts or issues, you can ask for help here:

• Stellar Stack Exchange

• Keybase Team

XDR

If you only need the XDR objects in a .NET Standard NuGet package, then you can get those here: https://www.nuget.org/packages/stellar-dotnet-sdk-xdr/

XDR Generation

In order to generate the XDR Files automatically in C# a custom XDR Generator must be used.

You can find the latest working generator here: https://github.com/fracek/xdrgen/tree/csharp

You can use that version of xdrgen to regenerate the XDR files from the .x files located from the source of the original API SDK for Horizon.

Example

1. Install custom XDR generator:

   git clone https://github.com/fracek/xdrgen
   cd xdrgen
   git checkout csharp
   rake install
   

2. Regenerate .cs files from .x files:

   cd dotnet-stellar-sdk/
   xdrgen -o=./stellar-dotnet-sdk-xdr/generated -l=csharp -n=stellar_dotnet_sdk.xdr ./stellar-dotnet-sdk-xdr/*.x
   

3. Reformat .cs files using dotnet-format:

   dotnet format
   

Contributors

• Eric Malamisura (Twitter: @EricDaCoder, Keybase: elucidsoft)
• Kirbyrawr (Keybase: Kirbyrawr)
• Michael Monte
• Francesco Ceccon

License

dotnet-stellar-sdk is licensed under an Apache-2.0 license. See the LICENSE file for details.

Acknowledgements

• Stellar Development Foundation