gosigner

package module
v0.0.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 3, 2025 License: Apache-2.0, MIT Imports: 3 Imported by: 0

README

go_signer

Library for support multiples method to sign

Configuration

This library supports 3 types of signing methods:

  • local: it's a private key file
  • GCP: google cloud KMS
  • remote: it's a call to a remote signer service that implements remote signing APIs as web_3signer only support sign transactions

There are a None method just for develop propouses

Configuration local method

The object SignerConfig needs next fields:

  • SignerConfig.Method : local (you can use const MethodLocal)
  • SignerConfig.Config["Path"]: full path to keystore
  • SignerConfig.Config["Password"]: password for the keystore
Method = "local"
Path = "/path/to/file"
Password = "password"
Configuration GCP method

The object SignerConfig needs next fields:

  • SignerConfig.Method : GCP (you can use const MethodGCPKMS)
  • SignerConfig.Config["KeyName"]: Full path to key resource with version Example of config file:
Method = "GCP" 
KeyName ="projects/your-prj-name/locations/your_location/keyRings/name_of_your_keyring/cryptoKeys/key-name/cryptoKeyVersions/version"

You can copy KeyName from console > Security > Key Managent Or executing gcloud kms inventory list-keys

Configuration remote method
Generic configuration

The object SignerConfig needs next params:

  • SignerConfig.Method : remote (you can use const MethodRemoteSigner)

  • SignerConfig.Config["URL"]: URL to web3_signer service

  • SignerConfig.Config["Address"]: Public address to use if there are more than 1 in web3_signer service. If there are only 1 it can be empty and the first one will be used.

  • Example of config file:

Method = "remote"
URL = "http://localhost:9000"
Address = "0xe34243804e1f7257acb09c97d0d6f023663200c39ee85a1e6927b0b391710bbb"

Support

Feel free to open an issue if you have any feature request or bug report.

License

Copyright (c) 2024 PT Services DMCC

Licensed under either of

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	Version = "v0.0.5"
)

Functions

func PrintVersion

func PrintVersion(w io.Writer)

PrintVersion prints version info into the provided io.Writer.

Types

This section is empty.

Directories

Path Synopsis
cmd
test
e2e

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL