https://github.com/layr-labs/bn254-keystore-go

EIP 2335 Compatible Keystore using BN254
https://github.com/layr-labs/bn254-keystore-go

Last synced: 3 months ago
JSON representation

EIP 2335 Compatible Keystore using BN254

• Host: GitHub
• URL: https://github.com/layr-labs/bn254-keystore-go
• Owner: Layr-Labs
• License: other
• Created: 2024-09-13T21:28:59.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-10-07T20:45:55.000Z (3 months ago)
• Last Synced: 2024-10-27T05:16:15.515Z (3 months ago)
• Language: Go
• Homepage:
• Size: 166 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# EIP 2335 Compatible Keystore using BN254

### Description

This is a mechanism for storing private keys. It is a JSON file that encrypts a private key and is the standard for interchanging keys between devices as until a user provides their password, their key is safe.

Refer EIP-2335 for more details.

### Warning & Disclaimer

This code is unaudited and under construction. This is experimental software and is provided on an "as is" and "as available" basis and may not work at all. It should not be used in production.

### Usage

#### Installation

```bash

go get github.com/Layr-Labs/bn254-keystore-go

```

#### Example

```go

package main

import (

	"encoding/hex"

	"fmt"

	"github.com/Layr-Labs/bn254-keystore-go/keystore"

)

func main() {

	// Create a new bn254 key

	ks, err := keystore.NewKeyPair("p@$$w0rd", "english")

	if err != nil {

		fmt.Println(err)

		return

	}

	fmt.Println("Mnemonic: ", ks.Mnemonic)

	fmt.Println("Private Key Hex: ", hex.EncodeToString(ks.PrivateKey))

}

```

## Security Bugs

Please report security vulnerabilities to [email protected]. Do NOT report security bugs via Github Issues.