common

package

Go to main page

Versions in this module

v0

v0.5.0

Jul 17, 2025

Changes in this version

+ const TokenRequestSignatures

+ func AuditingSignaturesValidate[P driver.PublicParameters, T any, TA driver.TransferAction, ...](ctx *Context[P, T, TA, IA, DS]) error

+ func IsAnyNil[T any](args ...*T) bool

+ func SelectIssuerForRedeem(issuers []driver.Identity, opts *driver.TransferOptions) (driver.Identity, error)

type AuditMatcherProvider

+ GetAuditInfo func(ctx context.Context, id driver.Identity, p driver.AuditInfoProvider) ([]byte, error)

+ MatchIdentity func(id driver.Identity, ai []byte) error

type Backend

+ Logger logging.Logger

type Context

+ Anchor driver.TokenRequestAnchor

+ TokenRequest *driver.TokenRequest

type Deserializer

+ func (d *Deserializer) GetAuditInfo(ctx context.Context, id driver.Identity, p driver.AuditInfoProvider) ([]byte, error)

+ func (d *Deserializer) GetAuditInfoMatcher(owner driver.Identity, auditInfo []byte) (driver.Matcher, error)

+ func (d *Deserializer) MatchIdentity(id driver.Identity, ai []byte) error

+ type MatcherDeserializer interface

+ GetAuditInfoMatcher func(owner driver.Identity, auditInfo []byte) (driver.Matcher, error)

type PublicParamsManager

+ DriverName driver.TokenDriverName

+ DriverVersion driver.TokenDriverVersion

type Service

+ func (s *Service[T]) TokensUpgradeService() driver.TokensUpgradeService

+ type ValidateAuditingFunc func(ctx *Context[P, T, TA, IA, DS]) error

type Validator

+ AuditingValidators []ValidateAuditingFunc[P, T, TA, IA, DS]

+ func (v *Validator[P, T, TA, IA, DS]) VerifyAuditing(anchor driver.TokenRequestAnchor, tokenRequest *driver.TokenRequest, ...) error

+ func (v *Validator[P, T, TA, IA, DS]) VerifyIssue(anchor driver.TokenRequestAnchor, tokenRequest *driver.TokenRequest, action IA, ...) error

+ func (v *Validator[P, T, TA, IA, DS]) VerifyTransfer(anchor driver.TokenRequestAnchor, tokenRequest *driver.TokenRequest, action TA, ...) error

v0.4.0

Jan 7, 2025

Changes in this version

+ const TokenRequestToSign

+ var ErrNilRecipientData = err.New("nil recipient data")

+ type ActionDeserializer interface

+ DeserializeActions func(tr *driver.TokenRequest) ([]IA, []TA, error)

+ type AnonymousOwnerWallet struct

+ Deserializer driver.Deserializer

+ IdentityCache *WalletIdentityCache

+ Logger logging.Logger

+ WalletRegistry WalletRegistry

+ func NewAnonymousOwnerWallet(logger logging.Logger, IdentityProvider driver.IdentityProvider, ...) (*AnonymousOwnerWallet, error)

+ func (w *AnonymousOwnerWallet) Contains(identity driver.Identity) bool

+ func (w *AnonymousOwnerWallet) ContainsToken(token *token.UnspentToken) bool

+ func (w *AnonymousOwnerWallet) GetRecipientIdentity() (driver.Identity, error)

+ func (w *AnonymousOwnerWallet) GetSigner(identity driver.Identity) (driver.Signer, error)

+ func (w *AnonymousOwnerWallet) RegisterRecipient(data *driver.RecipientData) error

+ type AuditMatcherProvider interface

+ GetOwnerAuditInfo func(id driver.Identity, p driver.AuditInfoProvider) ([][]byte, error)

+ GetOwnerMatcher func(raw []byte) (driver.Matcher, error)

+ MatchOwnerIdentity func(id driver.Identity, ai []byte) error

