proof

package

Go to main page

Versions in this module

v0

v0.5.0-rc1

Nov 27, 2024

v0.4.1

Jul 25, 2024

v0.4.0

Jul 23, 2024

Changes in this version

+ const MaxDecDisplay

+ const MetadataDecDisplayKey

+ var ErrDecDisplayInvalid = errors.New("invalid decimal display")

+ var ErrDecDisplayInvalidType = errors.New(...)

+ var ErrDecDisplayMissing = errors.New("decimal display field missing")

+ var ErrDecDisplayTooLarge = errors.New("decimal display too large")

+ var ErrInvalidJSON = errors.New("invalid JSON")

+ var ErrMetaTypeNegative = errors.New("meta type cannot be negative")

+ var ErrMetaTypeTooLarge = errors.New("meta type above limit of 255")

+ var ErrNotJSON = errors.New("metadata is not JSON")

+ var MockChainLookup = &mockChainLookup

+ func CreateOwnershipProofAsset(ownedAsset *asset.Asset) (asset.PrevID, *asset.Asset)

+ func DecodeMetaJSON(jBytes []byte) (map[string]interface{}, error)

+ func Decoder(r io.Reader, val any, buf *[8]byte, l uint64) error

+ func DefaultMerkleVerifier(tx *wire.MsgTx, proof *TxMerkleProof, merkleRoot [32]byte) error

+ func Encode(p *Proof) ([]byte, error)

+ func EncodeFile(f *File) ([]byte, error)

+ func EncodeMetaJSON(jMeta map[string]interface{}) ([]byte, error)

+ func Encoder(w io.Writer, val any, buf *[8]byte) error

+ func IsValidDecDisplay(decDisplay uint32) error

+ func IsValidMetaSize(mBytes []byte, maxSize int) error

+ func MockMerkleVerifier(*wire.MsgTx, *TxMerkleProof, [32]byte) error

type Archiver

+ FetchIssuanceProof func(ctx context.Context, id asset.ID, anchorOutpoint wire.OutPoint) (Blob, error)

type BaseProofParams

+ func (p *BaseProofParams) HaveInclusionProof(anchorOutputIndex uint32) bool

+ type ChainLookupGenerator interface

+ GenFileChainLookup func(f *File) asset.ChainLookup

+ GenProofChainLookup func(p *Proof) (asset.ChainLookup, error)

type File

+ func DecodeFile(blob []byte) (*File, error)

type FileArchiver

+ func (f *FileArchiver) FetchIssuanceProof(ctx context.Context, id asset.ID, anchorOutpoint wire.OutPoint) (Blob, error)

+ type MerkleVerifier func(tx *wire.MsgTx, proof *TxMerkleProof, merkleRoot [32]byte) error

type MetaReveal

+ func (m *MetaReveal) GetDecDisplay() (map[string]interface{}, uint32, error)

+ func (m *MetaReveal) SetDecDisplay(decDisplay uint32) (*MetaReveal, error)

type MetaType

+ const MetaJson

+ func IsValidMetaType[T SizableInteger](num T) (MetaType, error)

type MintingBlobOption

+ func WithSiblingPreimage(sibling *commitment.TapscriptPreimage) MintingBlobOption

+ type MockProofArchive struct

+ func NewMockProofArchive() *MockProofArchive

+ func (m *MockProofArchive) FetchIssuanceProof(_ context.Context, id asset.ID, anchorOutpoint wire.OutPoint) (Blob, error)

+ func (m *MockProofArchive) FetchProof(_ context.Context, id Locator) (Blob, error)

+ func (m *MockProofArchive) FetchProofs(_ context.Context, id asset.ID) ([]*AnnotatedProof, error)

+ func (m *MockProofArchive) HasProof(_ context.Context, id Locator) (bool, error)

+ func (m *MockProofArchive) ImportProofs(_ context.Context, _ HeaderVerifier, _ MerkleVerifier, _ GroupVerifier, ...) error

type MultiArchiver

+ func (m *MultiArchiver) FetchIssuanceProof(ctx context.Context, id asset.ID, anchorOutpoint wire.OutPoint) (Blob, error)

type Proof

+ func Decode(blob []byte) (*Proof, error)

+ func RandProof(t testing.TB, genesis asset.Genesis, scriptKey *btcec.PublicKey, ...) Proof

+ func (p *Proof) Record() tlv.Record

+ func (p *Proof) VerifyProofs() (*commitment.TapCommitment, error)

+ type ProofCommitmentKeys map[asset.SerializedKey]*commitment.TapCommitment

+ func (k ProofCommitmentKeys) GetCommitment() (*commitment.TapCommitment, error)

+ type SizableInteger interface

type TapscriptProof

+ func CreateTapscriptProof(leaves []txscript.TapLeaf) (*TapscriptProof, error)

type TransitionParams

+ RootTapscriptSibling *commitment.TapscriptPreimage

v0.4.0-rc4

Jul 12, 2024

v0.4.0-rc1

Jun 27, 2024

v0.4.0-alpha.rc3

Jul 10, 2024

v0.4.0-alpha.rc2

