NetKeystore 1.0.0

A .NET standard class library for interacting with Ethereum keystore files

Install-Package NetKeystore -Version 1.0.0
dotnet add package NetKeystore --version 1.0.0
<PackageReference Include="NetKeystore" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add NetKeystore --version 1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

NetKeystore

The library is available as a NuGet package here.

Introduction

This is a light-weight library that's only responsible for dealing with Ethereum keystore files written in C#.

Using the Package

Adding to your project

Add the package by using the following command:

$ dotnet add package NetKeystore

Using it in your code

First, obtain a KeystoreReader instance from a Keystore object, a string containing the JSON content or a file name:

var reader = KeystoreReader.FromFile("/path/to/keystore");

Then, use the TryDecrypt function to decrypt the keystore file:

reader.TryDecrypt("ASDF12345", out var privateKey);

The function returns false if the passphase provided is incorrect, or throws an exception if the cipher or kdf is not supported (yet).

Limitations

Currently the functionality of the library is quite limited with the following known limitations:

  • Can only decrypt keystore files; no way to creat one
  • Only supports scrypt as the key derivation function

I will try to perfect the library in the future, or you can help me do it together ;)

Contribution

Contributions are welcomed! You may post issues on GitHub, or better, post pull requests for this project.

You can also contribute test data as part of the unit test!

NetKeystore

The library is available as a NuGet package here.

Introduction

This is a light-weight library that's only responsible for dealing with Ethereum keystore files written in C#.

Using the Package

Adding to your project

Add the package by using the following command:

$ dotnet add package NetKeystore

Using it in your code

First, obtain a KeystoreReader instance from a Keystore object, a string containing the JSON content or a file name:

var reader = KeystoreReader.FromFile("/path/to/keystore");

Then, use the TryDecrypt function to decrypt the keystore file:

reader.TryDecrypt("ASDF12345", out var privateKey);

The function returns false if the passphase provided is incorrect, or throws an exception if the cipher or kdf is not supported (yet).

Limitations

Currently the functionality of the library is quite limited with the following known limitations:

  • Can only decrypt keystore files; no way to creat one
  • Only supports scrypt as the key derivation function

I will try to perfect the library in the future, or you can help me do it together ;)

Contribution

Contributions are welcomed! You may post issues on GitHub, or better, post pull requests for this project.

You can also contribute test data as part of the unit test!

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
1.0.0 281 4/26/2018