transports

package

Go to main page

Versions in this module

v1

v1.0.0-beta.2

Apr 25, 2024

v1.0.0-beta.1

Apr 23, 2024

v0

v0.10.0

Apr 9, 2024

Changes in this version

+ type ContactService interface

+ AcceptContact func(ctx context.Context, paymail string) ResponseError

+ ConfirmContact func(ctx context.Context, paymail string) ResponseError

+ GetContacts func(ctx context.Context, conditions map[string]interface{}, ...) ([]*models.Contact, ResponseError)

+ RejectContact func(ctx context.Context, paymail string) ResponseError

+ UpsertContact func(ctx context.Context, paymail, fullName string, metadata *models.Metadata, ...) (*models.Contact, ResponseError)

type TransportHTTP

+ func (h *TransportHTTP) AcceptContact(ctx context.Context, paymail string) ResponseError

+ func (h *TransportHTTP) ConfirmContact(ctx context.Context, paymail string) ResponseError

+ func (h *TransportHTTP) GetContacts(ctx context.Context, conditions map[string]interface{}, ...) ([]*models.Contact, ResponseError)

+ func (h *TransportHTTP) RejectContact(ctx context.Context, paymail string) ResponseError

+ func (h *TransportHTTP) UpsertContact(ctx context.Context, paymail, fullName string, metadata *models.Metadata, ...) (*models.Contact, ResponseError)

v0.9.0

Mar 26, 2024

Changes in this version

+ func GetSignedHex(dt *models.DraftTransaction, xPriv *bip32.ExtendedKey) (signedHex string, err error)

v0.8.0

Mar 19, 2024

v0.7.0

Mar 13, 2024

Changes in this version

type AdminService

+ AdminGetSharedConfig func(ctx context.Context) (*models.SharedConfig, ResponseError)

type TransportHTTP

+ func (h *TransportHTTP) AdminGetSharedConfig(ctx context.Context) (*models.SharedConfig, ResponseError)

v0.6.0

Feb 26, 2024

Changes in this version

type AdminService

+ AdminNewXpub func(ctx context.Context, rawXPub string, metadata *models.Metadata) ResponseError

type TransportHTTP

+ func (h *TransportHTTP) AdminNewXpub(ctx context.Context, rawXPub string, metadata *models.Metadata) ResponseError

v0.5.0

Feb 22, 2024

Changes in this version

+ const FieldAddress

+ const FieldAvatar

+ const FieldConditions

+ const FieldConfig

+ const FieldHex

+ const FieldID

+ const FieldLockingScript

+ const FieldMetadata

+ const FieldOpReturn

+ const FieldOutputIndex

+ const FieldOutputs

+ const FieldPublicName

+ const FieldQueryParams

+ const FieldReferenceID

+ const FieldSatoshis

+ const FieldTo

+ const FieldTransactionConfig

+ const FieldTransactionID

+ const FieldUserAgent

+ const FieldXpubID

+ const FieldXpubKey

+ const SPVWalletUserAgent

+ var ErrAdminKey = errors.New("an admin key must be set to be able to create an xpub")

+ var ErrNoClientSet = errors.New("no transport client set")

+ type AccessKeyService interface

+ CreateAccessKey func(ctx context.Context, metadata *models.Metadata) (*models.AccessKey, ResponseError)

+ GetAccessKey func(ctx context.Context, id string) (*models.AccessKey, ResponseError)

+ GetAccessKeys func(ctx context.Context, metadataConditions *models.Metadata) ([]*models.AccessKey, ResponseError)

+ GetAccessKeysCount func(ctx context.Context, conditions map[string]interface{}, ...) (int64, ResponseError)

+ RevokeAccessKey func(ctx context.Context, id string) (*models.AccessKey, ResponseError)

+ type AdminService interface

+ AdminCreatePaymail func(ctx context.Context, xPubID string, address string, publicName string, ...) (*models.PaymailAddress, ResponseError)

+ AdminDeletePaymail func(ctx context.Context, address string) (*models.PaymailAddress, ResponseError)

+ AdminGetAccessKeys func(ctx context.Context, conditions map[string]interface{}, ...) ([]*models.AccessKey, ResponseError)

+ AdminGetAccessKeysCount func(ctx context.Context, conditions map[string]interface{}, ...) (int64, ResponseError)

+ AdminGetBlockHeaders func(ctx context.Context, conditions map[string]interface{}, ...) ([]*models.BlockHeader, ResponseError)

+ AdminGetBlockHeadersCount func(ctx context.Context, conditions map[string]interface{}, ...) (int64, ResponseError)

+ AdminGetDestinations func(ctx context.Context, conditions map[string]interface{}, ...) ([]*models.Destination, ResponseError)