Jul 3, 2024

v0.4.0-alpha.rc1

Jun 27, 2024

v0.3.3

Feb 7, 2024

Changes in this version

+ const TaprootAssetsFileEnding

+ var ErrMultipleProofs = fmt.Errorf(...)

+ var ErrOutPointMissing = fmt.Errorf("outpoint missing in key locator")

+ var OutPointFileNamePattern = regexp.MustCompile(...)

+ func ParseCourierAddress(addr string) (*url.URL, error)

+ func ValidateCourierAddress(addr *url.URL) error

type Archiver

+ HasProof func(ctx context.Context, id Locator) (bool, error)

type Blob

+ func (b Blob) AsFile() (*File, error)

+ func (b Blob) AsSingleProof() (*Proof, error)

+ func (b Blob) IsFile() bool

+ func (b Blob) IsSingleProof() bool

type Courier

+ Close func() error

type CourierCfg

+ HashMailCfg *HashMailCourierCfg

+ LocalArchive Archiver

+ UniverseRpcCfg *UniverseRpcCourierCfg

+ type CourierDispatch interface

+ NewCourier func(addr *url.URL, recipient Recipient) (Courier, error)

type File

+ func FetchProofProvenance(ctx context.Context, localArchive Archiver, originLocator Locator, ...) (*File, error)

+ func (f *File) AppendProofRaw(proof []byte) error

type FileArchiver

+ func (f *FileArchiver) HasProof(_ context.Context, id Locator) (bool, error)

type HashMailBox

+ func (h *HashMailBox) Close() error

type HashMailCourier

+ func (h *HashMailCourier) Close() error

+ type MockProofCourier struct

+ func NewMockProofCourier() *MockProofCourier

+ func (m *MockProofCourier) Close() error

+ func (m *MockProofCourier) DeliverProof(_ context.Context, proof *AnnotatedProof) error

+ func (m *MockProofCourier) ReceiveProof(_ context.Context, loc Locator) (*AnnotatedProof, error)

+ func (m *MockProofCourier) SetSubscribers(subscribers map[uint64]*fn.EventReceiver[fn.Event])

+ func (m *MockProofCourier) Start(chan error) error

+ func (m *MockProofCourier) Stop() error

+ type MockProofCourierDispatcher struct

+ Courier Courier

+ func (m *MockProofCourierDispatcher) NewCourier(*url.URL, Recipient) (Courier, error)

+ type MultiArchiveNotifier struct

+ func NewMultiArchiveNotifier(archives ...NotifyArchiver) *MultiArchiveNotifier

+ func (m *MultiArchiveNotifier) FetchProof(ctx context.Context, id Locator) (Blob, error)

+ func (m *MultiArchiveNotifier) RegisterSubscriber(receiver *fn.EventReceiver[Blob], deliverExisting bool, deliverFrom []*Locator) error

+ func (m *MultiArchiveNotifier) RemoveSubscriber(subscriber *fn.EventReceiver[Blob]) error

type MultiArchiver

+ func (m *MultiArchiver) HasProof(ctx context.Context, id Locator) (bool, error)

type NotifyArchiver

+ FetchProof func(ctx context.Context, id Locator) (Blob, error)

type ProofMailbox

+ Close func() error

+ type URLDispatch struct

+ func NewCourierDispatch(cfg *CourierCfg) *URLDispatch

+ func (u *URLDispatch) NewCourier(addr *url.URL, recipient Recipient) (Courier, error)

type UniverseRpcCourier

+ func (c *UniverseRpcCourier) Close() error

+ type UniverseRpcCourierCfg struct

+ BackoffCfg *BackoffCfg

v0.3.3-alpha.rc3

Feb 6, 2024

v0.3.3-alpha.rc2

Feb 6, 2024

v0.3.3-alpha.rc1

Jan 26, 2024

v0.3.2

Dec 5, 2023

v0.3.2-rc2

Nov 28, 2023

v0.3.2-beta.rc2

Nov 28, 2023

v0.3.2-beta.rc1

Nov 21, 2023

v0.3.1

Nov 9, 2023

Changes in this version

+ func SparseDecode(r io.Reader, records ...tlv.Record) error

type BackoffCfg

+ SkipInitDelay bool

+ type BackoffHandler struct

+ func NewBackoffHandler(cfg *BackoffCfg, deliveryLog TransferLog) *BackoffHandler

+ func (b *BackoffHandler) Exec(ctx context.Context, proofLocator Locator, transferType TransferType, ...) error

+ type BackoffWaitEvent struct

+ Backoff time.Duration

+ TransferType TransferType

+ TriesCounter int64

+ func NewBackoffWaitEvent(backoff time.Duration, triesCounter int64, transferType TransferType) *BackoffWaitEvent

+ func (e *BackoffWaitEvent) Timestamp() time.Time

type CourierCfg

+ TransferLog TransferLog

+ type TransferLog interface

+ LogProofTransferAttempt func(context.Context, Locator, TransferType) error

+ QueryProofTransferLog func(context.Context, Locator, TransferType) ([]time.Time, error)

