common

Documentation

Index

• Constants
• func BytesToPrivateKey(keyBytes []byte) (*ecies.PrivateKey, error)
• func CreateEncClient(conn *gethrpc.Client, encKey []byte, addressBytes []byte, ...) (*rpc.EncRPCClient, error)
• func GenerateRandomKey() ([]byte, error)
• func HashForLogging(input []byte) string
• func PrivateKeyToCompressedPubKey(prvKey *ecies.PrivateKey) []byte
• type Config
• type GWAccount
• type GWSessionKey
• type GWUser
  • func (u GWUser) AllAccounts() map[common.Address]*GWAccount
  • func (u GWUser) GetAllAddresses() []common.Address
• type RPCRequest
  • func (r *RPCRequest) Clone() *RPCRequest

Constants

const (
	Localhost = "127.0.0.1"

	JSONKeyAddress         = "address"
	JSONKeyID              = "id"
	JSONKeyMethod          = "method"
	JSONKeyParams          = "params"
	JSONKeyRPCVersion      = "jsonrpc"
	JSONKeySignature       = "signature"
	JSONKeyType            = "type"
	JSONKeyEncryptionToken = "encryptionToken"
	JSONKeyFormats         = "formats"
)

const (
	PathReady                     = "/ready/"
	PathJoin                      = "/join/"
	PathGetMessage                = "/getmessage/"
	PathAuthenticate              = "/authenticate/"
	PathQuery                     = "/query/"
	PathRevoke                    = "/revoke/"
	PathHealth                    = "/health/"
	PathSessionKeys               = "/session-key/"
	PathNetworkHealth             = "/network-health/"
	PathNetworkConfig             = "/network-config/"
	PathKeyExchange               = "/key-exchange/"
	WSProtocol                    = "ws://"
	HTTPProtocol                  = "http://"
	EncryptedTokenQueryParameter  = "token"
	AddressQueryParameter         = "a"
	MessageUserIDLen              = 40
	MessageUserIDLenWithPrefix    = 42
	EthereumAddressLen            = 42
	SuccessMsg                    = "success"
	APIVersion1                   = "/v1"
	PathVersion                   = "/version/"
	DeduplicationBufferSize       = 20
	DefaultGatewayAuthMessageType = "EIP712"
)

const EncryptionKeySize = 32

Functions

func BytesToPrivateKey

func BytesToPrivateKey(keyBytes []byte) (*ecies.PrivateKey, error)

BytesToPrivateKey converts []bytes to *ecies.PrivateKey

func CreateEncClient

func CreateEncClient(conn *gethrpc.Client, encKey []byte, addressBytes []byte, privateKeyBytes []byte, signature []byte, signatureType viewingkey.SignatureType, logger gethlog.Logger) (*rpc.EncRPCClient, error)

func GenerateRandomKey

func GenerateRandomKey() ([]byte, error)

func HashForLogging

func HashForLogging(input []byte) string

HashForLogging creates a double-hashed hex string of the input bytes for secure logging

func PrivateKeyToCompressedPubKey

func PrivateKeyToCompressedPubKey(prvKey *ecies.PrivateKey) []byte

PrivateKeyToCompressedPubKey converts *ecies.PrivateKey to compressed PubKey ([]byte with length 33)

Types

type Config

type Config struct {
	WalletExtensionHost     string
	WalletExtensionPortHTTP int
	WalletExtensionPortWS   int

	NodeRPCHTTPAddress      string
	NodeRPCWebsocketAddress string

	LogPath        string
	DBPathOverride string // Overrides the database file location. Used in tests.
	VerboseFlag    bool

	DBType          string
	DBConnectionURL string

	TenChainID       int
	StoreIncomingTxs bool

	RateLimitUserComputeTime       time.Duration
	RateLimitWindow                time.Duration
	RateLimitMaxConcurrentRequests int

	InsideEnclave                bool // Indicates if the program is running inside an enclave
	KeyExchangeURL               string
	EnableTLS                    bool
	TLSDomain                    string
	EncryptingCertificateEnabled bool
	DisableCaching               bool
}

Config contains the configuration required by the WalletExtension.

type GWAccount

type GWAccount struct {
	User          *GWUser
	Address       *common.Address
	Signature     []byte // the signature by the account over the userId - which is derived from the VK
	SignatureType viewingkey.SignatureType
}

type GWSessionKey

type GWSessionKey struct {
	Account    *GWAccount
	PrivateKey *ecies.PrivateKey // the private key corresponding to the account
}

GWSessionKey - an account key-pair registered for a user

type GWUser

type GWUser struct {
	ID         []byte
	Accounts   map[common.Address]*GWAccount
	UserKey    []byte
	SessionKey *GWSessionKey
	ActiveSK   bool // the session key is active, and it must be used to sign all incoming transactions, and used as the preferred account
}

func (GWUser) AllAccounts

func (u GWUser) AllAccounts() map[common.Address]*GWAccount

func (GWUser) GetAllAddresses

func (u GWUser) GetAllAddresses() []common.Address

type RPCRequest

type RPCRequest struct {
	ID     json.RawMessage
	Method string
	Params []interface{}
}

func (*RPCRequest) Clone

func (r *RPCRequest) Clone() *RPCRequest

Clone returns a new instance of the *RPCRequest