+ AdminGetDestinationsCount func(ctx context.Context, conditions map[string]interface{}, ...) (int64, ResponseError)

+ AdminGetPaymail func(ctx context.Context, address string) (*models.PaymailAddress, ResponseError)

+ AdminGetPaymails func(ctx context.Context, conditions map[string]interface{}, ...) ([]*models.PaymailAddress, ResponseError)

+ AdminGetPaymailsCount func(ctx context.Context, conditions map[string]interface{}, ...) (int64, ResponseError)

+ AdminGetStats func(ctx context.Context) (*models.AdminStats, ResponseError)

+ AdminGetStatus func(ctx context.Context) (bool, ResponseError)

+ AdminGetTransactions func(ctx context.Context, conditions map[string]interface{}, ...) ([]*models.Transaction, ResponseError)

+ AdminGetTransactionsCount func(ctx context.Context, conditions map[string]interface{}, ...) (int64, ResponseError)

+ AdminGetUtxos func(ctx context.Context, conditions map[string]interface{}, ...) ([]*models.Utxo, ResponseError)

+ AdminGetUtxosCount func(ctx context.Context, conditions map[string]interface{}, ...) (int64, ResponseError)

+ AdminGetXPubs func(ctx context.Context, conditions map[string]interface{}, ...) ([]*models.Xpub, ResponseError)

+ AdminGetXPubsCount func(ctx context.Context, conditions map[string]interface{}, ...) (int64, ResponseError)

+ AdminRecordTransaction func(ctx context.Context, hex string) (*models.Transaction, ResponseError)

+ type Client struct

+ type ClientOps func(c *Client)

+ func WithAccessKey(accessKey *bec.PrivateKey) ClientOps

+ func WithAdminKey(adminKey string) ClientOps

+ func WithHTTP(serverURL string) ClientOps

+ func WithHTTPClient(serverURL string, httpClient *http.Client) ClientOps

+ func WithSignRequest(signRequest bool) ClientOps

+ func WithXPriv(xPriv *bip32.ExtendedKey) ClientOps

+ func WithXPub(xPub *bip32.ExtendedKey) ClientOps

+ type DestinationService interface

+ GetDestinationByAddress func(ctx context.Context, address string) (*models.Destination, ResponseError)

+ GetDestinationByID func(ctx context.Context, id string) (*models.Destination, ResponseError)

+ GetDestinationByLockingScript func(ctx context.Context, lockingScript string) (*models.Destination, ResponseError)

+ GetDestinations func(ctx context.Context, metadataConditions *models.Metadata) ([]*models.Destination, ResponseError)

+ GetDestinationsCount func(ctx context.Context, conditions map[string]interface{}, ...) (int64, ResponseError)

+ NewDestination func(ctx context.Context, metadata *models.Metadata) (*models.Destination, ResponseError)

+ UpdateDestinationMetadataByAddress func(ctx context.Context, lockingScript string, metadata *models.Metadata) (*models.Destination, ResponseError)

+ UpdateDestinationMetadataByID func(ctx context.Context, id string, metadata *models.Metadata) (*models.Destination, ResponseError)

+ UpdateDestinationMetadataByLockingScript func(ctx context.Context, address string, metadata *models.Metadata) (*models.Destination, ResponseError)

+ type PaymailService interface

+ DeletePaymail func(ctx context.Context, paymailAddress string) ResponseError

+ NewPaymail func(ctx context.Context, rawXpub, paymailAddress, avatar, publicName string, ...) ResponseError

+ type QueryParams struct

+ OrderByField string

+ Page int

+ PageSize int

+ SortDirection string

+ type Recipients struct

+ OpReturn *models.OpReturn

+ Satoshis uint64

+ To string

+ type ResError struct

+ Message string

+ StatusCode int

+ func (e *ResError) Error() string

+ func (e *ResError) GetStatusCode() int

+ type ResponseError interface

+ Error func() string

+ GetStatusCode func() int

+ func SetSignatureFromAccessKey(header *http.Header, privateKeyHex, bodyString string) ResponseError

+ func SignInputs(dt *models.DraftTransaction, xPriv *bip32.ExtendedKey) (signedHex string, resError ResponseError)

+ func WrapError(err error) ResponseError

+ func WrapResponseError(res *http.Response) ResponseError

+ type TransactionService interface

+ DraftToRecipients func(ctx context.Context, recipients []*Recipients, metadata *models.Metadata) (*models.DraftTransaction, ResponseError)

+ DraftTransaction func(ctx context.Context, transactionConfig *models.TransactionConfig, ...) (*models.DraftTransaction, ResponseError)

+ GetTransaction func(ctx context.Context, txID string) (*models.Transaction, ResponseError)

+ GetTransactions func(ctx context.Context, conditions map[string]interface{}, ...) ([]*models.Transaction, ResponseError)