+ type TransferType string

+ const ReceiveTransferType

+ const SendTransferType

v0.3.1-alpha.rc2

Nov 7, 2023

v0.3.1-alpha.rc1

Nov 3, 2023

v0.3.0

Oct 18, 2023

Changes in this version

+ const FileMaxNumProofs

+ const FileMaxProofSizeBytes

+ const FileMaxSizeBytes

+ const GenesisRevealType

+ const GroupKeyRevealType

+ const HashmailCourierType

+ const MaxNumTaprootProofs

+ const MaxTaprootProofSizeBytes

+ const MerkleProofMaxNodes

+ const PrefixMagicBytesLength

+ const UniverseRpcCourierType

+ const VersionType

+ var ErrGenesisRevealAssetIDMismatch = errors.New(...)

+ var ErrGenesisRevealMetaHashMismatch = errors.New(...)

+ var ErrGenesisRevealMetaRevealRequired = errors.New(...)

+ var ErrGenesisRevealOutputIndexMismatch = errors.New(...)

+ var ErrGenesisRevealPrevOutMismatch = errors.New(...)

+ var ErrGenesisRevealRequired = errors.New("genesis reveal required")

+ var ErrGenesisRevealTypeMismatch = errors.New(...)

+ var ErrGroupKeyRequired = errors.New("group key required")

+ var ErrGroupKeyRevealMismatch = errors.New(...)

+ var ErrGroupKeyRevealRequired = errors.New("group key reveal required")

+ var ErrGroupKeyUnknown = errors.New("group key not known")

+ var ErrMetaDataMissing = errors.New("meta data missing")

+ var ErrMetaDataTooLarge = errors.New("meta data too large")

+ var ErrNonGenesisAssetWithGenesisReveal = errors.New(...)

+ var ErrNonGenesisAssetWithGroupKeyReveal = errors.New(...)

+ var ErrProofFileInvalid = errors.New("proof file is invalid")

+ var ErrProofInvalid = errors.New("proof is invalid")

+ var ErrUnknownVersion = errors.New("proof: unknown proof version")

+ var FilePrefixMagicBytes = [PrefixMagicBytesLength]byte

+ var PrefixMagicBytes = [PrefixMagicBytesLength]byte

+ var RegtestOwnershipProofName = "ownership-proof.hex"

+ var RegtestProofFileName = "proof-file.hex"

+ var RegtestProofName = "proof.hex"

+ var RegtestTestVectorName = "proof_tlv_encoding_regtest.json"

+ func CheckMaxFileSize(blob Blob) error

+ func GenesisRevealDecoder(r io.Reader, val any, buf *[8]byte, l uint64) error

+ func GenesisRevealEncoder(w io.Writer, val any, buf *[8]byte) error

+ func GenesisRevealRecord(genesis **asset.Genesis) tlv.Record

+ func GroupKeyRevealDecoder(r io.Reader, val any, buf *[8]byte, l uint64) error

+ func GroupKeyRevealEncoder(w io.Writer, val any, buf *[8]byte) error

+ func GroupKeyRevealRecord(reveal **asset.GroupKeyReveal) tlv.Record

+ func IsProofFile(blob Blob) bool

+ func IsSingleProof(blob Blob) bool

+ func MockGroupAnchorVerifier(gen *asset.Genesis, groupKey *asset.GroupKey) error

+ func MockGroupVerifier(groupKey *btcec.PublicKey) error

+ func ReplaceProofInBlob(ctx context.Context, p *Proof, archive Archiver, headerVerifier HeaderVerifier, ...) error

+ func VersionDecoder(r io.Reader, val any, buf *[8]byte, l uint64) error

+ func VersionEncoder(w io.Writer, val any, buf *[8]byte) error

+ func VersionRecord(version *TransitionVersion) tlv.Record

type Archiver

+ FetchProofs func(ctx context.Context, id asset.ID) ([]*AnnotatedProof, error)

+ type AssetProofs map[asset.SerializedKey]*Proof

type Blob

+ func EncodeAsProofFile(proof *Proof) (Blob, error)

type Courier

+ func NewCourier(ctx context.Context, addr url.URL, cfg *CourierCfg, recipient Recipient) (Courier, error)

+ type CourierAddr interface

+ NewCourier func(ctx context.Context, cfg *CourierCfg, recipient Recipient) (Courier, error)

+ Url func() *url.URL

+ func ParseCourierAddrString(addr string) (CourierAddr, error)

+ func ParseCourierAddrUrl(addr url.URL) (CourierAddr, error)

+ type CourierCfg struct

+ BackoffCfg *BackoffCfg

+ DeliveryLog DeliveryLog

+ ReceiverAckTimeout time.Duration

+ type ErrorTestCase struct

+ Comment string

+ Error string

+ Proof *TestProof

type File

+ func (f *File) IsUnknownVersion() bool

+ func (f *File) IsValid() error

+ func (f *File) LocateProof(cb func(*Proof) bool) (*Proof, uint32, error)

+ func (f *File) ReplaceProofAt(index uint32, proof Proof) error

type FileArchiver

