ports

Documentation

Index

• Constants
• type Account
• type Balance
• type BlockInfo
• type BuildData
• type CustomPeriod
• type Deposit
• type FragmenterReply
• type Market
• type MarketCollectedFees
• type MarketFee
• type MarketInfo
• type MarketPrice
• type MarketReport
• type MarketStrategy
• type MarketVolume
• type Notification
• type Page
• type PredefinedPeriod
• type PriceFeed
• type PriceFeedInfo
• type PriceFeeder
• type PubSubStore
• type RepoManager
• type SecurePubSub
• type Subscription
• type SwapAccept
• type SwapComplete
• type SwapFail
• type SwapRequest
• type TimeRange
• type Trade
• type TradeFeeInfo
• type TradePreview
• type TradeStatus
• type TradeType
• type Transaction
• type TxInput
• type TxOutput
• type UnblindedInput
• type Utxo
• type UtxoKey
• type UtxoStatus
• type Wallet
• type WalletAccount
• type WalletInfo
• type WalletService
• type WalletStatus
• type WalletTxEventType
• type WalletTxNotification
• type WalletUtxoEventType
• type WalletUtxoNotification
• type Webhook
• type WebhookEvent
• type WebhookInfo
• type Withdrawal

Constants

const AnyTopic = "*"

const UnspecifiedTopic = ""

Types

type Account

type Account interface {
	CreateAccount(
		ctx context.Context, accountName string, isMarket bool,
	) (WalletAccount, error)
	DeriveAddresses(
		ctx context.Context, accountName string, num int,
	) ([]string, error)
	DeriveChangeAddresses(
		ctx context.Context, accountName string, num int,
	) ([]string, error)
	ListAddresses(ctx context.Context, accountName string) ([]string, error)
	GetBalance(
		ctx context.Context, accountName string,
	) (map[string]Balance, error)
	ListUtxos(
		ctx context.Context, accountName string,
	) ([]Utxo, []Utxo, error)
	DeleteAccount(ctx context.Context, accountName string) error
}

type Balance

type Balance interface {
	GetConfirmedBalance() uint64
	GetUnconfirmedBalance() uint64
	GetLockedBalance() uint64
	GetTotalBalance() uint64
}

type BlockInfo

type BlockInfo interface {
	GetHash() string
	GetHeight() uint64
	GetTimestamp() int64
}

type BuildData

type BuildData interface {
	GetVersion() string
	GetCommit() string
	GetDate() string
}

type CustomPeriod

type CustomPeriod interface {
	GetStartDate() string
	GetEndDate() string
}

type Deposit

type Deposit interface {
	GetTxid() string
	GetTotalAmountPerAsset() map[string]uint64
	GetTimestamp() int64
}

type FragmenterReply

type FragmenterReply interface {
	GetMessage() string
	GetError() error
}

type Market

type Market interface {
	GetBaseAsset() string
	GetQuoteAsset() string
}

type MarketCollectedFees

type MarketCollectedFees interface {
	GetBaseAmount() uint64
	GetQuoteAmount() uint64
	GetTradeFeeInfo() []TradeFeeInfo
	GetStartDate() string
	GetEndDate() string
}

type MarketFee

type MarketFee interface {
	GetBaseAsset() uint64
	GetQuoteAsset() uint64
}

type MarketInfo

type MarketInfo interface {
	GetMarket() Market
	GetName() string
	IsTradable() bool
	GetStrategyType() MarketStrategy
	GetBalance() map[string]Balance
	GetPercentageFee() MarketFee
	GetFixedFee() MarketFee
	GetPrice() MarketPrice
	GetBaseAssetPrecision() uint32
	GetQuoteAssetPrecision() uint32
}

type MarketPrice

type MarketPrice interface {
	GetBasePrice() decimal.Decimal
	GetQuotePrice() decimal.Decimal
}

type MarketReport

