Documentation ¶
Index ¶
- Variables
- func AccountSeqno(ctx context.Context, g *libkb.GlobalContext, accountID stellar1.AccountID) (uint64, error)
- func AcquireAutoClaimLock(ctx context.Context, g *libkb.GlobalContext) (string, error)
- func Balances(ctx context.Context, g *libkb.GlobalContext, accountID stellar1.AccountID) ([]stellar1.Balance, error)
- func CancelRequest(ctx context.Context, g *libkb.GlobalContext, ...) (err error)
- func Details(ctx context.Context, g *libkb.GlobalContext, accountID stellar1.AccountID) (stellar1.AccountDetails, error)
- func ExchangeRate(ctx context.Context, g *libkb.GlobalContext, currency string) (stellar1.OutsideExchangeRate, error)
- func FetchAccountBundle(mctx libkb.MetaContext, accountID stellar1.AccountID) (bundle *stellar1.Bundle, err error)
- func FetchBundleWithGens(mctx libkb.MetaContext) (b *stellar1.Bundle, pukGen keybase1.PerUserKeyGeneration, ...)
- func FetchSecretlessBundle(mctx libkb.MetaContext) (bundle *stellar1.Bundle, err error)
- func FetchServerConfig(ctx context.Context, g *libkb.GlobalContext) (ret stellar1.StellarServerDefinitions, err error)
- func GetAcceptedDisclaimer(ctx context.Context, g *libkb.GlobalContext) (ret bool, err error)
- func GetAccountDisplayCurrency(ctx context.Context, g *libkb.GlobalContext, accountID stellar1.AccountID) (string, error)
- func GetInflationDestinations(ctx context.Context, g *libkb.GlobalContext) (ret []stellar1.PredefinedInflationDestination, err error)
- func IsAccountMobileOnly(ctx context.Context, g *libkb.GlobalContext, accountID stellar1.AccountID) (bool, error)
- func LookupUnverified(ctx context.Context, g *libkb.GlobalContext, accountID stellar1.AccountID) (ret []keybase1.UserVersion, err error)
- func MakeAccountAllDevices(ctx context.Context, g *libkb.GlobalContext, accountID stellar1.AccountID) error
- func MarkAsRead(ctx context.Context, g *libkb.GlobalContext, accountID stellar1.AccountID, ...) error
- func NextAutoClaim(ctx context.Context, g *libkb.GlobalContext) (*stellar1.AutoClaim, error)
- func PaymentDetails(ctx context.Context, g *libkb.GlobalContext, txID string) (res stellar1.PaymentDetails, err error)
- func PendingPayments(ctx context.Context, g *libkb.GlobalContext, accountID stellar1.AccountID, ...) ([]stellar1.PaymentSummary, error)
- func Post(mctx libkb.MetaContext, clearBundle stellar1.Bundle) (err error)
- func PostWithChainlink(mctx libkb.MetaContext, clearBundle stellar1.Bundle) (err error)
- func RecentPayments(ctx context.Context, g *libkb.GlobalContext, accountID stellar1.AccountID, ...) (stellar1.PaymentsPage, error)
- func ReleaseAutoClaimLock(ctx context.Context, g *libkb.GlobalContext, token string) error
- func RequestDetails(ctx context.Context, g *libkb.GlobalContext, ...) (ret stellar1.RequestDetails, err error)
- func ServerTimeboundsRecommendation(ctx context.Context, g *libkb.GlobalContext) (ret stellar1.TimeboundsRecommendation, err error)
- func SetAcceptedDisclaimer(ctx context.Context, g *libkb.GlobalContext) error
- func SetAccountDefaultCurrency(ctx context.Context, g *libkb.GlobalContext, accountID stellar1.AccountID, ...) error
- func SetAccountMobileOnly(ctx context.Context, g *libkb.GlobalContext, accountID stellar1.AccountID) error
- func SetInflationDestination(ctx context.Context, g *libkb.GlobalContext, signedTx string) (err error)
- func SubmitPayment(ctx context.Context, g *libkb.GlobalContext, post stellar1.PaymentDirectPost) (stellar1.PaymentResult, error)
- func SubmitRelayClaim(ctx context.Context, g *libkb.GlobalContext, post stellar1.RelayClaimPost) (stellar1.RelayClaimResult, error)
- func SubmitRelayPayment(ctx context.Context, g *libkb.GlobalContext, post stellar1.PaymentRelayPost) (stellar1.PaymentResult, error)
- func SubmitRequest(ctx context.Context, g *libkb.GlobalContext, post stellar1.RequestPost) (ret stellar1.KeybaseRequestID, err error)
- type RemoteNet
- func (r *RemoteNet) AccountSeqno(ctx context.Context, accountID stellar1.AccountID) (uint64, error)
- func (r *RemoteNet) AcquireAutoClaimLock(ctx context.Context) (string, error)
- func (r *RemoteNet) Balances(ctx context.Context, accountID stellar1.AccountID) ([]stellar1.Balance, error)
- func (r *RemoteNet) CancelRequest(ctx context.Context, requestID stellar1.KeybaseRequestID) error
- func (r *RemoteNet) Details(ctx context.Context, accountID stellar1.AccountID) (stellar1.AccountDetails, error)
- func (r *RemoteNet) ExchangeRate(ctx context.Context, currency string) (stellar1.OutsideExchangeRate, error)
- func (r *RemoteNet) GetAccountDisplayCurrency(ctx context.Context, accountID stellar1.AccountID) (string, error)
- func (r *RemoteNet) GetInflationDestinations(ctx context.Context) (ret []stellar1.PredefinedInflationDestination, err error)
- func (r *RemoteNet) IsAccountMobileOnly(ctx context.Context, accountID stellar1.AccountID) (bool, error)
- func (r *RemoteNet) MakeAccountAllDevices(ctx context.Context, accountID stellar1.AccountID) error
- func (r *RemoteNet) MarkAsRead(ctx context.Context, accountID stellar1.AccountID, ...) error
- func (r *RemoteNet) NextAutoClaim(ctx context.Context) (*stellar1.AutoClaim, error)
- func (r *RemoteNet) PaymentDetails(ctx context.Context, txID string) (res stellar1.PaymentDetails, err error)
- func (r *RemoteNet) PendingPayments(ctx context.Context, accountID stellar1.AccountID, limit int) ([]stellar1.PaymentSummary, error)
- func (r *RemoteNet) RecentPayments(ctx context.Context, accountID stellar1.AccountID, cursor *stellar1.PageCursor, ...) (stellar1.PaymentsPage, error)
- func (r *RemoteNet) ReleaseAutoClaimLock(ctx context.Context, token string) error
- func (r *RemoteNet) RequestDetails(ctx context.Context, requestID stellar1.KeybaseRequestID) (stellar1.RequestDetails, error)
- func (r *RemoteNet) ServerTimeboundsRecommendation(ctx context.Context) (stellar1.TimeboundsRecommendation, error)
- func (r *RemoteNet) SetAccountMobileOnly(ctx context.Context, accountID stellar1.AccountID) error
- func (r *RemoteNet) SetInflationDestination(ctx context.Context, signedTx string) error
- func (r *RemoteNet) SubmitPayment(ctx context.Context, post stellar1.PaymentDirectPost) (stellar1.PaymentResult, error)
- func (r *RemoteNet) SubmitRelayClaim(ctx context.Context, post stellar1.RelayClaimPost) (stellar1.RelayClaimResult, error)
- func (r *RemoteNet) SubmitRelayPayment(ctx context.Context, post stellar1.PaymentRelayPost) (stellar1.PaymentResult, error)
- func (r *RemoteNet) SubmitRequest(ctx context.Context, post stellar1.RequestPost) (stellar1.KeybaseRequestID, error)
- type Remoter
- type ShouldCreateResult
Constants ¶
This section is empty.
Variables ¶
var ErrAccountIDMissing = errors.New("account id parameter missing")
Functions ¶
func AccountSeqno ¶ added in v1.0.48
func AcquireAutoClaimLock ¶
func CancelRequest ¶
func CancelRequest(ctx context.Context, g *libkb.GlobalContext, requestID stellar1.KeybaseRequestID) (err error)
func Details ¶
func Details(ctx context.Context, g *libkb.GlobalContext, accountID stellar1.AccountID) (stellar1.AccountDetails, error)
func ExchangeRate ¶ added in v1.0.48
func ExchangeRate(ctx context.Context, g *libkb.GlobalContext, currency string) (stellar1.OutsideExchangeRate, error)
func FetchAccountBundle ¶
func FetchAccountBundle(mctx libkb.MetaContext, accountID stellar1.AccountID) (bundle *stellar1.Bundle, err error)
FetchAccountBundle gets a bundle from the server with all of the accounts in it, but it will only have the secrets for the specified accountID. This method will bubble up an error if it's called by a Desktop device for an account that is mobile only. If you don't need the secrets, use FetchSecretlessBundle instead.
func FetchBundleWithGens ¶
func FetchBundleWithGens(mctx libkb.MetaContext) (b *stellar1.Bundle, pukGen keybase1.PerUserKeyGeneration, accountGens bundle.AccountPukGens, err error)
FetchBundleWithGens gets a bundle with all of the secrets in it to which this device has access, i.e. if there are no mobile-only accounts, then this bundle will have all of the secrets. Also returned is a map of accountID->pukGen. Entries are only in the map for accounts with secrets in the bundle. Inaccessible accounts will be in the visible part of the parent bundle but not in the AccountBundle secrets nor in the AccountPukGens map. FetchBundleWithGens is only for very specific usecases. FetchAccountBundle and FetchSecretlessBundle are the preferred ways to pull a bundle.
func FetchSecretlessBundle ¶
func FetchSecretlessBundle(mctx libkb.MetaContext) (bundle *stellar1.Bundle, err error)
FetchSecretlessBundle gets an account bundle from the server and decrypts it but without any specified AccountID and therefore no secrets (signers). This method is safe to be called by any of a user's devices even if one or more of the accounts is marked as mobile only.
func FetchServerConfig ¶
func FetchServerConfig(ctx context.Context, g *libkb.GlobalContext) (ret stellar1.StellarServerDefinitions, err error)
func GetAcceptedDisclaimer ¶
func GetAccountDisplayCurrency ¶ added in v1.0.48
func GetInflationDestinations ¶
func GetInflationDestinations(ctx context.Context, g *libkb.GlobalContext) (ret []stellar1.PredefinedInflationDestination, err error)
func IsAccountMobileOnly ¶
func LookupUnverified ¶
func LookupUnverified(ctx context.Context, g *libkb.GlobalContext, accountID stellar1.AccountID) (ret []keybase1.UserVersion, err error)
func MakeAccountAllDevices ¶
func MakeAccountAllDevices(ctx context.Context, g *libkb.GlobalContext, accountID stellar1.AccountID) error
MakeAccountAllDevices will fetch the account bundle and flip the mobile-only switch to off (so that any device can get the account secret keys) then send the new account bundle to the server.
func MarkAsRead ¶
func MarkAsRead(ctx context.Context, g *libkb.GlobalContext, accountID stellar1.AccountID, mostRecentID stellar1.TransactionID) error
func NextAutoClaim ¶
func PaymentDetails ¶
func PaymentDetails(ctx context.Context, g *libkb.GlobalContext, txID string) (res stellar1.PaymentDetails, err error)
func PendingPayments ¶
func PendingPayments(ctx context.Context, g *libkb.GlobalContext, accountID stellar1.AccountID, limit int) ([]stellar1.PaymentSummary, error)
func Post ¶
func Post(mctx libkb.MetaContext, clearBundle stellar1.Bundle) (err error)
Post a bundle to the server.
func PostWithChainlink ¶
func PostWithChainlink(mctx libkb.MetaContext, clearBundle stellar1.Bundle) (err error)
Post a bundle to the server with a chainlink.
func RecentPayments ¶ added in v1.0.48
func RecentPayments(ctx context.Context, g *libkb.GlobalContext, accountID stellar1.AccountID, cursor *stellar1.PageCursor, limit int, skipPending bool) (stellar1.PaymentsPage, error)
func ReleaseAutoClaimLock ¶
func RequestDetails ¶
func RequestDetails(ctx context.Context, g *libkb.GlobalContext, requestID stellar1.KeybaseRequestID) (ret stellar1.RequestDetails, err error)
func ServerTimeboundsRecommendation ¶
func ServerTimeboundsRecommendation(ctx context.Context, g *libkb.GlobalContext) (ret stellar1.TimeboundsRecommendation, err error)
func SetAcceptedDisclaimer ¶
func SetAcceptedDisclaimer(ctx context.Context, g *libkb.GlobalContext) error
func SetAccountDefaultCurrency ¶ added in v1.0.48
func SetAccountMobileOnly ¶
func SetAccountMobileOnly(ctx context.Context, g *libkb.GlobalContext, accountID stellar1.AccountID) error
SetAccountMobileOnly will fetch the account bundle and flip the mobile-only switch, then send the new account bundle revision to the server.
func SetInflationDestination ¶
func SubmitPayment ¶ added in v1.0.48
func SubmitPayment(ctx context.Context, g *libkb.GlobalContext, post stellar1.PaymentDirectPost) (stellar1.PaymentResult, error)
func SubmitRelayClaim ¶
func SubmitRelayClaim(ctx context.Context, g *libkb.GlobalContext, post stellar1.RelayClaimPost) (stellar1.RelayClaimResult, error)
func SubmitRelayPayment ¶ added in v1.0.48
func SubmitRelayPayment(ctx context.Context, g *libkb.GlobalContext, post stellar1.PaymentRelayPost) (stellar1.PaymentResult, error)
func SubmitRequest ¶
func SubmitRequest(ctx context.Context, g *libkb.GlobalContext, post stellar1.RequestPost) (ret stellar1.KeybaseRequestID, err error)
Types ¶
type RemoteNet ¶ added in v1.0.48
type RemoteNet struct {
libkb.Contextified
}
RemoteNet is the real implementation of Remoter that talks to servers.
func NewRemoteNet ¶ added in v1.0.48
func NewRemoteNet(g *libkb.GlobalContext) *RemoteNet
func (*RemoteNet) AccountSeqno ¶ added in v1.0.48
func (*RemoteNet) AcquireAutoClaimLock ¶
func (*RemoteNet) CancelRequest ¶
func (*RemoteNet) ExchangeRate ¶
func (*RemoteNet) GetAccountDisplayCurrency ¶
func (*RemoteNet) GetInflationDestinations ¶
func (*RemoteNet) IsAccountMobileOnly ¶
func (*RemoteNet) MakeAccountAllDevices ¶
func (*RemoteNet) MarkAsRead ¶
func (*RemoteNet) NextAutoClaim ¶
func (*RemoteNet) PaymentDetails ¶
func (*RemoteNet) PendingPayments ¶
func (*RemoteNet) RecentPayments ¶ added in v1.0.48
func (*RemoteNet) ReleaseAutoClaimLock ¶
func (*RemoteNet) RequestDetails ¶
func (r *RemoteNet) RequestDetails(ctx context.Context, requestID stellar1.KeybaseRequestID) (stellar1.RequestDetails, error)
func (*RemoteNet) ServerTimeboundsRecommendation ¶
func (*RemoteNet) SetAccountMobileOnly ¶
func (*RemoteNet) SetInflationDestination ¶
func (*RemoteNet) SubmitPayment ¶ added in v1.0.48
func (r *RemoteNet) SubmitPayment(ctx context.Context, post stellar1.PaymentDirectPost) (stellar1.PaymentResult, error)
func (*RemoteNet) SubmitRelayClaim ¶
func (r *RemoteNet) SubmitRelayClaim(ctx context.Context, post stellar1.RelayClaimPost) (stellar1.RelayClaimResult, error)
func (*RemoteNet) SubmitRelayPayment ¶ added in v1.0.48
func (r *RemoteNet) SubmitRelayPayment(ctx context.Context, post stellar1.PaymentRelayPost) (stellar1.PaymentResult, error)
func (*RemoteNet) SubmitRequest ¶
func (r *RemoteNet) SubmitRequest(ctx context.Context, post stellar1.RequestPost) (stellar1.KeybaseRequestID, error)
type Remoter ¶ added in v1.0.48
type Remoter interface { AccountSeqno(ctx context.Context, accountID stellar1.AccountID) (uint64, error) Balances(ctx context.Context, accountID stellar1.AccountID) ([]stellar1.Balance, error) Details(ctx context.Context, accountID stellar1.AccountID) (stellar1.AccountDetails, error) SubmitPayment(ctx context.Context, post stellar1.PaymentDirectPost) (stellar1.PaymentResult, error) SubmitRelayPayment(ctx context.Context, post stellar1.PaymentRelayPost) (stellar1.PaymentResult, error) SubmitRelayClaim(context.Context, stellar1.RelayClaimPost) (stellar1.RelayClaimResult, error) AcquireAutoClaimLock(context.Context) (string, error) ReleaseAutoClaimLock(context.Context, string) error NextAutoClaim(context.Context) (*stellar1.AutoClaim, error) RecentPayments(ctx context.Context, accountID stellar1.AccountID, cursor *stellar1.PageCursor, limit int, skipPending bool) (stellar1.PaymentsPage, error) PendingPayments(ctx context.Context, accountID stellar1.AccountID, limit int) ([]stellar1.PaymentSummary, error) PaymentDetails(ctx context.Context, txID string) (res stellar1.PaymentDetails, err error) GetAccountDisplayCurrency(ctx context.Context, accountID stellar1.AccountID) (string, error) ExchangeRate(ctx context.Context, currency string) (stellar1.OutsideExchangeRate, error) SubmitRequest(ctx context.Context, post stellar1.RequestPost) (stellar1.KeybaseRequestID, error) RequestDetails(ctx context.Context, requestID stellar1.KeybaseRequestID) (stellar1.RequestDetails, error) CancelRequest(ctx context.Context, requestID stellar1.KeybaseRequestID) error MarkAsRead(ctx context.Context, accountID stellar1.AccountID, mostRecentID stellar1.TransactionID) error IsAccountMobileOnly(ctx context.Context, accountID stellar1.AccountID) (bool, error) SetAccountMobileOnly(ctx context.Context, accountID stellar1.AccountID) error MakeAccountAllDevices(ctx context.Context, accountID stellar1.AccountID) error ServerTimeboundsRecommendation(ctx context.Context) (stellar1.TimeboundsRecommendation, error) SetInflationDestination(ctx context.Context, signedTx string) error GetInflationDestinations(ctx context.Context) (ret []stellar1.PredefinedInflationDestination, err error) }
type ShouldCreateResult ¶
type ShouldCreateResult struct { ShouldCreate bool `json:"shouldcreate"` HasWallet bool `json:"haswallet"` AcceptedDisclaimer bool `json:"accepteddisclaimer"` }
func ShouldCreate ¶
func ShouldCreate(ctx context.Context, g *libkb.GlobalContext) (res ShouldCreateResult, err error)
ShouldCreate asks the server whether to create this user's initial wallet.