+ func (f *FileArchiver) FetchProofs(_ context.Context, id asset.ID) ([]*AnnotatedProof, error)

+ type GroupAnchorVerifier func(gen *asset.Genesis, groupKey *asset.GroupKey) error

+ type GroupVerifier func(groupKey *btcec.PublicKey) error

+ type HashMailCourierAddr struct

+ func NewHashMailCourierAddr(addr url.URL) (*HashMailCourierAddr, error)

+ func (h *HashMailCourierAddr) NewCourier(_ context.Context, cfg *CourierCfg, recipient Recipient) (Courier, error)

+ func (h *HashMailCourierAddr) Url() *url.URL

type Locator

+ OutPoint *wire.OutPoint

type MetaReveal

+ func (m *MetaReveal) Validate() error

type MetaType

+ const MetaDataMaxSizeBytes

type MultiArchiver

+ func (m *MultiArchiver) FetchProofs(ctx context.Context, id asset.ID) ([]*AnnotatedProof, error)

type Proof

+ GenesisReveal *asset.Genesis

+ GroupKeyReveal *asset.GroupKeyReveal

+ Version TransitionVersion

+ func (p *Proof) IsUnknownVersion() bool

+ func (p *Proof) OutPoint() wire.OutPoint

+ type TestBlockHeader struct

+ Bits uint32

+ MerkleRoot string

+ Nonce uint32

+ PrevBlock string

+ Timestamp uint32

+ Version int32

+ func NewTestFromBlockHeader(t testing.TB, h *wire.BlockHeader) *TestBlockHeader

+ func (tbh *TestBlockHeader) ToBlockHeader(t testing.TB) *wire.BlockHeader

+ type TestCommitmentProof struct

+ Proof *commitment.TestProof

+ TapscriptSibling string

+ func NewTestFromCommitmentProof(t testing.TB, p *CommitmentProof) *TestCommitmentProof

+ func (tcp *TestCommitmentProof) ToCommitmentProof(t testing.TB) *CommitmentProof

+ type TestMetaReveal struct

+ Data string

+ Type uint8

+ func NewTestFromMetaReveal(t testing.TB, m *MetaReveal) *TestMetaReveal

+ func (tmr *TestMetaReveal) ToMetaReveal(t testing.TB) *MetaReveal

+ type TestProof struct

+ AdditionalInputs []string

+ AnchorTx string

+ Asset *asset.TestAsset

+ BlockHeader *TestBlockHeader

+ BlockHeight uint32

+ ChallengeWitness []string

+ ExclusionProofs []*TestTaprootProof

+ GenesisReveal *asset.TestGenesisReveal

+ GroupKeyReveal *asset.TestGroupKeyReveal

+ InclusionProof *TestTaprootProof

+ MetaReveal *TestMetaReveal

+ PrevOut string

+ SplitRootProof *TestTaprootProof

+ TxMerkleProof *TestTxMerkleProof

+ func NewTestFromProof(t testing.TB, p *Proof) *TestProof

+ func (tp *TestProof) ToProof(t testing.TB) *Proof

+ type TestTaprootProof struct

+ CommitmentProof *TestCommitmentProof

+ InternalKey string

+ OutputIndex uint32

+ TapscriptProof *TestTapscriptProof

+ func NewTestFromTaprootProof(t testing.TB, p *TaprootProof) *TestTaprootProof

+ func (ttp *TestTaprootProof) ToTaprootProof(t testing.TB) *TaprootProof

+ type TestTapscriptProof struct

+ Bip86 bool

+ TapPreimage1 string

+ TapPreimage2 string

+ func NewTestFromTapscriptProof(t testing.TB, p *TapscriptProof) *TestTapscriptProof

+ func (ttp *TestTapscriptProof) ToTapscriptProof(t testing.TB) *TapscriptProof

+ type TestTxMerkleProof struct

+ Bits []bool

+ Nodes []string

+ func NewTestFromTxMerkleProof(t testing.TB, p *TxMerkleProof) *TestTxMerkleProof

+ func (tmp *TestTxMerkleProof) ToTxMerkleProof(t testing.TB) *TxMerkleProof

+ type TestVectors struct

+ ErrorTestCases []*ErrorTestCase

+ ValidTestCases []*ValidTestCase

+ type TransitionVersion uint32

+ const TransitionV0

+ type UniverseRpcCourier struct

+ func (c *UniverseRpcCourier) DeliverProof(ctx context.Context, annotatedProof *AnnotatedProof) error

+ func (c *UniverseRpcCourier) ReceiveProof(ctx context.Context, originLocator Locator) (*AnnotatedProof, error)

+ func (c *UniverseRpcCourier) SetSubscribers(subscribers map[uint64]*fn.EventReceiver[fn.Event])

+ type UniverseRpcCourierAddr struct

+ func NewUniverseRpcCourierAddr(addr url.URL) (*UniverseRpcCourierAddr, error)

+ func (h *UniverseRpcCourierAddr) NewCourier(_ context.Context, cfg *CourierCfg, recipient Recipient) (Courier, error)

