common

Documentation

Index

• Constants
• func ChainClientContext(ctx context.Context, chain string, client ChainClient) context.Context
• func CryptoModeContext(ctx context.Context, mode CryptoMode) context.Context
• func SsmClientContext(ctx context.Context, device string, client SsmClient) context.Context
• func SsmDeviceInfoContext(ctx context.Context, info SsmDeviceInfo) context.Context
• type AddressInfo
  • func (p *AddressInfo) Decode(data []byte) error
  • func (p *AddressInfo) Encode() ([]byte, error)
• type ChainClient
  • func ChainClientFromContext(ctx context.Context, chain string) ChainClient
• type CryptoAddress
  • func (p *CryptoAddress) Decode(data []byte) error
  • func (p *CryptoAddress) Encode() ([]byte, error)
• type CryptoMode
  • func CryptoModeFromContext(ctx context.Context) CryptoMode
• type GetAddressInfo
• type SpendAssetInfo
• type SpendInfo
• type SpendTx
• type SsmAddress
• type SsmChain
• type SsmClient
  • func SsmClientFromContext(ctx context.Context, device string) SsmClient
• type SsmDevice
• type SsmDeviceInfo
  • func SsmDeviceInfoFromContext(ctx context.Context) SsmDeviceInfo
• type SsmFingerprint
• type TransactionInfo
• type UTXOInfo

Constants

const (
	ChainClientKey   = "Key.ChainClientKey"
	SsmClientKey     = "Key.SsmClientKey"
	SsmDeviceInfoKey = "Key.SsmDeviceInfoKey"
	CryptoModeKey    = "Key.CryptoModeKey"
)

const (
	CryptoAddressNextDepositSubject = chanPrefix + "CryptoAddress.NextDeposit"
	CryptoAddressNewDepositSubject  = chanPrefix + "CryptoAddress.NewDeposit"
	AddressInfoSubject              = chanPrefix + "CryptoAddress.AddressInfo"
)

Functions

func ChainClientContext

func ChainClientContext(ctx context.Context, chain string, client ChainClient) context.Context

func CryptoModeContext

func CryptoModeContext(ctx context.Context, mode CryptoMode) context.Context

func SsmClientContext

func SsmClientContext(ctx context.Context, device string, client SsmClient) context.Context

func SsmDeviceInfoContext

func SsmDeviceInfoContext(ctx context.Context, info SsmDeviceInfo) context.Context

Types

type AddressInfo

type AddressInfo struct {
	Chain          string
	PublicAddress  string
	Unconfidential string
	IsValid        bool
}

func (*AddressInfo) Decode

func (p *AddressInfo) Decode(data []byte) error

func (*AddressInfo) Encode

func (p *AddressInfo) Encode() ([]byte, error)

type ChainClient

type ChainClient interface {
	GetNewAddress(ctx context.Context, account string) (string, error)
	ImportAddress(ctx context.Context, account, address, pubkey, blindingkey string) error
	GetAddressInfo(ctx context.Context, address string) (AddressInfo, error)
	GetBlockCount(ctx context.Context) (int64, error)
	ListUnspent(ctx context.Context, minConf, maxConf int, addresses ...string) ([]TransactionInfo, error)
	ListUnspentByAsset(ctx context.Context, minConf, maxConf int, asset string) ([]TransactionInfo, error)
	LockUnspent(ctx context.Context, unlock bool, transactions ...TransactionInfo) error
	ListLockUnspent(ctx context.Context) ([]TransactionInfo, error)
	GetTransaction(ctx context.Context, txID string) (TransactionInfo, error)

	SpendFunds(ctx context.Context, changeAddress string, inputs []UTXOInfo, outputs []SpendInfo, addressInfo GetAddressInfo, blindTransaction bool) (SpendTx, error)
}

ChainClient interface specification for bitcoin and elements

func ChainClientFromContext

func ChainClientFromContext(ctx context.Context, chain string) ChainClient

type CryptoAddress

type CryptoAddress struct {
	CryptoAddressID  uint64
	Chain            string
	AccountID        uint64
	PublicAddress    string
	Unconfidential   string
	IgnoreAccounting bool
}

func (*CryptoAddress) Decode

func (p *CryptoAddress) Decode(data []byte) error

func (*CryptoAddress) Encode

func (p *CryptoAddress) Encode() ([]byte, error)

type CryptoMode

type CryptoMode string

const (
	CryptoModeBitcoinCore CryptoMode = "bitcoin-core"
	CryptoModeCryptoSsm   CryptoMode = "crypto-ssm"
)

func CryptoModeFromContext

func CryptoModeFromContext(ctx context.Context) CryptoMode

type GetAddressInfo

type GetAddressInfo func(ctx context.Context, address string, isUnConfidential bool) (commands.SsmPath, error)

type SpendAssetInfo

type SpendAssetInfo struct {
	Hash          string
	ChangeAddress string
	ChangeAmount  float64
}

type SpendInfo

type SpendInfo struct {
	PublicAddress string
	Amount        float64
	// Asset optional
	Asset SpendAssetInfo
}

type SpendTx

type SpendTx struct {
	TxID string
}

type SsmAddress

type SsmAddress struct {
	Chain       string
	Address     string
	PubKey      string
	BlindingKey string
}

type SsmChain

type SsmChain string

type SsmClient

type SsmClient interface {
	NewAddress(ctx context.Context, ssmPath commands.SsmPath) (SsmAddress, error)
	SignTx(ctx context.Context, chain, inputransaction string, inputs ...commands.SignTxInputs) (string, error)
}

SsmClient interface specification for crypto-ssm

func SsmClientFromContext

func SsmClientFromContext(ctx context.Context, device string) SsmClient

type SsmDevice

type SsmDevice string

type SsmDeviceInfo

type SsmDeviceInfo interface {
	Fingerprint(ctx context.Context, chain SsmChain) (SsmFingerprint, error)
}

func SsmDeviceInfoFromContext

func SsmDeviceInfoFromContext(ctx context.Context) SsmDeviceInfo

type SsmFingerprint

type SsmFingerprint string

type TransactionInfo

type TransactionInfo struct {
	Chain         string
	Account       string
	Address       string
	Asset         string
	TxID          string
	Vout          int64
	Amount        float64
	Confirmations int64
	Spendable     bool
}

type UTXOInfo

type UTXOInfo struct {
	TxID string
	Vout int
}