+ type AuditorWallet struct

+ AuditorIdentity driver.Identity

+ IdentityProvider driver.IdentityProvider

+ WalletID string

+ func NewAuditorWallet(IdentityProvider driver.IdentityProvider, id string, identity driver.Identity) *AuditorWallet

+ func (w *AuditorWallet) Contains(identity driver.Identity) bool

+ func (w *AuditorWallet) ContainsToken(token *token.UnspentToken) bool

+ func (w *AuditorWallet) GetAuditorIdentity() (driver.Identity, error)

+ func (w *AuditorWallet) GetSigner(id driver.Identity) (driver.Signer, error)

+ func (w *AuditorWallet) ID() string

+ type Authorization interface

+ AmIAnAuditor func() bool

+ IsMine func(tok *token2.Token) (string, []string, bool)

+ Issued func(issuer token.Identity, tok *token2.Token) bool

+ type AuthorizationMultiplexer struct

+ func NewAuthorizationMultiplexer(ownerships ...Authorization) *AuthorizationMultiplexer

+ func (o *AuthorizationMultiplexer) AmIAnAuditor() bool

+ func (o *AuthorizationMultiplexer) IsMine(tok *token2.Token) (string, []string, bool)

+ func (o *AuthorizationMultiplexer) Issued(issuer token.Identity, tok *token2.Token) bool

+ func (o *AuthorizationMultiplexer) OwnerType(raw []byte) (string, []byte, error)

+ type CertifierWallet struct

+ CertifierIdentity driver.Identity

+ IdentityProvider driver.IdentityProvider

+ WalletID string

+ func NewCertifierWallet(IdentityProvider driver.IdentityProvider, id string, identity driver.Identity) *CertifierWallet

+ func (w *CertifierWallet) Contains(identity driver.Identity) bool

+ func (w *CertifierWallet) ContainsToken(token *token.UnspentToken) bool

+ func (w *CertifierWallet) GetCertifierIdentity() (driver.Identity, error)

+ func (w *CertifierWallet) GetSigner(id driver.Identity) (driver.Signer, error)

+ func (w *CertifierWallet) ID() string

+ type Context struct

+ Attributes driver.ValidationAttributes

+ Deserializer DS

+ InputTokens []T

+ IssueAction IA

+ Ledger driver.Ledger

+ Logger logging.Logger

+ MetadataCounter map[MetadataCounterID]int

+ PP P

+ SignatureProvider driver.SignatureProvider

+ Signatures [][]byte

+ TransferAction TA

+ func (c *Context[P, T, TA, IA, DS]) CountMetadataKey(key string)

+ type Deserializer struct

+ func NewDeserializer(identityType string, auditorDeserializer VerifierDeserializer, ...) *Deserializer

+ func (d *Deserializer) GetAuditorVerifier(id driver.Identity) (driver.Verifier, error)

+ func (d *Deserializer) GetIssuerVerifier(id driver.Identity) (driver.Verifier, error)

+ func (d *Deserializer) GetOwnerAuditInfo(id driver.Identity, p driver.AuditInfoProvider) ([][]byte, error)

+ func (d *Deserializer) GetOwnerMatcher(raw []byte) (driver.Matcher, error)

+ func (d *Deserializer) GetOwnerVerifier(id driver.Identity) (driver.Verifier, error)

+ func (d *Deserializer) MatchOwnerIdentity(id driver.Identity, ai []byte) error

+ func (d *Deserializer) Recipients(id driver.Identity) ([]driver.Identity, error)

+ type Hashable []byte

+ func (id Hashable) Raw() []byte

+ func (id Hashable) RawString() string

+ func (id Hashable) String() string

+ type Hasher struct

+ func NewSHA256Hasher() *Hasher

+ func (h *Hasher) AddBool(b bool) (int, error)

+ func (h *Hasher) AddBytes(b []byte) error

+ func (h *Hasher) AddFloat64(f float64) error