+ func (h *UniverseRpcCourierAddr) Url() *url.URL

+ type UpdateCallback func([]*Proof) error

+ type ValidTestCase struct

+ Comment string

+ Expected string

+ Proof *TestProof

+ type Watcher interface

+ DefaultUpdateCallback func() UpdateCallback

+ MaybeWatch func(file *File, onProofUpdate UpdateCallback) error

+ ShouldWatch func(proof *Proof) bool

+ WatchProofs func(newProofs []*Proof, onProofUpdate UpdateCallback) error

v0.3.0-alpha.rc3

Oct 18, 2023

v0.3.0-alpha.rc2

Oct 14, 2023

v0.3.0-alpha.rc1

Oct 12, 2023

v0.2.3

Jul 19, 2023

Changes in this version

+ const BlockHeightType

+ func BlockHeightRecord(height *uint32) tlv.Record

type BaseProofParams

+ BlockHeight uint32

type Proof

+ BlockHeight uint32

v0.2.2

Jun 23, 2023

v0.2.1

Jun 22, 2023

Changes in this version

+ type ApertureHarness struct

+ ListenAddr string

+ Service *aperture.Aperture

+ TlsCertPath string

+ func NewApertureHarness(t *testing.T, port int) ApertureHarness

+ func (h *ApertureHarness) Start(errChan chan error) error

+ func (h *ApertureHarness) Stop() error

+ type CourierHarness interface

+ Start func(chan error) error

+ Stop func() error

+ type CourierType int64

+ const ApertureCourier

+ const DisabledCourier

v0.2.0

May 16, 2023

Changes in this version

+ const AdditionalInputsType

+ const AnchorTxType

+ const AssetLeafType

+ const BlockHeaderType

+ const ChallengeWitnessType

+ const CommitmentProofTapSiblingPreimageType

+ const ExclusionProofsType

+ const InclusionProofType

+ const MetaRevealDataType

+ const MetaRevealEncodingType

+ const MetaRevealType

+ const PrevOutType

+ const ProofDirName

+ const SplitRootProofType

+ const Subsystem

+ const TaprootAssetsFileSuffix

+ const TaprootProofCommitmentProofType

+ const TaprootProofInternalKeyType

+ const TaprootProofOutputIndexType

+ const TaprootProofTapscriptProofType

+ const TapscriptProofBip86

+ const TapscriptProofTapPreimage1

+ const TapscriptProofTapPreimage2

+ const TxMerkleProofType

+ var ErrInvalidChecksum = errors.New("invalid proof file checksum")

+ var ErrInvalidCommitmentProof = errors.New("invalid Taproot Asset commitment proof")

+ var ErrInvalidLocatorID = fmt.Errorf("invalid asset ID locator")

+ var ErrInvalidLocatorKey = fmt.Errorf("invalid script key locator")

+ var ErrInvalidTxMerkleProof = errors.New("invalid transaction merkle proof")

+ var ErrMetaRevealMismatch = errors.New(...)

+ var ErrMetaRevealRequired = errors.New("meta reveal required")

+ var ErrMissingExclusionProofs = errors.New("missing exclusion proof(s)")

+ var ErrMissingSplitRootProof = errors.New("missing split root proof")

+ var ErrNoProofAvailable = errors.New("no proof available")

+ var ErrNonGenesisAssetWithMetaReveal = errors.New(...)

+ var ErrProofNotFound = fmt.Errorf("unable to find proof")

+ func AddExclusionProofs(baseProof *BaseProofParams, packet *psbt.Packet, isAnchor func(uint32) bool) error

+ func AdditionalInputsDecoder(r io.Reader, val any, buf *[8]byte, l uint64) error

+ func AdditionalInputsEncoder(w io.Writer, val any, buf *[8]byte) error

+ func AdditionalInputsRecord(inputs *[]File) tlv.Record

+ func AnchorTxRecord(tx *wire.MsgTx) tlv.Record

+ func AppendTransition(blob Blob, params *TransitionParams, headerVerifier HeaderVerifier) (Blob, *Proof, error)

+ func AssetLeafRecord(a *asset.Asset) tlv.Record

+ func BlockHeaderDecoder(r io.Reader, val any, buf *[8]byte, l uint64) error

+ func BlockHeaderEncoder(w io.Writer, val any, buf *[8]byte) error

+ func BlockHeaderRecord(header *wire.BlockHeader) tlv.Record

+ func BoolDecoder(r io.Reader, val any, buf *[8]byte, l uint64) error

+ func BoolEncoder(w io.Writer, val any, buf *[8]byte) error

+ func ChallengeWitnessRecord(challengeWitness *wire.TxWitness) tlv.Record

+ func CommitmentProofDecoder(r io.Reader, val any, buf *[8]byte, l uint64) error

+ func CommitmentProofEncoder(w io.Writer, val any, buf *[8]byte) error

+ func CommitmentProofTapSiblingPreimageRecord(preimage **commitment.TapscriptPreimage) tlv.Record

+ func DisableLog()

+ func ExclusionProofsRecord(proofs *[]TaprootProof) tlv.Record