type MarketReport interface {
	GetMarket() Market
	GetCollectedFees() MarketCollectedFees
	GetTotalVolume() MarketVolume
	GetVolumesPerFrame() []MarketVolume
}

type MarketStrategy

type MarketStrategy interface {
	IsBalanced() bool
	IsPluggable() bool
}

type MarketVolume

type MarketVolume interface {
	GetBaseVolume() uint64
	GetQuoteVolume() uint64
	GetStartDate() string
	GetEndDate() string
}

type Notification

type Notification interface {
	GetTxNotifications() chan WalletTxNotification
	GetUtxoNotifications() chan WalletUtxoNotification
}

type Page

type Page interface {
	GetNumber() int64
	GetSize() int64
}

type PredefinedPeriod

type PredefinedPeriod interface {
	IsLastHour() bool
	IsLastDay() bool
	IsLastWeek() bool
	IsLastMonth() bool
	IsLastThreeMonths() bool
	IsYearToDate() bool
	IsLastYear() bool
	IsAll() bool
}

type PriceFeed

type PriceFeed interface {
	GetMarket() Market
	GetPrice() MarketPrice
}

type PriceFeedInfo

type PriceFeedInfo interface {
	GetId() string
	GetMarket() Market
	GetSource() string
	GetTicker() string
	IsStarted() bool
}

type PriceFeeder

type PriceFeeder interface {
	// AddPriceFeed adds a new price feed for the target market.
	AddPriceFeed(
		ctx context.Context, market Market, source, ticker string,
	) (string, error)
	// StartFeed starts forwarding price feeds from the given source to the
	// target market.
	StartPriceFeed(ctx context.Context, id string) (chan PriceFeed, error)
	// StopFeed stops updating the target price feed.
	StopPriceFeed(ctx context.Context, id string) error
	// UpdatePriceFeed updates an existing price feed.
	UpdatePriceFeed(ctx context.Context, id, source, ticker string) error
	// RemovePriceFeed removes an existing price feed.
	RemovePriceFeed(ctx context.Context, id string) error
	// GetPriceFeed returns info about the target price feed.
	GetPriceFeed(ctx context.Context, id string) (PriceFeedInfo, error)
	// ListPriceFeeds returns the list of price feeds.
	ListPriceFeeds(ctx context.Context) ([]PriceFeedInfo, error)
	// ListSources returns the list of supported price sources.
	ListSources(ctx context.Context) []string

	Close()
}

type PubSubStore

type PubSubStore interface {
	// Init initialize the store with an optional encryption password.
	Init(password string) error
	// IsLocked returns whether the store is locked.
	IsLocked() bool
	// Lock locks the store.
	Lock()
	// UnlockStore unlocks the internal store.
	Unlock(password string) error
	// ChangePassword allows to change the encryption password.
	ChangePassword(oldPwd, newPwd string) error
	// Close should be used to gracefully close the connection with the store.
	Close() error
}

PubSubStore defines the methods to manage the internal store of a SecurePubSub service.

type RepoManager

type RepoManager interface {
	MarketRepository() domain.MarketRepository
	TradeRepository() domain.TradeRepository
	DepositRepository() domain.DepositRepository
	WithdrawalRepository() domain.WithdrawalRepository

	Close()
}

RepoManager interface defines the methods for swap, price and unspent.

type SecurePubSub

type SecurePubSub interface {
	// Store returns the internal store.
	Store() PubSubStore
	// Subscribe adds a new subscription for the requested topic.
	Subscribe(topic, endpoint, secret string) (string, error)
	// SubscribeWithID adds a subscription for the requested topic by using the
	// given id instead of assinging a new one.
	SubscribeWithID(id, topic, endpoint, secret string) (string, error)
	// Unsubscribe removes some client defined by its id for a topic.
	Unsubscribe(topic, id string) error
	// ListSubscriptionsForTopic returns the info of all clients subscribed for
	// a certain topic.
	ListSubscriptionsForTopic(topic string) []Subscription
	// Publish publishes a message for a certain topic. All clients subscribed
	// for such topic will receive the message.
	Publish(topic string, message string) error
}