+ func (h *Hasher) AddG1s(generators []*math.G1) error

+ func (h *Hasher) AddInt(i int) error

+ func (h *Hasher) AddInt32(i int32) error

+ func (h *Hasher) AddString(s string) error

+ func (h *Hasher) AddUInt64(i uint64) error

+ func (h *Hasher) Digest() []byte

+ func (h *Hasher) HexDigest() string

+ type IdentityTokenAndMetadataDeserializer struct

+ func (i IdentityTokenAndMetadataDeserializer) DeserializeMetadata(bytes []byte) ([]byte, error)

+ func (i IdentityTokenAndMetadataDeserializer) DeserializeToken(bytes []byte) ([]byte, error)

+ type IssuerTokenVault interface

+ ListHistoryIssuedTokens func() (*token.IssuedTokens, error)

+ type IssuerWallet struct

+ IdentityProvider driver.IdentityProvider

+ IssuerIdentity driver.Identity

+ Logger logging.Logger

+ TokenVault IssuerTokenVault

+ WalletID string

+ func NewIssuerWallet(Logger logging.Logger, IdentityProvider driver.IdentityProvider, ...) *IssuerWallet

+ func (w *IssuerWallet) Contains(identity driver.Identity) bool

+ func (w *IssuerWallet) ContainsToken(token *token.UnspentToken) bool

+ func (w *IssuerWallet) GetIssuerIdentity(tokenType token.Type) (driver.Identity, error)

+ func (w *IssuerWallet) GetSigner(identity driver.Identity) (driver.Signer, error)

+ func (w *IssuerWallet) HistoryTokens(opts *driver.ListTokensOptions) (*token.IssuedTokens, error)

+ func (w *IssuerWallet) ID() string

+ type LedgerToken interface

+ GetOwner func() []byte

+ type LoadedToken struct

+ Metadata M

+ Token T

+ TokenFormat token.Format

+ type LongTermOwnerWallet struct

+ IdentityProvider driver.IdentityProvider

+ OwnerIdentity driver.Identity

+ OwnerIdentityInfo driver.IdentityInfo

+ TokenVault OwnerTokenVault

+ WalletID string

+ func NewLongTermOwnerWallet(IdentityProvider driver.IdentityProvider, TokenVault OwnerTokenVault, ...) *LongTermOwnerWallet

+ func (w *LongTermOwnerWallet) Balance(opts *driver.ListTokensOptions) (uint64, error)

+ func (w *LongTermOwnerWallet) Contains(identity driver.Identity) bool

+ func (w *LongTermOwnerWallet) ContainsToken(token *token.UnspentToken) bool

+ func (w *LongTermOwnerWallet) EnrollmentID() string

+ func (w *LongTermOwnerWallet) GetAuditInfo(id driver.Identity) ([]byte, error)

+ func (w *LongTermOwnerWallet) GetRecipientIdentity() (driver.Identity, error)

+ func (w *LongTermOwnerWallet) GetSigner(identity driver.Identity) (driver.Signer, error)

+ func (w *LongTermOwnerWallet) GetTokenMetadata(id driver.Identity) ([]byte, error)

+ func (w *LongTermOwnerWallet) GetTokenMetadataAuditInfo(id driver.Identity) ([]byte, error)

+ func (w *LongTermOwnerWallet) ID() string

+ func (w *LongTermOwnerWallet) ListTokens(opts *driver.ListTokensOptions) (*token.UnspentTokens, error)

+ func (w *LongTermOwnerWallet) ListTokensIterator(opts *driver.ListTokensOptions) (driver.UnspentTokensIterator, error)

+ func (w *LongTermOwnerWallet) RegisterRecipient(data *driver.RecipientData) error

+ func (w *LongTermOwnerWallet) Remote() bool

+ type MetadataCounterID = string

+ type MetadataDeserializer interface

+ DeserializeMetadata func([]byte) (M, error)

