Home

Awesome

<!-- PROJECT LOGO -->

<br /><p align="center"> <a href="https://github.com/elucidsoft/dotnet-stellar-sdk"><img width="460" height="300" src="https://raw.githubusercontent.com/elucidsoft/dotnet-stellar-sdk/master/.github/images/logo.svg"> </a> <!-- TITLE AND BADGES --> <h3 align="center"> dotnet-stellar-sdk</h3> <p align="center"> Stellar API SDK for .NET 6 <br /> <a href="https://ci.appveyor.com/project/elucidsoft/dotnet-stellar-sdk/branch/master"> <img src="https://ci.appveyor.com/api/projects/status/n34q6l3wyar2rq5l/branch/master?svg=true"></a> <a href="https://coveralls.io/github/elucidsoft/dotnet-stellar-sdk?branch=master"> <img src="https://coveralls.io/repos/github/elucidsoft/dotnet-stellar-sdk/badge.svg?branch=master"></a><a href="https://www.codefactor.io/repository/github/elucidsoft/dotnet-stellar-sdk"> <img src="https://www.codefactor.io/repository/github/elucidsoft/dotnet-stellar-sdk/badge"></a> <a href="https://www.nuget.org/packages/stellar-dotnet-sdk"> <img src="https://buildstats.info/nuget/stellar-dotnet-sdk"> </a><br /><br /><!-- USEFUL LINKS--><a href="https://elucidsoft.github.io/dotnet-stellar-sdk/"><strong> Explore the docs »</strong></a> <br /> <br /> <a href="https://github.com/elucidsoft/dotnet-stellar-sdk/issues/new?template=Bug_report.md"> Report Bug</a> · <a href="https://github.com/elucidsoft/dotnet-stellar-sdk/issues/new?template=Feature_request.md"> Request Feature</a> · <a href="https://github.com/elucidsoft/dotnet-stellar-sdk/security/policy">Report Security Vulnerability</a> </p></p>

<!-- TABLE OF CONTENTS -->

Table of Contents

<!-- ABOUT THE PROJECT -->

About The Project

dotnet-stellar-sdk is a .NET 6 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.

Visual Studio

JetBrains Rider

Other

<!-- USAGE EXAMPLES -->

Usage

Check the Tutorials page to get started.

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

XDR

NuGet Badge

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/stellar/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-->

Contributors

<!-- LICENSE -->

License

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

<!-- ACKNOWLEDGEMENTS -->

Acknowledgements

<!-- Disclaimer --> <!-- This readme is a modification of https://github.com/othneildrew/Best-README-Template that is licensed under MIT -->