+ func ExtractTaprootKey(tx *wire.MsgTx, outputIndex uint32) (*btcec.PublicKey, error)

+ func ExtractTaprootKeyFromScript(pkScript []byte) (*btcec.PublicKey, error)

+ func InclusionProofRecord(proof *TaprootProof) tlv.Record

+ func MetaRevealDataRecord(data *[]byte) tlv.Record

+ func MetaRevealDecoder(r io.Reader, val any, buf *[8]byte, l uint64) error

+ func MetaRevealEncoder(w io.Writer, val any, buf *[8]byte) error

+ func MetaRevealRecord(reveal **MetaReveal) tlv.Record

+ func MetaRevealTypeRecord(metaType *MetaType) tlv.Record

+ func MetaTypeDecoder(r io.Reader, val any, buf *[8]byte, l uint64) error

+ func MetaTypeEncoder(w io.Writer, val any, buf *[8]byte) error

+ func MockHeaderVerifier(blockHeader wire.BlockHeader) error

+ func PrevOutRecord(prevOut *wire.OutPoint) tlv.Record

+ func SplitRootProofDecoder(r io.Reader, val any, buf *[8]byte, l uint64) error

+ func SplitRootProofEncoder(w io.Writer, val any, buf *[8]byte) error

+ func SplitRootProofRecord(proof **TaprootProof) tlv.Record

+ func TaprootProofCommitmentProofRecord(proof **CommitmentProof) tlv.Record

+ func TaprootProofDecoder(r io.Reader, val any, buf *[8]byte, l uint64) error

+ func TaprootProofEncoder(w io.Writer, val any, buf *[8]byte) error

+ func TaprootProofInternalKeyRecord(internalKey **btcec.PublicKey) tlv.Record

+ func TaprootProofOutputIndexRecord(idx *uint32) tlv.Record

+ func TaprootProofTapscriptProofRecord(proof **TapscriptProof) tlv.Record

+ func TaprootProofsDecoder(r io.Reader, val any, buf *[8]byte, _ uint64) error

+ func TaprootProofsEncoder(w io.Writer, val any, buf *[8]byte) error

+ func TapscriptProofBip86Record(bip86 *bool) tlv.Record

+ func TapscriptProofDecoder(r io.Reader, val any, buf *[8]byte, l uint64) error

+ func TapscriptProofEncoder(w io.Writer, val any, buf *[8]byte) error

+ func TapscriptProofTapPreimage1Record(preimage **commitment.TapscriptPreimage) tlv.Record

+ func TapscriptProofTapPreimage2Record(preimage **commitment.TapscriptPreimage) tlv.Record

+ func TxDecoder(r io.Reader, val any, buf *[8]byte, l uint64) error

+ func TxEncoder(w io.Writer, val any, buf *[8]byte) error

+ func TxMerkleProofDecoder(r io.Reader, val any, buf *[8]byte, l uint64) error

+ func TxMerkleProofEncoder(w io.Writer, val any, buf *[8]byte) error

+ func TxMerkleProofRecord(proof *TxMerkleProof) tlv.Record

+ func UseLogger(logger btclog.Logger)

+ type AnnotatedProof struct

+ type Archiver interface

+ FetchProof func(ctx context.Context, id Locator) (Blob, error)

+ ImportProofs func(ctx context.Context, headerVerifier HeaderVerifier, proofs ...*AnnotatedProof) error

+ type AssetBlobs map[asset.SerializedKey]Blob

+ func NewMintingBlobs(params *MintParams, headerVerifier HeaderVerifier, ...) (AssetBlobs, error)

+ type AssetSnapshot struct

+ AnchorBlockHash chainhash.Hash

+ AnchorBlockHeight uint32

+ AnchorTx *wire.MsgTx

+ AnchorTxIndex uint32

+ Asset *asset.Asset

+ InternalKey *btcec.PublicKey

+ MetaReveal *MetaReveal

+ OutPoint wire.OutPoint

+ OutputIndex uint32

+ ScriptRoot *commitment.TapCommitment

+ SplitAsset bool

+ TapscriptSibling *commitment.TapscriptPreimage

+ type BackoffCfg struct

+ BackoffResetWait time.Duration

+ InitialBackoff time.Duration

+ MaxBackoff time.Duration

+ NumTries int

+ type BackoffExecError struct

+ func (e *BackoffExecError) Error() string

+ type BaseProofParams struct

+ Block *wire.MsgBlock

+ ExclusionProofs []TaprootProof

+ InternalKey *btcec.PublicKey

+ OutputIndex int

+ TaprootAssetRoot *commitment.TapCommitment

+ TapscriptSibling *commitment.TapscriptPreimage

+ Tx *wire.MsgTx

+ TxIndex int

+ func (p *BaseProofParams) HaveExclusionProof(anchorOutputIndex uint32) bool

+ type BaseVerifier struct

+ func (b *BaseVerifier) Verify(ctx context.Context, blobReader io.Reader, headerVerifier HeaderVerifier) (*AssetSnapshot, error)

+ type Blob []byte

+ type CommitmentProof struct