+ type OwnerTokenVault interface

+ Balance func(id string, tokenType token.Type) (uint64, error)

+ UnspentTokensIteratorBy func(ctx context.Context, id string, tokenType token.Type) (driver.UnspentTokensIterator, error)

+ type PublicParametersManager interface

+ PublicParams func() T

+ type PublicParamsDeserializer interface

+ DeserializePublicParams func(raw []byte, label string) (T, error)

+ type PublicParamsManager struct

+ PPLabel string

+ func NewPublicParamsManagerFromParams[T driver.PublicParameters](pp T) (*PublicParamsManager[T], error)

+ func NewPublicParamsManager[T driver.PublicParameters](PublicParamsDeserializer PublicParamsDeserializer[T], PPLabel string, ...) (*PublicParamsManager[T], error)

+ func (v *PublicParamsManager[T]) NewCertifierKeyPair() ([]byte, []byte, error)

+ func (v *PublicParamsManager[T]) PublicParameters() driver.PublicParameters

+ func (v *PublicParamsManager[T]) PublicParams() T

+ func (v *PublicParamsManager[T]) PublicParamsHash() driver.PPHash

+ type RecipientExtractor interface

+ Recipients func(id driver.Identity) ([]driver.Identity, error)

+ type RegistryEntry struct

+ Mutex *sync.RWMutex

+ Registry WalletRegistry

+ type Serializer struct

+ func NewSerializer() *Serializer

+ func (s Serializer) MarshalTokenRequestToSign(request *driver.TokenRequest, meta *driver.TokenRequestMetadata) ([]byte, error)

+ type Service struct

+ Logger logging.Logger

+ PublicParametersManager PublicParametersManager[T]

+ func NewTokenService[T driver.PublicParameters](logger logging.Logger, ws *WalletService, ...) (*Service[T], error)

+ func (s *Service[T]) AuditorService() driver.AuditorService

+ func (s *Service[T]) Authorization() driver.Authorization

+ func (s *Service[T]) CertificationService() driver.CertificationService

+ func (s *Service[T]) Configuration() driver.Configuration

+ func (s *Service[T]) Deserializer() driver.Deserializer

+ func (s *Service[T]) Done() error

+ func (s *Service[T]) GetTokenInfo(meta *driver.TokenRequestMetadata, target []byte) ([]byte, error)

+ func (s *Service[T]) IdentityProvider() driver.IdentityProvider

+ func (s *Service[T]) IssueService() driver.IssueService

+ func (s *Service[T]) PublicParamsManager() driver.PublicParamsManager

+ func (s *Service[T]) Serializer() driver.Serializer

+ func (s *Service[T]) TokensService() driver.TokensService

+ func (s *Service[T]) TransferService() driver.TransferService

+ func (s *Service[T]) WalletService() driver.WalletService

+ type TokenAndMetadataDeserializer interface

+ type TokenCertificationStorage interface

+ GetCertifications func(ids []*token.ID) ([][]byte, error)

+ type TokenDeserializer interface

+ DeserializeToken func([]byte) (T, error)

+ type TokenVault interface

+ Balance func(id string, tokenType token.Type) (uint64, error)

+ GetTokenOutputs func(ids []*token.ID, callback driver.QueryCallbackFunc) error

+ GetTokenOutputsAndMeta func(ctx context.Context, ids []*token.ID) ([][]byte, [][]byte, []token.Format, error)

+ IsPending func(id *token.ID) (bool, error)

+ ListHistoryIssuedTokens func() (*token.IssuedTokens, error)

+ PublicParams func() ([]byte, error)

+ UnspentTokensIteratorBy func(ctx context.Context, id string, tokenType token.Type) (driver.UnspentTokensIterator, error)

+ type TokensService struct

+ func NewTokensService() *TokensService

+ func (s *TokensService) ExtractMetadata(meta *driver.TokenRequestMetadata, target []byte) ([]byte, error)

