https://github.com/SubstrateGaming/Substrate.NET.Wallet

Substrate .NET Wallet Integration
https://github.com/SubstrateGaming/Substrate.NET.Wallet

Last synced: 3 months ago
JSON representation

Substrate .NET Wallet Integration

• Host: GitHub
• URL: https://github.com/SubstrateGaming/Substrate.NET.Wallet
• Owner: SubstrateGaming
• License: other
• Created: 2023-09-24T13:11:49.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-04-14T19:01:00.000Z (7 months ago)
• Last Synced: 2024-04-19T19:05:37.709Z (7 months ago)
• Language: C#
• Size: 176 KB
• Stars: 2
• Watchers: 1
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Substrate .NET Wallet (NETStandard2.0, NETStandard2.1, NET6.0)

*Substrate .NET Wallet functions for substrate-based nodes*  

![Build](https://github.com/SubstrateGaming/Substrate.NET.Wallet/actions/workflows/build.yml/badge.svg)

[![Nuget](https://img.shields.io/nuget/v/Substrate.NET.Wallet)](https://www.nuget.org/packages/Substrate.NET.Wallet/)

[![GitHub issues](https://img.shields.io/github/issues/SubstrateGaming/Substrate.NET.Wallet.svg)](https://github.com/SubstrateGaming/Substrate.NET.Wallet/issues)

[![license](https://img.shields.io/github/license/SubstrateGaming/Substrate.NET.Wallet)](https://github.com/SubstrateGaming/Substrate.NET.Wallet/blob/origin/LICENSE)

[![contributors](https://img.shields.io/github/contributors/SubstrateGaming/Substrate.NET.Wallet)](https://github.com/SubstrateGaming/Substrate.NET.Wallet/graphs/contributors)

[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=SubstrateGaming_Substrate.NET.Wallet&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=SubstrateGaming_Substrate.NET.Wallet)  

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=SubstrateGaming_Substrate.NET.Wallet&metric=coverage)](https://sonarcloud.io/summary/new_code?id=SubstrateGaming_Substrate.NET.Wallet)

 

## How to use ?

### Create a new Keyring

```c#

// Create a new Keyring, by default ss58 format is 42 (Substrate standard address)

var keyring = new Substrate.NET.Wallet.Keyring.Keyring();

// You can specify ss58 address if needed (check SS58 regitry here : https://github.com/paritytech/ss58-registry/blob/main/ss58-registry.json)

keyring.Ss58Format = 0; // Polkadot

```

### Create a new account with a random mnemonic phrase

```c#

// Generate a new mnemonic for a new account

var newMnemonic = Mnemonic.GenerateMnemonic(MnemonicSize.Words12);

// Also available for 15, 18, 21, 24 mnemonic words

```

### Load an account with a mnemonic phrase

```c#

// Use an existing mnemonic

var existingMnemonicAccount = "entire material egg meadow latin bargain dutch coral blood melt acoustic thought";

// Import an account from mnemonic automatically unlock all feature

var firstWallet = keyring.AddFromMnemonic(existingMnemonicAccount, new Meta() { name = "My account name"}, NetApi.Model.Types.KeyType.Ed25519);

// Account is unlock and ready to sign transaction

```

### Export an account to a file

```c#

// Choose a password to protect your account file

var walletFile = firstWallet.ToWalletFile("MyWallet", "myPassword")

var json = firstWallet.ToJson("MyWallet", "myPassword");

// Now save

```

### Import a wallet from a json file

```c#

var secondWallet = keyring.AddFromJson(json);

// Wallet is imported but locked

// You need to unlock the account with the associated password

secondWallet.Unlock("myPassword");

```

### Sign and verify with you account

```c#

string message = "Hello !";

var signature = firstWallet.Sign(message);

var isVerify = firstWallet.Verify(signature, message);

```