+ TapSiblingPreimage *commitment.TapscriptPreimage

+ func (p *CommitmentProof) Decode(r io.Reader) error

+ func (p *CommitmentProof) DecodeRecords() []tlv.Record

+ func (p CommitmentProof) Encode(w io.Writer) error

+ func (p CommitmentProof) EncodeRecords() []tlv.Record

+ type Courier interface

+ DeliverProof func(context.Context, Addr, *AnnotatedProof) error

+ ReceiveProof func(context.Context, Addr, Locator) (*AnnotatedProof, error)

+ SetSubscribers func(map[uint64]*chanutils.EventReceiver[chanutils.Event])

+ type DeliveryLog interface

+ QueryProofDeliveryLog func(context.Context, Locator) ([]time.Time, error)

+ StoreProofDeliveryAttempt func(context.Context, Locator) error

+ type File struct

+ Version Version

+ func NewEmptyFile(v Version) *File

+ func NewFile(v Version, proofs ...Proof) (*File, error)

+ func (f *File) AppendProof(proof Proof) error

+ func (f *File) Decode(r io.Reader) error

+ func (f *File) Encode(w io.Writer) error

+ func (f *File) IsEmpty() bool

+ func (f *File) LastProof() (*Proof, error)

+ func (f *File) NumProofs() int

+ func (f *File) ProofAt(index uint32) (*Proof, error)

+ func (f *File) RawLastProof() ([]byte, error)

+ func (f *File) RawProofAt(index uint32) ([]byte, error)

+ func (f *File) ReplaceLastProof(proof Proof) error

+ func (f *File) Verify(ctx context.Context, headerVerifier HeaderVerifier) (*AssetSnapshot, error)

+ type FileArchiver struct

+ func NewFileArchiver(dirName string) (*FileArchiver, error)

+ func (f *FileArchiver) FetchProof(_ context.Context, id Locator) (Blob, error)

+ func (f *FileArchiver) ImportProofs(_ context.Context, _ HeaderVerifier, proofs ...*AnnotatedProof) error

+ func (f *FileArchiver) RegisterSubscriber(receiver *chanutils.EventReceiver[Blob], deliverExisting bool, ...) error

+ func (f *FileArchiver) RemoveSubscriber(subscriber *chanutils.EventReceiver[Blob]) error

+ type HashMailBox struct

+ func NewHashMailBox(serverAddr string, tlsCertPath string) (*HashMailBox, error)

+ func (h *HashMailBox) AckProof(ctx context.Context, sid streamID) error

+ func (h *HashMailBox) CleanUp(ctx context.Context, sid streamID) error

+ func (h *HashMailBox) Init(ctx context.Context, sid streamID) error

+ func (h *HashMailBox) ReadProof(ctx context.Context, sid streamID) (Blob, error)

+ func (h *HashMailBox) RecvAck(ctx context.Context, sid streamID) error

+ func (h *HashMailBox) WriteProof(ctx context.Context, sid streamID, proof Blob) error

+ type HashMailCourier struct

+ func NewHashMailCourier(cfg *HashMailCourierCfg, mailbox ProofMailbox, deliveryLog DeliveryLog) (*HashMailCourier, error)

+ func (h *HashMailCourier) DeliverProof(ctx context.Context, recipient Recipient, proof *AnnotatedProof) error

+ func (h *HashMailCourier) ReceiveProof(ctx context.Context, recipient Recipient, loc Locator) (*AnnotatedProof, error)

+ func (h *HashMailCourier) SetSubscribers(subscribers map[uint64]*chanutils.EventReceiver[chanutils.Event])

+ type HashMailCourierCfg struct

+ Addr string

+ BackoffCfg *BackoffCfg

+ ReceiverAckTimeout time.Duration

+ TlsCertPath string

+ type HeaderVerifier func(blockHeader wire.BlockHeader) error

+ type Locator struct

+ AssetID *asset.ID

+ GroupKey *btcec.PublicKey

+ ScriptKey btcec.PublicKey

+ func (l *Locator) Hash() [32]byte

+ type MetaReveal struct

+ Data []byte

+ Type MetaType

+ func (m *MetaReveal) Decode(r io.Reader) error

+ func (m *MetaReveal) DecodeRecords() []tlv.Record

+ func (m *MetaReveal) Encode(w io.Writer) error

+ func (m *MetaReveal) EncodeRecords() []tlv.Record

+ func (m *MetaReveal) MetaHash() [asset.MetaHashLen]byte

+ type MetaType uint8

+ const MetaOpaque

+ type MintParams struct

+ GenesisPoint wire.OutPoint

+ type MintingBlobOption func(*mintingBlobOpts)

+ func WithAssetMetaReveals(metaReveals map[asset.SerializedKey]*MetaReveal) MintingBlobOption

+ type MockVerifier struct

+ func NewMockVerifier(t *testing.T) *MockVerifier

+ func (m *MockVerifier) Verify(_ context.Context, _ io.Reader, headerVerifier HeaderVerifier) (*AssetSnapshot, error)

+ type MultiArchiver struct

