ledger

package

v1.0.0-rc.2 Latest Latest Go to latest Published: Jan 20, 2022 License: MIT Imports: 15 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/numary/ledger

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func ProvideResolverOption(provider interface{}) fx.Option
func ResolveModule() fx.Option
type InMemoryLocker
- func NewInMemoryLocker() *InMemoryLocker
- func (d *InMemoryLocker) Lock(ledger string) (Unlock, error)
type InsufficientFundError
- func NewInsufficientFundError(asset string) *InsufficientFundError
- func (e InsufficientFundError) Error() string
type Ledger
- func NewLedger(name string, store storage.Store, locker Locker) (*Ledger, error)
- func (l *Ledger) Close(ctx context.Context) error
- func (l *Ledger) Commit(ctx context.Context, ts []core.Transaction) ([]core.Transaction, error)
- func (l *Ledger) Execute(ctx context.Context, script core.Script) error
- func (l *Ledger) FindAccounts(ctx context.Context, m ...query.QueryModifier) (query.Cursor, error)
- func (l *Ledger) FindTransactions(ctx context.Context, m ...query.QueryModifier) (query.Cursor, error)
- func (l *Ledger) GetAccount(ctx context.Context, address string) (core.Account, error)
- func (l *Ledger) GetLastTransaction(ctx context.Context) (core.Transaction, error)
- func (l *Ledger) GetTransaction(ctx context.Context, id string) (core.Transaction, error)
- func (l *Ledger) LoadMapping(ctx context.Context) (*core.Mapping, error)
- func (l *Ledger) RevertTransaction(ctx context.Context, id string) error
- func (l *Ledger) SaveMapping(ctx context.Context, mapping core.Mapping) error
- func (l *Ledger) SaveMeta(ctx context.Context, targetType string, targetID string, m core.Metadata) error
- func (l *Ledger) Stats(ctx context.Context) (Stats, error)
- func (l *Ledger) Verify() error
type Locker
type ResolveOptionFn
- func WithLocker(locker Locker) ResolveOptionFn
- func WithStorageFactory(factory storage.Factory) ResolveOptionFn
type Resolver
- func NewResolver(options ...ResolverOption) *Resolver
- func (r *Resolver) GetLedger(ctx context.Context, name string) (*Ledger, error)
type ResolverOption
type Stats
type Unlock
type ValidationError
- func NewValidationError(msg string) *ValidationError
- func (v ValidationError) Error() string

Constants ¶

View Source

const ResolverOptionsKey = `group:"_ledgerResolverOptions"`

Variables ¶

View Source

var DefaultContracts = []core.Contract{
	{
		Expr: &core.ExprGte{
			Op1: core.VariableExpr{
				Name: "balance",
			},
			Op2: core.ConstantExpr{
				Value: float64(0),
			},
		},
		Account: "*",
	},
}

View Source

var DefaultResolverOptions = []ResolverOption{
	WithStorageFactory(storage.NewDefaultFactory(sqlstorage.NewInMemorySQLiteDriver())),
	WithLocker(NewInMemoryLocker()),
}

Functions ¶

func ProvideResolverOption ¶

func ProvideResolverOption(provider interface{}) fx.Option

func ResolveModule ¶

func ResolveModule() fx.Option

Types ¶

type InMemoryLocker ¶

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

func NewInMemoryLocker ¶

func NewInMemoryLocker() *InMemoryLocker

func (*InMemoryLocker) Lock ¶

func (d *InMemoryLocker) Lock(ledger string) (Unlock, error)

type InsufficientFundError ¶

type InsufficientFundError struct {
	Asset string
}

func NewInsufficientFundError ¶

func NewInsufficientFundError(asset string) *InsufficientFundError

func (InsufficientFundError) Error ¶

func (e InsufficientFundError) Error() string

type Ledger ¶

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

func NewLedger ¶

func NewLedger(name string, store storage.Store, locker Locker) (*Ledger, error)

func (*Ledger) Close ¶

func (l *Ledger) Close(ctx context.Context) error

func (*Ledger) Commit ¶

func (l *Ledger) Commit(ctx context.Context, ts []core.Transaction) ([]core.Transaction, error)

func (*Ledger) Execute ¶

func (l *Ledger) Execute(ctx context.Context, script core.Script) error

func (*Ledger) FindAccounts ¶

func (l *Ledger) FindAccounts(ctx context.Context, m ...query.QueryModifier) (query.Cursor, error)

func (*Ledger) FindTransactions ¶

func (l *Ledger) FindTransactions(ctx context.Context, m ...query.QueryModifier) (query.Cursor, error)

func (*Ledger) GetAccount ¶

func (l *Ledger) GetAccount(ctx context.Context, address string) (core.Account, error)

func (*Ledger) GetLastTransaction ¶

func (l *Ledger) GetLastTransaction(ctx context.Context) (core.Transaction, error)

func (*Ledger) GetTransaction ¶

func (l *Ledger) GetTransaction(ctx context.Context, id string) (core.Transaction, error)

func (*Ledger) LoadMapping ¶

func (l *Ledger) LoadMapping(ctx context.Context) (*core.Mapping, error)

func (*Ledger) RevertTransaction ¶

func (l *Ledger) RevertTransaction(ctx context.Context, id string) error

func (*Ledger) SaveMapping ¶

func (l *Ledger) SaveMapping(ctx context.Context, mapping core.Mapping) error

func (*Ledger) SaveMeta ¶

func (l *Ledger) SaveMeta(ctx context.Context, targetType string, targetID string, m core.Metadata) error

func (*Ledger) Stats ¶

func (l *Ledger) Stats(ctx context.Context) (Stats, error)

func (*Ledger) Verify ¶

func (l *Ledger) Verify() error

type Locker ¶

type Locker interface {
	Lock(name string) (Unlock, error)
}

type ResolveOptionFn ¶

type ResolveOptionFn func(r *Resolver) error

func WithLocker ¶

func WithLocker(locker Locker) ResolveOptionFn

func WithStorageFactory ¶

func WithStorageFactory(factory storage.Factory) ResolveOptionFn

type Resolver ¶

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

func NewResolver ¶

func NewResolver(options ...ResolverOption) *Resolver

func (*Resolver) GetLedger ¶

func (r *Resolver) GetLedger(ctx context.Context, name string) (*Ledger, error)

type ResolverOption ¶

type ResolverOption interface {
	// contains filtered or unexported methods
}

type Stats ¶

type Stats struct {
	Transactions int64 `json:"transactions"`
	Accounts     int64 `json:"accounts"`
}

type Unlock ¶

type Unlock func()

type ValidationError ¶

type ValidationError struct {
	Msg string
}

func NewValidationError ¶

func NewValidationError(msg string) *ValidationError

func (ValidationError) Error ¶

func (v ValidationError) Error() string

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
query

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