lbrynet

Documentation

Index

• Variables
• func AddWallet(uid int) (*ljsonrpc.Wallet, error)
• func CreateAccount(UID int) (*ljsonrpc.Account, error)
• func CreateWallet(uid int) (*ljsonrpc.Wallet, error)
• func GetAccount(uid int) (*ljsonrpc.Account, error)
• func InitializeWallet(uid int) (string, error)
• func MakeAccountName(uid int) string
• func MakeWalletID(uid int) string
• func NewWalletError(uid int, err error) error
• func RemoveAccount(UID int) (*ljsonrpc.Account, error)
• func Resolve(url string) (*ljsonrpc.Claim, error)
• func WalletRemove(uid int) (*ljsonrpc.Wallet, error)
• type AccountConflict
  • func (e AccountConflict) Error() string
• type AccountNotFound
  • func (e AccountNotFound) Error() string
• type WalletAlreadyLoaded
  • func (e WalletAlreadyLoaded) Error() string
• type WalletError
  • func (e WalletError) Error() string
  • func (e WalletError) Unwrap() error
• type WalletExists
  • func (e WalletExists) Error() string
• type WalletNeedsLoading
  • func (e WalletNeedsLoading) Error() string
• type WalletNotFound
• type WalletNotLoaded
  • func (e WalletNotLoaded) Error() string

Variables

var Client = ljsonrpc.NewClient(config.GetLbrynet())

Client is a LBRY SDK jsonrpc client instance

var ExampleStreamCreateRequest = `` /* 482-byte string literal not displayed */

var ExampleStreamCreateResponse = `` /* 4723-byte string literal not displayed */

var Logger = monitor.NewModuleLogger("lbrynet")

Functions

func AddWallet

func AddWallet(uid int) (*ljsonrpc.Wallet, error)

AddWallet loads an existing wallet in the SDK. May return errors:

WalletAlreadyLoaded - wallet is already loaded and operational
WalletNotFound - wallet file does not exist and won't be loaded.

func CreateAccount

func CreateAccount(UID int) (*ljsonrpc.Account, error)

CreateAccount creates a new account with the SDK. Will return an error if account with this UID already exists.

func CreateWallet

func CreateWallet(uid int) (*ljsonrpc.Wallet, error)

CreateWallet creates a new wallet with the SDK. Returned error doesn't necessarily mean that the wallet is not operational:

	if errors.Is(err, lbrynet.WalletExists) {
	 // Okay to proceed with the account
 }

	if errors.Is(err, lbrynet.WalletNeedsLoading) {
	 // AddWallet() needs to be called before the wallet can be used
 }

func GetAccount

func GetAccount(uid int) (*ljsonrpc.Account, error)

GetAccount finds account in account_list by UID

func InitializeWallet

func InitializeWallet(uid int) (string, error)

InitializeWallet creates a wallet that can be immediately used in subsequent commands. It can recover from errors like existing wallets, but if a wallet is known to exist (eg. a wallet ID stored in the database already), AddWallet should be called instead.

func MakeAccountName

func MakeAccountName(uid int) string

MakeAccountName formats user ID to use as an SDK account name.

func MakeWalletID

func MakeWalletID(uid int) string

MakeWalletID formats user ID to use as an SDK wallet ID.

func NewWalletError

func NewWalletError(uid int, err error) error

NewWalletError converts plain SDK error to the typed one

func RemoveAccount

func RemoveAccount(UID int) (*ljsonrpc.Account, error)

RemoveAccount removes an account from the SDK by uid

func Resolve

func Resolve(url string) (*ljsonrpc.Claim, error)

Resolve calls resolve method on the daemon and handles *frequent* SDK response format changes with grace instead of panicking.

func WalletRemove

func WalletRemove(uid int) (*ljsonrpc.Wallet, error)

WalletRemove loads an existing wallet in the SDK. May return errors:

WalletAlreadyLoaded - wallet is already loaded and operational
WalletNotFound - wallet file does not exist and won't be loaded.

Types

type AccountConflict

type AccountConflict struct {
	UID int
	Err error
}

func (AccountConflict) Error

func (e AccountConflict) Error() string

type AccountNotFound

type AccountNotFound struct {
	UID int
	Err error
}

func (AccountNotFound) Error

func (e AccountNotFound) Error() string

type WalletAlreadyLoaded

type WalletAlreadyLoaded struct {
	WalletError
}

func (WalletAlreadyLoaded) Error

func (e WalletAlreadyLoaded) Error() string

type WalletError

type WalletError struct {
	UID int
	Err error
	// contains filtered or unexported fields
}

func (WalletError) Error

func (e WalletError) Error() string

func (WalletError) Unwrap

func (e WalletError) Unwrap() error

type WalletExists

type WalletExists struct {
	WalletError
}

func (WalletExists) Error

func (e WalletExists) Error() string

type WalletNeedsLoading

type WalletNeedsLoading struct {
	WalletError
}

func (WalletNeedsLoading) Error

func (e WalletNeedsLoading) Error() string

type WalletNotFound

type WalletNotFound struct {
	WalletError
}

type WalletNotLoaded

type WalletNotLoaded struct {
	WalletError
}

func (WalletNotLoaded) Error

func (e WalletNotLoaded) Error() string