SecurePubSub defines the methods of a pubsub service and its internal store. This service might need to store some data in memory or on the disk, for this reason along with the typical methods of a pubsub service, allows to manage an internal optionally encrypted storage.

type Subscription

type Subscription interface {
	Topic() string
	Id() string
	IsSecured() bool
	NotifyAt() string
}

type SwapAccept

type SwapAccept interface {
	GetId() string
	GetRequestId() string
	GetTransaction() string
	GetUnblindedInputs() []UnblindedInput
}

type SwapComplete

type SwapComplete interface {
	GetId() string
	GetAcceptId() string
	GetTransaction() string
}

type SwapFail

type SwapFail interface {
	GetId() string
	GetMessageId() string
	GetFailureCode() uint32
	GetFailureMessage() string
}

type SwapRequest

type SwapRequest interface {
	GetId() string
	GetAssetP() string
	GetAmountP() uint64
	GetAssetR() string
	GetAmountR() uint64
	GetTransaction() string
	GetFeeAsset() string
	GetFeeAmount() uint64
	GetUnblindedInputs() []UnblindedInput
}

type TimeRange

type TimeRange interface {
	GetPredefinedPeriod() PredefinedPeriod
	GetCustomPeriod() CustomPeriod
}

type Trade

type Trade interface {
	GetId() string
	GetType() TradeType
	GetStatus() TradeStatus
	GetSwapInfo() SwapRequest
	GetSwapFailInfo() SwapFail
	GetRequestTimestamp() int64
	GetAcceptTimestamp() int64
	GetCompleteTimestamp() int64
	GetSettleTimestamp() int64
	GetExpiryTimestamp() int64
	GetMarket() Market
	GetMarketPercentageFee() MarketFee
	GetMarketFixedFee() MarketFee
	GetMarketPrice() MarketPrice
	GetTxid() string
	GetTxHex() string
	GetFeeAsset() string
	GetFeeAmount() uint64
}

type TradeFeeInfo

type TradeFeeInfo interface {
	GetTradeId() string
	GetPercentageFee() uint64
	GetFixedFee() uint64
	GetFeeAsset() string
	GetFeeAmount() uint64
	GetMarketPrice() decimal.Decimal
	GetTimestamp() int64
}

type TradePreview

type TradePreview interface {
	GetAmount() uint64
	GetAsset() string
	GetMarketPercentageFee() MarketFee
	GetMarketFixedFee() MarketFee
	GetMarketPrice() MarketPrice
	GetFeeAmount() uint64
	GetFeeAsset() string
}

type TradeStatus

type TradeStatus interface {
	IsRequest() bool
	IsAccept() bool
	IsComplete() bool
	IsSettled() bool
	IsExpired() bool
	IsFailed() bool
}

type TradeType

type TradeType interface {
	IsBuy() bool
	IsSell() bool
}

type Transaction

type Transaction interface {
	GetTransaction(ctx context.Context, txid string) (string, error)
	EstimateFees(
		ctx context.Context, ins []TxInput, outs []TxOutput, msatsPerByte uint64,
	) (uint64, error)
	SelectUtxos(
		ctx context.Context, accountName, asset string, amount uint64,
	) ([]Utxo, uint64, int64, error)
	CreatePset(
		ctx context.Context, ins []TxInput, outs []TxOutput,
	) (string, error)
	UpdatePset(
		ctx context.Context, pset string,
		ins []TxInput, outs []TxOutput,
	) (string, error)
	BlindPset(
		ctx context.Context, pset string, extraUnblindedIns []UnblindedInput,
	) (string, error)
	SignPset(
		ctx context.Context, pset string, extractRawTx bool,
	) (string, error)
	Transfer(
		ctx context.Context,
		accountName string, outs []TxOutput, msatsPerByte uint64,
	) (string, error)
	BroadcastTransaction(ctx context.Context, txHex string) (string, error)
}