+ type ValidateIssueFunc func(ctx *Context[P, T, TA, IA, DS]) error

+ type ValidateTransferFunc func(ctx *Context[P, T, TA, IA, DS]) error

+ type Validator struct

+ ActionDeserializer ActionDeserializer[TA, IA]

+ Deserializer DS

+ IssueValidators []ValidateIssueFunc[P, T, TA, IA, DS]

+ Logger logging.Logger

+ PublicParams P

+ Serializer driver.Serializer

+ TransferValidators []ValidateTransferFunc[P, T, TA, IA, DS]

+ func NewValidator[P driver.PublicParameters, T any, TA driver.TransferAction, ...](Logger logging.Logger, publicParams P, deserializer DS, ...) *Validator[P, T, TA, IA, DS]

+ func (v *Validator[P, T, TA, IA, DS]) UnmarshalActions(raw []byte) ([]interface{}, error)

+ func (v *Validator[P, T, TA, IA, DS]) VerifyTokenRequest(ledger driver.Ledger, signatureProvider driver.SignatureProvider, ...) ([]interface{}, driver.ValidationAttributes, error)

+ func (v *Validator[P, T, TA, IA, DS]) VerifyTokenRequestFromRaw(ctx context.Context, getState driver.GetStateFnc, anchor string, raw []byte) ([]interface{}, driver.ValidationAttributes, error)

+ type VaultLedgerTokenAndMetadataLoader struct

+ Deserializer TokenAndMetadataDeserializer[T, M]

+ TokenVault TokenVault

+ func NewVaultLedgerTokenAndMetadataLoader[T any, M any](tokenVault TokenVault, deserializer TokenAndMetadataDeserializer[T, M]) *VaultLedgerTokenAndMetadataLoader[T, M]

+ func (s *VaultLedgerTokenAndMetadataLoader[T, M]) LoadTokens(ctx context.Context, ids []*token.ID) ([]LoadedToken[T, M], error)

+ type VaultLedgerTokenLoader struct

+ Deserializer TokenDeserializer[T]

+ Logger logging.Logger

+ NumRetries int

+ RetryDelay time.Duration

+ TokenVault TokenVault

+ func NewLedgerTokenLoader[T any](logger logging.Logger, tracerProvider trace.TracerProvider, ...) *VaultLedgerTokenLoader[T]

+ func (s *VaultLedgerTokenLoader[T]) GetTokenOutputs(ctx context.Context, ids []*token.ID) (map[string]T, error)

+ type VaultTokenCertificationLoader struct

+ TokenCertificationStorage TokenCertificationStorage

+ func (s *VaultTokenCertificationLoader) GetCertifications(ids []*token.ID) ([][]byte, error)

+ type VaultTokenInfoLoader struct

+ Deserializer MetadataDeserializer[M]

+ TokenVault driver.QueryEngine

+ func NewVaultTokenInfoLoader[M any](tokenVault driver.QueryEngine, deserializer MetadataDeserializer[M]) *VaultTokenInfoLoader[M]

+ func (s *VaultTokenInfoLoader[M]) GetTokenInfos(ids []*token.ID) ([]M, error)

+ type VaultTokenLoader struct

+ TokenVault driver.QueryEngine

+ func NewVaultTokenLoader(tokenVault driver.QueryEngine) *VaultTokenLoader

+ func (s *VaultTokenLoader) GetTokens(ids []*token.ID) ([]*token.Token, error)

+ type VerifierDeserializer interface

+ DeserializeVerifier func(id driver.Identity) (driver.Verifier, error)

+ type WalletBasedAuthorization struct

+ Logger logging.Logger

+ PublicParameters driver.PublicParameters

+ WalletService driver.WalletService

+ func NewTMSAuthorization(logger logging.Logger, publicParameters driver.PublicParameters, ...) *WalletBasedAuthorization

