balance

package

v0.13.0 Latest Latest Go to latest Published: May 7, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/TBD54566975/tbdex-go

Documentation ¶

Index ¶

Constants
type Balance
- func Create(fromDID did.BearerDID, currencyCode, availableAmount string, ...) (Balance, error)
- func Parse(data []byte) (Balance, error)
type CreateOption
- func CreatedAt(t time.Time) CreateOption
- func UpdatedAt(t time.Time) CreateOption
type Data
type ID
- func (id ID) Prefix() string

Constants ¶

View Source

const Kind = "balance"

Kind distinguishes between different resource kinds

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Balance ¶

type Balance struct {
	Metadata  resource.Metadata `json:"metadata,omitempty"`
	Data      Data              `json:"data,omitempty"`
	Signature string            `json:"signature,omitempty"`
}

Balance is a resource to communicate the amounts of each currency held by the PFI on behalf of its customer.

func Create ¶

func Create(fromDID did.BearerDID, currencyCode, availableAmount string, opts ...CreateOption) (Balance, error)

Create a Balance object

func Parse ¶

func Parse(data []byte) (Balance, error)

Parse validates, parses input data into a Balance, and verifies the signature.

func (Balance) Digest ¶

func (b Balance) Digest() ([]byte, error)

Digest computes a hash of the resource

func (*Balance) UnmarshalJSON ¶

func (b *Balance) UnmarshalJSON(data []byte) error

UnmarshalJSON validates and unmarshals the input data into a Balance.

func (*Balance) Verify ¶

func (b *Balance) Verify() error

Verify verifies the signature of the Balance.

type CreateOption ¶

type CreateOption func(*createOptions)

CreateOption implements functional options pattern for Create.

func CreatedAt ¶

func CreatedAt(t time.Time) CreateOption

CreatedAt can be passed to Create to provide a custom created at time.

func UpdatedAt ¶

func UpdatedAt(t time.Time) CreateOption

UpdatedAt can be passed to Create to provide a custom updated at time.

type Data ¶

type Data struct {
	CurrencyCode string `json:"currencyCode,omitempty"`
	Available    string `json:"available,omitempty"`
}

Data represents the data of a Balance.

type ID ¶

type ID struct {
	typeid.TypeID[ID]
}

ID is a unique identifier for a Balance.

func (ID) Prefix ¶

func (id ID) Prefix() string

Prefix returns the prefix for the Balance ID.

Source Files ¶

View all Source files

balance.go

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