+ func NewMultiArchiver(verifier Verifier, archiveTimeout time.Duration, backends ...Archiver) *MultiArchiver

+ func (m *MultiArchiver) FetchProof(ctx context.Context, loc Locator) (Blob, error)

+ func (m *MultiArchiver) ImportProofs(ctx context.Context, headerVerifier HeaderVerifier, proofs ...*AnnotatedProof) error

+ func (m *MultiArchiver) RegisterSubscriber(receiver *chanutils.EventReceiver[Blob], deliverExisting bool, ...) error

+ func (m *MultiArchiver) RemoveSubscriber(subscriber *chanutils.EventReceiver[Blob]) error

+ type NotifyArchiver interface

+ type Proof struct

+ AdditionalInputs []File

+ AnchorTx wire.MsgTx

+ Asset asset.Asset

+ BlockHeader wire.BlockHeader

+ ChallengeWitness wire.TxWitness

+ ExclusionProofs []TaprootProof

+ InclusionProof TaprootProof

+ MetaReveal *MetaReveal

+ PrevOut wire.OutPoint

+ SplitRootProof *TaprootProof

+ TxMerkleProof TxMerkleProof

+ func CreateTransitionProof(prevOut wire.OutPoint, params *TransitionParams) (*Proof, error)

+ func (p *Proof) Decode(r io.Reader) error

+ func (p *Proof) DecodeRecords() []tlv.Record

+ func (p *Proof) Encode(w io.Writer) error

+ func (p *Proof) EncodeRecords() []tlv.Record

+ func (p *Proof) UpdateTransitionProof(params *BaseProofParams) error

+ func (p *Proof) Verify(ctx context.Context, prev *AssetSnapshot, headerVerifier HeaderVerifier) (*AssetSnapshot, error)

+ type ProofMailbox interface

+ AckProof func(ctx context.Context, sid streamID) error

+ CleanUp func(ctx context.Context, sid streamID) error

+ Init func(ctx context.Context, sid streamID) error

+ ReadProof func(ctx context.Context, sid streamID) (Blob, error)

+ RecvAck func(ctx context.Context, sid streamID) error

+ WriteProof func(ctx context.Context, sid streamID, proof Blob) error

+ type ReceiverProofBackoffWaitEvent struct

+ Backoff time.Duration

+ TriesCounter int64

+ func NewReceiverProofBackoffWaitEvent(backoff time.Duration, triesCounter int64) *ReceiverProofBackoffWaitEvent

+ func (e *ReceiverProofBackoffWaitEvent) Timestamp() time.Time

+ type Recipient struct

+ Amount uint64

+ AssetID asset.ID

+ ScriptKey *btcec.PublicKey

+ type TaprootProof struct

+ CommitmentProof *CommitmentProof

+ InternalKey *btcec.PublicKey

+ OutputIndex uint32

+ TapscriptProof *TapscriptProof

+ func (p *TaprootProof) Decode(r io.Reader) error

+ func (p *TaprootProof) DecodeRecords() []tlv.Record

+ func (p TaprootProof) DeriveByAssetExclusion(assetCommitmentKey, tapCommitmentKey [32]byte) (*btcec.PublicKey, error)

+ func (p TaprootProof) DeriveByAssetInclusion(asset *asset.Asset) (*btcec.PublicKey, *commitment.TapCommitment, error)

+ func (p TaprootProof) DeriveByTapscriptProof() (*btcec.PublicKey, error)

+ func (p TaprootProof) Encode(w io.Writer) error

+ func (p TaprootProof) EncodeRecords() []tlv.Record

+ type TapscriptProof struct

+ Bip86 bool

+ TapPreimage1 *commitment.TapscriptPreimage

+ TapPreimage2 *commitment.TapscriptPreimage

+ func (p *TapscriptProof) Decode(r io.Reader) error

+ func (p *TapscriptProof) DecodeRecords() []tlv.Record

+ func (p TapscriptProof) DeriveTaprootKeys(internalKey *btcec.PublicKey) (*btcec.PublicKey, error)

+ func (p TapscriptProof) Encode(w io.Writer) error

+ func (p TapscriptProof) EncodeRecords() []tlv.Record

+ type TransitionParams struct

+ NewAsset *asset.Asset

+ RootInternalKey *btcec.PublicKey

+ RootOutputIndex uint32

+ RootTaprootAssetTree *commitment.TapCommitment

+ type TxMerkleProof struct

+ Bits []bool

+ Nodes []chainhash.Hash

+ func NewTxMerkleProof(txs []*wire.MsgTx, txIdx int) (*TxMerkleProof, error)

+ func (p *TxMerkleProof) Decode(r io.Reader) error

+ func (p TxMerkleProof) Encode(w io.Writer) error

+ func (p TxMerkleProof) Verify(tx *wire.MsgTx, merkleRoot chainhash.Hash) bool

+ type Verifier interface

+ Verify func(c context.Context, blobReader io.Reader, headerVerifier HeaderVerifier) (*AssetSnapshot, error)

+ type Version uint32

+ const V0

v0.2.0-lit-0

Jun 12, 2023

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