client

type AccountResolution int

type Client interface {
	// CreateAccount creates a kin account.
	CreateAccount(ctx context.Context, key PrivateKey, opts ...SolanaOption) (err error)

	// GetBalance returns the balance of a kin account in quarks.
	//
	// ErrAccountDoesNotExist is returned if no account exists.
	GetBalance(ctx context.Context, account PublicKey, opts ...SolanaOption) (quarks int64, err error)

	// ResolveTokenAccounts resolves the token accounts owned by an account on Kin 4.
	ResolveTokenAccounts(ctx context.Context, account PublicKey) ([]PublicKey, error)

	// GetTransaction returns the TransactionData for a given transaction hash.
	//
	// ErrTransactionNotFound is returned if no transaction exists for the hash.
	GetTransaction(ctx context.Context, txHash []byte, opts ...SolanaOption) (data TransactionData, err error)

	// SubmitPayment submits a single payment to a specified kin account.
	SubmitPayment(ctx context.Context, payment Payment, opts ...SolanaOption) (txHash []byte, err error)

	// SubmitEarnBatch submits a batch of earn payments.
	//
	// The batch may be done in on or more transactions.
	SubmitEarnBatch(ctx context.Context, batch EarnBatch, opts ...SolanaOption) (result EarnBatchResult, err error)
}

type ClientOption func(*clientOpts)

type Earn struct {
	Destination PublicKey
	Quarks      int64
	Invoice     *commonpb.Invoice
}

type EarnBatch struct {
	Sender  PrivateKey
	Channel *PrivateKey

	Memo string

	Earns []Earn

	// If DedupeID is set, the service will check to see if a transaction
	// was previously submitted with the same DedupeID. If one is found,
	// it will NOT submit the transaction again, and will return the status
	// of the previously submitted transaction.
	//
	// Only available on Kin 4.
	DedupeID []byte
}

type EarnBatchResult struct {
	TxID []byte

	// If TxError is defined, the transaction failed.
	TxError error

	// EarnErrors contains any available earn-specific error information.
	//
	// EarnErrors may or may not be set if TxError is set.
	EarnErrors []EarnError
}

type EarnError struct {
	EarnIndex int
	Error     error
}

type Environment string

type EventsFunc func([]events.Event) error

type InternalClient struct {
	// contains filtered or unexported fields
}

type Payment struct {
	Sender      PrivateKey
	Destination PublicKey
	Type        kin.TransactionType
	Quarks      int64

	Channel *PrivateKey

	Invoice *commonpb.Invoice
	Memo    string

	// If DedupeID is set, the service will check to see if a transaction
	// was previously submitted with the same DedupeID. If one is found,
	// it will NOT submit the transaction again, and will return the status
	// of the previously submitted transaction.
	//
	// Only available on Kin 4.
	DedupeID []byte
}

type PrivateKey ed25519.PrivateKey

type PublicKey ed25519.PublicKey

type ReadOnlyPayment struct {
	Sender      PublicKey
	Destination PublicKey
	Type        kin.TransactionType
	Quarks      int64

	Invoice *commonpb.Invoice
	Memo    string
}

type SignTransactionFunc func(SignTransactionRequest, *SignTransactionResponse) error

type SignTransactionRequest struct {
	// The Kin Version provided by the client (optional)
	// The UserID provided by the client (optional).
	UserID string
	// The UserPassKey provided by the client (optional).
	UserPasskey string

	// Payments is a set of payments that a client wishes to be signed.
	Payments []ReadOnlyPayment

	// Envelope is included _only_ for further validation by SDK consumers,
	// which is optional.
	//
	// It will only be set on stellar based transactions, and is _not_ a stable API.
	Envelope *xdr.TransactionEnvelope

	// SolanaTransaction is included _only_ for further validation by SDK consumers,
	// which is optional.
	//
	// It will only be set on Solana-based transactions, and is _not_ a stable API.
	SolanaTransaction *solana.Transaction
	// contains filtered or unexported fields
}

type SignTransactionResponse struct {
	// contains filtered or unexported fields
}

type SolanaOption func(opts *solanaOpts)

type SubmitTransactionResult struct {
	ID            []byte
	Errors        TransactionErrors
	InvoiceErrors []*commonpb.InvoiceError
}

type TransactionData struct {
	TxID     []byte
	TxState  TransactionState
	Payments []ReadOnlyPayment
	Errors   TransactionErrors
}

type TransactionErrors struct {
	TxError error

	// OpErrors may or may not be set if TxErrors is set. The length of
	// OpErrors will match the number of operations/instructions in the transaction.
	OpErrors []error

	// PaymentErrors may or may not be set if TxErrors is set. If set, the length of
	// PaymentErrors will match the number of payments/transfers in the transaction.
	PaymentErrors []error
}

type TransactionState int