+ GetTransactionsCount func(ctx context.Context, conditions map[string]interface{}, ...) (int64, ResponseError)

+ GetUtxo func(ctx context.Context, txID string, outputIndex uint32) (*models.Utxo, ResponseError)

+ GetUtxos func(ctx context.Context, conditions map[string]interface{}, ...) ([]*models.Utxo, ResponseError)

+ GetUtxosCount func(ctx context.Context, conditions map[string]interface{}, ...) (int64, ResponseError)

+ RecordTransaction func(ctx context.Context, hex, referenceID string, metadata *models.Metadata) (*models.Transaction, ResponseError)

+ UpdateTransactionMetadata func(ctx context.Context, txID string, metadata *models.Metadata) (*models.Transaction, ResponseError)

+ type TransportHTTP struct

+ func (h *TransportHTTP) AdminCreatePaymail(ctx context.Context, xPubID string, address string, publicName string, ...) (*models.PaymailAddress, ResponseError)

+ func (h *TransportHTTP) AdminDeletePaymail(ctx context.Context, address string) (*models.PaymailAddress, ResponseError)

+ func (h *TransportHTTP) AdminGetAccessKeys(ctx context.Context, conditions map[string]interface{}, ...) ([]*models.AccessKey, ResponseError)

+ func (h *TransportHTTP) AdminGetAccessKeysCount(ctx context.Context, conditions map[string]interface{}, ...) (int64, ResponseError)

+ func (h *TransportHTTP) AdminGetBlockHeaders(ctx context.Context, conditions map[string]interface{}, ...) ([]*models.BlockHeader, ResponseError)

+ func (h *TransportHTTP) AdminGetBlockHeadersCount(ctx context.Context, conditions map[string]interface{}, ...) (int64, ResponseError)

+ func (h *TransportHTTP) AdminGetDestinations(ctx context.Context, conditions map[string]interface{}, ...) ([]*models.Destination, ResponseError)

+ func (h *TransportHTTP) AdminGetDestinationsCount(ctx context.Context, conditions map[string]interface{}, ...) (int64, ResponseError)

+ func (h *TransportHTTP) AdminGetPaymail(ctx context.Context, address string) (*models.PaymailAddress, ResponseError)

+ func (h *TransportHTTP) AdminGetPaymails(ctx context.Context, conditions map[string]interface{}, ...) ([]*models.PaymailAddress, ResponseError)

+ func (h *TransportHTTP) AdminGetPaymailsCount(ctx context.Context, conditions map[string]interface{}, ...) (int64, ResponseError)

+ func (h *TransportHTTP) AdminGetStats(ctx context.Context) (*models.AdminStats, ResponseError)

+ func (h *TransportHTTP) AdminGetStatus(ctx context.Context) (bool, ResponseError)

+ func (h *TransportHTTP) AdminGetTransactions(ctx context.Context, conditions map[string]interface{}, ...) ([]*models.Transaction, ResponseError)

+ func (h *TransportHTTP) AdminGetTransactionsCount(ctx context.Context, conditions map[string]interface{}, ...) (int64, ResponseError)

+ func (h *TransportHTTP) AdminGetUtxos(ctx context.Context, conditions map[string]interface{}, ...) ([]*models.Utxo, ResponseError)

+ func (h *TransportHTTP) AdminGetUtxosCount(ctx context.Context, conditions map[string]interface{}, ...) (int64, ResponseError)

+ func (h *TransportHTTP) AdminGetXPubs(ctx context.Context, conditions map[string]interface{}, ...) ([]*models.Xpub, ResponseError)

+ func (h *TransportHTTP) AdminGetXPubsCount(ctx context.Context, conditions map[string]interface{}, ...) (int64, ResponseError)

+ func (h *TransportHTTP) AdminRecordTransaction(ctx context.Context, hex string) (*models.Transaction, ResponseError)

+ func (h *TransportHTTP) CreateAccessKey(ctx context.Context, metadata *models.Metadata) (*models.AccessKey, ResponseError)

+ func (h *TransportHTTP) DeletePaymail(ctx context.Context, paymailAddress string) ResponseError

+ func (h *TransportHTTP) DraftToRecipients(ctx context.Context, recipients []*Recipients, metadata *models.Metadata) (*models.DraftTransaction, ResponseError)

+ func (h *TransportHTTP) DraftTransaction(ctx context.Context, transactionConfig *models.TransactionConfig, ...) (*models.DraftTransaction, ResponseError)

+ func (h *TransportHTTP) GetAccessKey(ctx context.Context, id string) (*models.AccessKey, ResponseError)

+ func (h *TransportHTTP) GetAccessKeys(ctx context.Context, metadataConditions *models.Metadata) ([]*models.AccessKey, ResponseError)