type TxInput

type TxInput interface {
	UtxoKey
	GetScript() string
	GetScriptSigSize() int
	GetWitnessSize() int
}

type TxOutput

type TxOutput interface {
	GetAsset() string
	GetAmount() uint64
	GetScript() string
	GetBlindingKey() string
}

type UnblindedInput

type UnblindedInput interface {
	GetIndex() uint32
	GetAsset() string
	GetAmount() uint64
	GetAssetBlinder() string
	GetAmountBlinder() string
}

type Utxo

type Utxo interface {
	UtxoKey
	GetAsset() string
	GetValue() uint64
	GetScript() string
	GetAssetBlinder() string
	GetValueBlinder() string
	GetConfirmedStatus() UtxoStatus
	GetSpentStatus() UtxoStatus
	GetRedeemScript() string
}

type UtxoKey

type UtxoKey interface {
	GetTxid() string
	GetIndex() uint32
}

type UtxoStatus

type UtxoStatus interface {
	GetTxid() string
	GetBlockInfo() BlockInfo
}

type Wallet

type Wallet interface {
	GenSeed(ctx context.Context) ([]string, error)
	InitWallet(ctx context.Context, mnemonic []string, password string) error
	RestoreWallet(ctx context.Context, mnemonic []string, password string) error
	Unlock(ctx context.Context, password string) error
	Lock(ctx context.Context, password string) error
	ChangePassword(ctx context.Context, oldPwd, newPwd string) error
	Status(ctx context.Context) (WalletStatus, error)
	Info(ctx context.Context) (WalletInfo, error)
	Auth(ctx context.Context, password string) (bool, error)
}

type WalletAccount

type WalletAccount interface {
	GetNamespace() string
	GetLabel() string
	GetDerivationPath() string
	GetXpubs() []string
	GetMasterBlindingKey() string
}

type WalletInfo

type WalletInfo interface {
	GetNetwork() string
	GetNativeAsset() string
	GetRootPath() string
	GetBirthdayBlockHash() string
	GetBirthdayBlockHeight() uint32
	GetAccounts() []WalletAccount
}

type WalletService

type WalletService interface {
	Wallet() Wallet
	Account() Account
	Transaction() Transaction
	Notification() Notification
	Close()
}

type WalletStatus

type WalletStatus interface {
	IsInitialized() bool
	IsUnlocked() bool
	IsSynced() bool
}

type WalletTxEventType

type WalletTxEventType interface {
	IsUnconfirmed() bool
	IsConfirmed() bool
	IsBroadcasted() bool
}

type WalletTxNotification

type WalletTxNotification interface {
	GetEventType() WalletTxEventType
	GetAccountNames() []string
	GetTxHex() string
	GetBlockDetails() BlockInfo
}

type WalletUtxoEventType

type WalletUtxoEventType interface {
	IsUnconfirmed() bool
	IsConfirmed() bool
	IsLocked() bool
	IsUnlocked() bool
	IsSpent() bool
}

type WalletUtxoNotification

type WalletUtxoNotification interface {
	GetEventType() WalletUtxoEventType
	GetUtxos() []Utxo
}

type Webhook

type Webhook interface {
	GetId() string
	GetEvent() WebhookEvent
	GetEndpoint() string
	GetSecret() string
}

type WebhookEvent

type WebhookEvent interface {
	IsUnspecified() bool
	IsTradeSettled() bool
	IsAccountLowBalance() bool
	IsAccountWithdraw() bool
	IsAccountDeposit() bool
	IsAny() bool
}

type WebhookInfo

type WebhookInfo interface {
	GetId() string
	GetEvent() WebhookEvent
	GetEndpoint() string
	IsSecured() bool
}

type Withdrawal

type Withdrawal interface {
	GetTxid() string
	GetTotalAmountPerAsset() map[string]uint64
	GetTimestamp() int64
}