+ func (w *WalletBasedAuthorization) AmIAnAuditor() bool

+ func (w *WalletBasedAuthorization) IsMine(tok *token2.Token) (string, []string, bool)

+ func (w *WalletBasedAuthorization) Issued(issuer token.Identity, tok *token2.Token) bool

+ type WalletFactory interface

+ NewWallet func(role driver.IdentityRole, walletRegistry WalletRegistry, ...) (driver.Wallet, error)

+ type WalletIdentityCache struct

+ Logger logging.Logger

+ func NewWalletIdentityCache(Logger logging.Logger, backed WalletIdentityCacheBackendFunc, size int) *WalletIdentityCache

+ func (c *WalletIdentityCache) Identity() (driver.Identity, error)

+ type WalletIdentityCacheBackendFunc func() (driver.Identity, error)

+ type WalletRegistry interface

+ BindIdentity func(identity driver.Identity, eID string, wID string, meta any) error

+ ContainsIdentity func(i driver.Identity, id string) bool

+ GetIdentityMetadata func(identity driver.Identity, wID string, meta any) error

+ Lookup func(id driver.WalletLookupID) (driver.Wallet, driver.IdentityInfo, string, error)

+ RegisterIdentity func(config driver.IdentityConfiguration) error

+ RegisterWallet func(id string, wallet driver.Wallet) error

+ WalletIDs func() ([]string, error)

+ type WalletService struct

+ Deserializer driver.Deserializer

+ IdentityProvider driver.IdentityProvider

+ Logger logging.Logger

+ Registries map[driver.IdentityRole]*RegistryEntry

+ WalletFactory WalletFactory

+ func NewWalletService(logger logging.Logger, identityProvider driver.IdentityProvider, ...) *WalletService

+ func (s *WalletService) AuditorWallet(id driver.WalletLookupID) (driver.AuditorWallet, error)

+ func (s *WalletService) CertifierWallet(id driver.WalletLookupID) (driver.CertifierWallet, error)

+ func (s *WalletService) GetAuditInfo(id driver.Identity) ([]byte, error)

+ func (s *WalletService) GetEIDAndRH(identity driver.Identity, auditInfo []byte) (string, string, error)

+ func (s *WalletService) GetEnrollmentID(identity driver.Identity, auditInfo []byte) (string, error)

+ func (s *WalletService) GetRevocationHandle(identity driver.Identity, auditInfo []byte) (string, error)

+ func (s *WalletService) IssuerWallet(id driver.WalletLookupID) (driver.IssuerWallet, error)

+ func (s *WalletService) OwnerWallet(id driver.WalletLookupID) (driver.OwnerWallet, error)

+ func (s *WalletService) OwnerWalletIDs() ([]string, error)

+ func (s *WalletService) RegisterIssuerIdentity(config driver.IdentityConfiguration) error

+ func (s *WalletService) RegisterOwnerIdentity(config driver.IdentityConfiguration) error

+ func (s *WalletService) RegisterRecipientIdentity(data *driver.RecipientData) error

+ func (s *WalletService) SpentIDs(ids ...*token.ID) ([]string, error)

+ func (s *WalletService) Wallet(identity driver.Identity) driver.Wallet

v0.3.0

Oct 5, 2023

v0.2.0

Dec 7, 2022

v0.1.0

Nov 16, 2022

Changes in this version

+ func SetTransferActionMetadata(attrs map[interface{}]interface{}, metadata map[string][]byte)

+ type Backend struct

+ Cursor int

+ Ledger driver.GetStateFnc

+ Message []byte

+ Sigs [][]byte

+ func NewBackend(ledger driver.GetStateFnc, message []byte, sigs [][]byte) *Backend

+ func (b *Backend) GetState(key string) ([]byte, error)

+ func (b *Backend) HasBeenSignedBy(id view.Identity, verifier driver.Verifier) ([]byte, error)

+ func (b *Backend) Signatures() [][]byte

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