arksdk

Documentation

Index

• Constants
• Variables
• func WithSignAll(o interface{}) error
• func WithoutWalletSigner(o interface{}) error
• type ArkClient
  • func LoadCovenantClient(sdkStore types.Store) (ArkClient, error)
  • func LoadCovenantClientWithWallet(sdkStore types.Store, walletSvc wallet.WalletService) (ArkClient, error)
  • func LoadCovenantlessClient(sdkStore types.Store) (ArkClient, error)
  • func LoadCovenantlessClientWithWallet(sdkStore types.Store, walletSvc wallet.WalletService) (ArkClient, error)
  • func NewCovenantClient(sdkStore types.Store) (ArkClient, error)
  • func NewCovenantlessClient(sdkStore types.Store) (ArkClient, error)
• type Balance
• type CoinSelectOptions
• type InitArgs
• type InitWithWalletArgs
• type LockedOnchainBalance
• type Musig2SignOptions
• type OffchainBalance
• type OnchainBalance
• type Option
  • func WithExtraSigner(signerSessions ...bitcointree.SignerSession) Option
• type Receiver
  • func NewBitcoinReceiver(to string, amount uint64) Receiver
  • func NewLiquidReceiver(to string, amount uint64) Receiver
• type VtxoDetails

Constants

const (
	// transport
	GrpcClient = client.GrpcClient
	RestClient = client.RestClient
	// wallet
	SingleKeyWallet = wallet.SingleKeyWallet
	// store
	FileStore     = types.FileStore
	InMemoryStore = types.InMemoryStore
	// explorer
	BitcoinExplorer = explorer.BitcoinExplorer
	LiquidExplorer  = explorer.LiquidExplorer
)

Variables

var (
	ErrAlreadyInitialized = fmt.Errorf("client already initialized")
	ErrNotInitialized     = fmt.Errorf("client not initialized")
)

Functions

func WithSignAll

func WithSignAll(o interface{}) error

WithSignAll sets the signing type to ALL instead of the default BRANCH

func WithoutWalletSigner

func WithoutWalletSigner(o interface{}) error

WithoutWalletSigner disables the wallet signer

Types

type ArkClient

type ArkClient interface {
	GetConfigData(ctx context.Context) (*types.Config, error)
	Init(ctx context.Context, args InitArgs) error
	InitWithWallet(ctx context.Context, args InitWithWalletArgs) error
	IsLocked(ctx context.Context) bool
	Unlock(ctx context.Context, password string) error
	Lock(ctx context.Context, password string) error
	Balance(ctx context.Context, computeExpiryDetails bool) (*Balance, error)
	Receive(ctx context.Context) (offchainAddr, boardingAddr string, err error)
	SendOnChain(ctx context.Context, receivers []Receiver) (string, error)
	SendOffChain(
		ctx context.Context, withExpiryCoinselect bool, receivers []Receiver,
		withZeroFees bool,
	) (string, error)
	UnilateralRedeem(ctx context.Context) error
	CollaborativeRedeem(
		ctx context.Context, addr string, amount uint64, withExpiryCoinselect bool,
		opts ...Option,
	) (string, error)
	Settle(ctx context.Context, opts ...Option) (string, error)
	ListVtxos(ctx context.Context) (spendable, spent []client.Vtxo, err error)
	Dump(ctx context.Context) (seed string, err error)
	GetTransactionHistory(ctx context.Context) ([]types.Transaction, error)
	GetTransactionEventChannel() chan types.TransactionEvent
	RedeemNotes(ctx context.Context, notes []string, opts ...Option) (string, error)
	SetNostrNotificationRecipient(ctx context.Context, nostrRecipient string) error
	SignTransaction(ctx context.Context, tx string) (string, error)
	Stop() error
}

func LoadCovenantClient

func LoadCovenantClient(sdkStore types.Store) (ArkClient, error)

func LoadCovenantClientWithWallet

func LoadCovenantClientWithWallet(
	sdkStore types.Store, walletSvc wallet.WalletService,
) (ArkClient, error)

func LoadCovenantlessClient

func LoadCovenantlessClient(sdkStore types.Store) (ArkClient, error)

func LoadCovenantlessClientWithWallet

func LoadCovenantlessClientWithWallet(
	sdkStore types.Store, walletSvc wallet.WalletService,
) (ArkClient, error)

func NewCovenantClient

func NewCovenantClient(sdkStore types.Store) (ArkClient, error)

func NewCovenantlessClient

func NewCovenantlessClient(sdkStore types.Store) (ArkClient, error)

type Balance

type Balance struct {
	OnchainBalance  OnchainBalance  `json:"onchain_balance"`
	OffchainBalance OffchainBalance `json:"offchain_balance"`
}

type CoinSelectOptions

type CoinSelectOptions struct {
	// If true, coin selector will select coins closest to expiry first.
	WithExpirySorting bool
	// If specified, coin selector will select only coins in the list.
	OutpointsFilter []client.Outpoint
}

type InitArgs

type InitArgs struct {
	ClientType          string
	WalletType          string
	ServerUrl           string
	Seed                string
	Password            string
	ExplorerURL         string
	WithTransactionFeed bool
}

type InitWithWalletArgs

type InitWithWalletArgs struct {
	ClientType          string
	Wallet              wallet.WalletService
	ServerUrl           string
	Seed                string
	Password            string
	ExplorerURL         string
	WithTransactionFeed bool
}

type LockedOnchainBalance

type LockedOnchainBalance struct {
	SpendableAt string `json:"spendable_at"`
	Amount      uint64 `json:"amount"`
}

type Musig2SignOptions

type Musig2SignOptions struct {
	ExtraSignerSessions  []bitcointree.SignerSession
	SigningType          *tree.SigningType
	WalletSignerDisabled bool
}

Musig2SignOptions is only available for covenantless clients it allows to customize the vtxo signing process

type OffchainBalance

type OffchainBalance struct {
	Total          uint64        `json:"total"`
	NextExpiration string        `json:"next_expiration,omitempty"`
	Details        []VtxoDetails `json:"details"`
}

type OnchainBalance

type OnchainBalance struct {
	SpendableAmount uint64                 `json:"spendable_amount"`
	LockedAmount    []LockedOnchainBalance `json:"locked_amount,omitempty"`
}

type Option

type Option func(options interface{}) error

func WithExtraSigner

func WithExtraSigner(signerSessions ...bitcointree.SignerSession) Option

WithExtraSigner allows to use a set of custom signer for the vtxo tree signing process

type Receiver

type Receiver interface {
	To() string
	Amount() uint64

	IsOnchain() bool
}

func NewBitcoinReceiver

func NewBitcoinReceiver(to string, amount uint64) Receiver

func NewLiquidReceiver

func NewLiquidReceiver(to string, amount uint64) Receiver

type VtxoDetails

type VtxoDetails struct {
	ExpiryTime string `json:"expiry_time"`
	Amount     uint64 `json:"amount"`
}