https://github.com/ChainSafe/go-schnorrkel

🍵 Schnorr Signatures over Ristretto255 in pure Go
https://github.com/ChainSafe/go-schnorrkel

go schnorrkel

Last synced: about 2 months ago
JSON representation

🍵 Schnorr Signatures over Ristretto255 in pure Go

• Host: GitHub
• URL: https://github.com/ChainSafe/go-schnorrkel
• Owner: ChainSafe
• License: apache-2.0
• Created: 2019-10-25T01:43:27.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-12-18T23:01:29.000Z (9 months ago)
• Last Synced: 2024-06-20T11:46:58.249Z (3 months ago)
• Topics: go, schnorrkel
• Language: Go
• Homepage:
• Size: 1.47 MB
• Stars: 86
• Watchers: 12
• Forks: 30
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Audit: audit_report.pdf

Awesome Lists containing this project

README

        
# go-schnorrkel

  

    

  

This repo contains the Go implementation of the sr25519 signature algorithm (schnorr over ristretto25519). The existing Rust implementation is [here.](https://github.com/w3f/schnorrkel)

This library is currently able to create sr25519 keys, import sr25519 keys, and sign and verify messages. It is interoperable with the Rust implementation. 

The BIP39 implementation in this library is compatible with the rust [substrate-bip39](https://github.com/paritytech/substrate-bip39) implementation.  Note that this is not a standard bip39 implementation.

This library has been audited as of August 2021 and is production-ready. Please see the [audit report](audit_report.pdf) for the results of the audit.

### dependencies

go 1.21

### usage

Example: key generation, signing, and verification

```go

package main 

import (

	"fmt"

	

	schnorrkel "github.com/ChainSafe/go-schnorrkel"

)

func main() {

	msg := []byte("hello friends")

	signingCtx := []byte("example")

	signingTranscript := schnorrkel.NewSigningContext(signingCtx, msg)

	verifyTranscript := schnorrkel.NewSigningContext(signingCtx, msg)

	priv, pub, err := schnorrkel.GenerateKeypair()

	if err != nil {

		panic(err)

	}

	sig, err := priv.Sign(signingTranscript)

	if err != nil {

		panic(err)

	}

	ok := pub.Verify(sig, verifyTranscript)

	if !ok {

		fmt.Println("failed to verify signature")

		return

	}

	fmt.Println("verified signature")

}

```

Please see the [godocs](https://pkg.go.dev/github.com/ChainSafe/go-schnorrkel) for more usage examples.