client

Documentation

Overview

Methods and types for client and wallet operations.

Index

• func GetClientID() string
• func GetClientPeerPublicKey() string
• func GetClientPrivateKey() string
• func GetClientPublicKey() string
• func GetClientSysKeys() []sys.KeyPair
• func PopulateClient(clientjson string, signatureScheme string) error
• func PopulateClients(clientJsons []string, signatureScheme string) error
• func SetClient(w *zcncrypto.Wallet, signatureScheme string, txnFee uint64)
• func SetClientNonce(nonce int64)
• func SetTxnFee(fee uint64)
• func TxnFee() uint64
• func VerifySignature(signature string, msg string) (bool, error)
• func VerifySignatureWith(pubKey, signature, hash string) (bool, error)
• type Client
  • func GetClient() *Client
  • func GetClients() []*Client
• type SignFunc

Functions

func GetClientID

func GetClientID() string

GetClientID returns client id

func GetClientPeerPublicKey

func GetClientPeerPublicKey() string

func GetClientPrivateKey

func GetClientPrivateKey() string

GetClientPrivateKey returns client private key

func GetClientPublicKey

func GetClientPublicKey() string

GetClientPublicKey returns client public key

func GetClientSysKeys

func GetClientSysKeys() []sys.KeyPair

GetClientSysKeys convert client.KeyPair to sys.KeyPair

func PopulateClient

func PopulateClient(clientjson string, signatureScheme string) error

PopulateClient populates single client

• clientjson: client json string
• signatureScheme: signature scheme

func PopulateClients

func PopulateClients(clientJsons []string, signatureScheme string) error

PopulateClients This is a workaround for blobber tests that requires multiple clients to test authticket functionality

• clientJsons: array of client json strings
• signatureScheme: signature scheme

func SetClient

func SetClient(w *zcncrypto.Wallet, signatureScheme string, txnFee uint64)

func SetClientNonce

func SetClientNonce(nonce int64)

SetClientNonce sets client nonce

func SetTxnFee

func SetTxnFee(fee uint64)

SetTxnFee sets general transaction fee

func TxnFee

func TxnFee() uint64

TxnFee gets general txn fee

func VerifySignature

func VerifySignature(signature string, msg string) (bool, error)

VerifySignature verifies signature of a message with client public key and signature scheme

• signature: signature to use for verification
• msg: message to verify

func VerifySignatureWith

func VerifySignatureWith(pubKey, signature, hash string) (bool, error)

VerifySignatureWith verifies signature of a message with a given public key, and the client's signature scheme

• pubKey: public key to use for verification
• signature: signature to use for verification
• hash: message to verify

Types

type Client

type Client struct {
	*zcncrypto.Wallet
	SignatureScheme string
	// contains filtered or unexported fields
}

Client represents client information

func GetClient

func GetClient() *Client

GetClient returns client instance

func GetClients

func GetClients() []*Client

GetClients returns all clients

type SignFunc

type SignFunc func(hash string) (string, error)

var (

	// Sign is a function to sign a hash
	Sign SignFunc
)