+ func (h *TransportHTTP) GetAccessKeysCount(ctx context.Context, conditions map[string]interface{}, ...) (int64, ResponseError)

+ func (h *TransportHTTP) GetDestinationByAddress(ctx context.Context, address string) (*models.Destination, ResponseError)

+ func (h *TransportHTTP) GetDestinationByID(ctx context.Context, id string) (*models.Destination, ResponseError)

+ func (h *TransportHTTP) GetDestinationByLockingScript(ctx context.Context, lockingScript string) (*models.Destination, ResponseError)

+ func (h *TransportHTTP) GetDestinations(ctx context.Context, metadataConditions *models.Metadata) ([]*models.Destination, ResponseError)

+ func (h *TransportHTTP) GetDestinationsCount(ctx context.Context, conditions map[string]interface{}, ...) (int64, ResponseError)

+ func (h *TransportHTTP) GetTransaction(ctx context.Context, txID string) (*models.Transaction, ResponseError)

+ func (h *TransportHTTP) GetTransactions(ctx context.Context, conditions map[string]interface{}, ...) ([]*models.Transaction, ResponseError)

+ func (h *TransportHTTP) GetTransactionsCount(ctx context.Context, conditions map[string]interface{}, ...) (int64, ResponseError)

+ func (h *TransportHTTP) GetUtxo(ctx context.Context, txID string, outputIndex uint32) (*models.Utxo, ResponseError)

+ func (h *TransportHTTP) GetUtxos(ctx context.Context, conditions map[string]interface{}, ...) ([]*models.Utxo, ResponseError)

+ func (h *TransportHTTP) GetUtxosCount(ctx context.Context, conditions map[string]interface{}, ...) (int64, ResponseError)

+ func (h *TransportHTTP) GetXPub(ctx context.Context) (*models.Xpub, ResponseError)

+ func (h *TransportHTTP) Init() error

+ func (h *TransportHTTP) IsSignRequest() bool

+ func (h *TransportHTTP) NewDestination(ctx context.Context, metadata *models.Metadata) (*models.Destination, ResponseError)

+ func (h *TransportHTTP) NewPaymail(ctx context.Context, rawXpub, paymailAddress, avatar, publicName string, ...) ResponseError

+ func (h *TransportHTTP) NewXpub(ctx context.Context, rawXPub string, metadata *models.Metadata) ResponseError

+ func (h *TransportHTTP) RecordTransaction(ctx context.Context, hex, referenceID string, metadata *models.Metadata) (*models.Transaction, ResponseError)

+ func (h *TransportHTTP) RegisterXpub(ctx context.Context, rawXPub string, metadata *models.Metadata) ResponseError

+ func (h *TransportHTTP) RevokeAccessKey(ctx context.Context, id string) (*models.AccessKey, ResponseError)

+ func (h *TransportHTTP) SetAdminKey(adminKey *bip32.ExtendedKey)

+ func (h *TransportHTTP) SetSignRequest(signRequest bool)

+ func (h *TransportHTTP) UpdateDestinationMetadataByAddress(ctx context.Context, address string, metadata *models.Metadata) (*models.Destination, ResponseError)

+ func (h *TransportHTTP) UpdateDestinationMetadataByID(ctx context.Context, id string, metadata *models.Metadata) (*models.Destination, ResponseError)

+ func (h *TransportHTTP) UpdateDestinationMetadataByLockingScript(ctx context.Context, lockingScript string, metadata *models.Metadata) (*models.Destination, ResponseError)

+ func (h *TransportHTTP) UpdateTransactionMetadata(ctx context.Context, txID string, metadata *models.Metadata) (*models.Transaction, ResponseError)

+ func (h *TransportHTTP) UpdateXPubMetadata(ctx context.Context, metadata *models.Metadata) (*models.Xpub, ResponseError)

+ type TransportService interface

+ Init func() error

+ IsSignRequest func() bool

+ SetAdminKey func(adminKey *bip32.ExtendedKey)

+ SetSignRequest func(signRequest bool)

+ func NewTransport(opts ...ClientOps) (TransportService, error)

+ func NewTransportService(transportService TransportService) TransportService

+ type TransportType string

+ const SPVWalletTransportHTTP

+ const SPVWalletTransportMock

+ type XpubService interface

+ GetXPub func(ctx context.Context) (*models.Xpub, ResponseError)

+ NewXpub func(ctx context.Context, rawXPub string, metadata *models.Metadata) ResponseError

+ RegisterXpub func(ctx context.Context, rawXPub string, metadata *models.Metadata) ResponseError

+ UpdateXPubMetadata func(ctx context.Context, metadata *models.Metadata) (*models.Xpub, ResponseError)

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