Versions in this module Expand all Collapse all v0 v0.1.0 Jun 8, 2026 Changes in this version + const AssetTypeCollectible + const AssetTypeFungible + const AssetTypeNFT + const AssetTypeNormal + const TaprootAssetsKeyFamily + var ErrAmountMismatch = errors.New("amount does not match the address-embedded amount") + var ErrAmountRequired = errors.New("amount required for V2 address without an embedded amount") + var ErrAssetNameRequired = errors.New("asset name is required") + var ErrAssetNotIssuable = errors.New("asset ref is not an issuable grouped asset") + var ErrAssetUnknown = errors.New("asset ref is unknown to the wallet") + var ErrBuilderFinished = errors.New("builder already finished") + var ErrDuplicateAssetRef = errors.New("duplicate asset ref") + var ErrExternalIssuanceKeyRequired = errors.New("external issuance key is required") + var ErrExternalIssuanceRequestNotFound = errors.New("external issuance signing request not found") + var ErrExternalIssuanceSignatureRequired = errors.New("external issuance signature is required") + var ErrExternalIssuanceSignerRequired = errors.New("external issuance signer is required") + var ErrGroupKeyNotSupported = errors.New("group-key AssetRef requires a wallet-backed asset resolver") + var ErrIncompleteProofBundle = errors.New("proof bundle is incomplete") + var ErrInsufficientBalance = errors.New("insufficient asset balance") + var ErrInvalidAssetRef = errors.New("invalid asset ref") + var ErrInvalidChallenge = errors.New("invalid ownership proof challenge") + var ErrInvalidFeeRate = errors.New("invalid fee rate") + var ErrInvalidPagination = errors.New("invalid pagination") + var ErrInvalidUniverseHost = errors.New("invalid universe host") + var ErrMintBatchActive = errors.New("mint batch is already active") + var ErrMintResolveTimeout = errors.New("mint result resolution timed out") + var ErrMintResultNotFound = errors.New("mint result could not be mapped") + var ErrMixedAssetBatchUnsupported = errors.New("mixed-asset send batch unsupported") + var ErrMixedRecipientAmounts = errors.New("recipients mix explicit and embedded amounts") + var ErrNoAssetRef = errors.New("asset ref not set") + var ErrNoProofs = errors.New("no proofs found for asset ref") + var ErrNoReceiverKeys = errors.New("receiver keys not set") + var ErrNoRecipients = errors.New("no recipients configured") + var ErrNotCommitted = errors.New("transaction not committed") + var ErrNotFunded = errors.New("transaction not funded") + var ErrNotSigned = errors.New("transaction not signed") + var ErrOwnershipAmountRequired = errors.New("ownership proof amount is required") + var ErrOwnershipProofInvalid = errors.New("ownership proof is invalid") + var ErrOwnershipProofRequired = errors.New("ownership proof is required") + var ErrPermissionDenied = errors.New("permission denied") + var ErrProofNotFound = errors.New("proof not found") + var ErrTapdPrecondition = errors.New("tapd precondition failed") + var ErrUnauthenticated = errors.New("unauthenticated") + var ErrUniverseHostRequired = errors.New("universe host is required") + var ErrUniverseProofTypeRequired = errors.New("universe proof type is required") + var ErrUnsupportedByTapd = errors.New("operation unsupported by tapd") + var ErrWrongAssetType = errors.New("asset ref has the wrong asset type") + var ErrZeroAmount = errors.New("amount must be greater than zero") + func EncodeAddress(addr *Address, network Network) (string, error) + func ValidateOwnershipChallenge(challenge []byte) error + type Address struct + AddressVersion AddressVersion + Amount uint64 + AssetRef AssetRef + AssetType AssetType + AssetVersion AssetVersion + Encoded string + InternalKey PubKey + ProofCourierAddr string + ScriptKey PubKey + TaprootOutputKey XOnlyPubKey + TapscriptSibling []byte + func DecodeAddress(addr string) (*Address, error) + type AddressEvent struct + Address *Address + ConfirmationHeight uint32 + CreationTime uint64 + HasProof bool + Outpoint string + Status AddressEventStatus + TaprootSibling []byte + UTXOAmountSat uint64 + type AddressEventStatus uint8 + const AddressEventStatusCompleted + const AddressEventStatusProofReceived + const AddressEventStatusTransactionConfirmed + const AddressEventStatusTransactionDetected + const AddressEventStatusUnknown + type AddressQuery struct + CreatedAfter int64 + CreatedBefore int64 + Limit int32 + Offset int32 + type AddressReceivesQuery struct + Direction SortDirection + EndTimestamp uint64 + FilterAddr string + FilterStatus AddressEventStatus + Limit int32 + Offset int32 + StartTimestamp uint64 + type AddressVersion uint8 + const AddressVersionV0 + const AddressVersionV1 + const AddressVersionV2 + type AltLeaf struct + Value []byte + type AnchorSigner func(ctx context.Context, anchorPsbt []byte) ([]byte, error) + type AnchorTransaction struct + AnchorPsbt []byte + ChainFeesSats int64 + ChangeOutputIndex int32 + FinalTx []byte + LndLockedUtxos []Outpoint + TargetFeeRate FeeRate + type Asset struct + Amount uint64 + AssetRef AssetRef + CollectionRef *AssetRef + MetaHash Hash + Name string + Type AssetType + type AssetFederationSyncConfig struct + AllowSyncExport bool + AllowSyncInsert bool + ID UniverseID + type AssetGroupMember struct + Amount uint64 + AssetRef AssetRef + IssuanceID AssetID + LockTime int32 + MetaHash Hash + RelativeLockTime int32 + Tag string + Type AssetType + Version uint8 + type AssetGroupRecord struct + AssetRef AssetRef + Members []*AssetGroupMember + type AssetID [32]byte + func ParseAssetID(b []byte) (AssetID, error) + func ParseAssetIDHex(s string) (AssetID, error) + func (id AssetID) IsZero() bool + func (id AssetID) String() string + type AssetLeaf struct + Asset *AssetRecord + Proof []byte + type AssetLeafKey struct + Outpoint Outpoint + ScriptKey PubKey + type AssetLeafKeysRequest struct + Direction SortDirection + ID UniverseID + Limit int32 + Offset int32 + type AssetMeta struct + CanonicalUniverseURLs []string + Data []byte + DecimalDisplay uint32 + DelegationKey []byte + MetaHash Hash + Type AssetMetaType + UniverseCommitments bool + UnknownOddTypes map[uint64][]byte + type AssetMetaType uint8 + const AssetMetaTypeJSON + const AssetMetaTypeOpaque + type AssetPacket struct + AnchorTransaction []byte + PassiveAssetTransactions [][]byte + VirtualTransactions [][]byte + type AssetProofResponse struct + AssetLeaf *AssetLeaf + Key UniverseKey + MultiverseInclusionProof []byte + MultiverseRoot *MerkleSumNode + UniverseInclusionProof []byte + UniverseRoot *UniverseRoot + type AssetQuerySort int + const SortByAssetName + const SortByAssetType + const SortByGenesisHeight + const SortByIssuanceID + const SortByNone + const SortByTotalProofs + const SortByTotalSupply + const SortByTotalSyncs + type AssetRecord struct + AltLeaves []AltLeaf + Amount uint64 + AssetRef AssetRef + Genesis IssuanceGenesis + LockTime uint64 + RelativeLockTime uint64 + ScriptKey ScriptKey + ScriptVersion uint16 + Version uint8 + type AssetRef string + func AssetRefFromAsset(issuanceID AssetID, groupKey *PubKey) AssetRef + func AssetRefFromAssetID(assetID AssetID) AssetRef + func AssetRefFromGroupKey(groupKey PubKey) AssetRef + func AssetRefFromSpecifier(assetID *AssetID, groupKey *PubKey) (AssetRef, error) + func AssetRefFromTypedAsset(issuanceID AssetID, groupKey *PubKey, assetType AssetType) AssetRef + func ParseAssetRef(s string) (AssetRef, error) + func (r AssetRef) AssetID() (AssetID, bool) + func (r AssetRef) Equivalent(other AssetRef) bool + func (r AssetRef) GroupKey() (PubKey, bool) + func (r AssetRef) IsAssetIDRef() bool + func (r AssetRef) IsGroupRef() bool + func (r AssetRef) IsZero() bool + func (r AssetRef) String() string + func (r AssetRef) Validate() error + type AssetRootRequest struct + Direction SortDirection + Limit int32 + Offset int32 + WithAmountsByID bool + type AssetStatsAsset struct + AnchorPoint string + AssetName string + AssetRef AssetRef + AssetType AssetType + DecimalDisplay uint32 + GenesisHeight int32 + GenesisPoint string + GenesisTimestamp int64 + IssuanceID AssetID + TotalSupply int64 + type AssetStatsQuery struct + AssetNameFilter string + AssetRefFilter *AssetRef + AssetTypeFilter AssetTypeFilter + Direction SortDirection + Limit int32 + Offset int32 + SortBy AssetQuerySort + type AssetStatsSnapshot struct + Asset *AssetStatsAsset + AssetRef AssetRef + GroupAnchor *AssetStatsAsset + GroupKey *PubKey + GroupSupply int64 + TotalProofs int64 + TotalSyncs int64 + type AssetTransfer struct + AnchorTx []byte + AnchorTxBlockHash [32]byte + AnchorTxBlockHashStr string + AnchorTxBlockHeight uint32 + AnchorTxChainFees int64 + AnchorTxHeightHint uint32 + AnchorTxid string + Inputs []TransferInput + Label string + Outputs []TransferOutput + TransferTimestamp int64 + TransferTxid [32]byte + type AssetType uint8 + type AssetTypeFilter int + const FilterAssetCollectible + const FilterAssetNone + const FilterAssetNormal + type AssetVersion uint8 + const AssetVersionV0 + const AssetVersionV1 + type BackupMode uint8 + const BackupModeCompact + const BackupModeOptimistic + const BackupModeRaw + type Balance struct + AssetRef AssetRef + Balance uint64 + type BatchSibling struct + Branch *TapBranch + FullTree *TapscriptFullTree + type BatchState uint8 + const BatchStateBroadcast + const BatchStateCommitted + const BatchStateConfirmed + const BatchStateFinalized + const BatchStateFrozen + const BatchStatePending + const BatchStateSeedlingCancelled + const BatchStateSproutCancelled + const BatchStateUnknown + func (s BatchState) String() string + type Burn struct + Amount uint64 + AssetRef AssetRef + Note string + Proof *DecodedProof + Transfer *AssetTransfer + type BurnAssetRequest struct + AmountToBurn uint64 + AssetRef AssetRef + ConfirmationText string + Note string + type BurnAssetResponse struct + BurnProof *DecodedProof + BurnTransfer *AssetTransfer + type BurnOption func(*BurnOptions) + func WithBurnNote(note string) BurnOption + type BurnOptions struct + type BurnRecord struct + Amount uint64 + AnchorTxid Hash + AssetRef AssetRef + CollectionRef *AssetRef + IssuanceID AssetID + Note string + Type AssetType + type CancelBatchResponse struct + BatchKey PubKey + type Client interface + Close func() error + type Collection struct + AssetRef AssetRef + ItemCount uint64 + type CollectionMintResult struct + Collection *Collection + FirstItem *Asset + type CommittedTransfer struct + AnchorPsbt []byte + PassiveAssetPsbts [][]byte + VirtualPsbts [][]byte + type DeclareScriptKeyRequest struct + ScriptKey ScriptKey + type DecodedProof struct + AltLeaves [][]byte + Amount uint64 + AssetRef AssetRef + IsIssuance bool + IssuanceID AssetID + NumberOfProofs uint32 + Outpoint Outpoint + PrevIDs []PrevID + ProofAtDepth uint32 + ScriptKey PubKey + type DerivedKeys struct + InternalKey InternalKey + ScriptKey ScriptKey + type Error struct + Err error + Op string + func (e *Error) Error() string + func (e *Error) GRPCCode() codes.Code + func (e *Error) IsInvalidArgument() bool + func (e *Error) IsNotFound() bool + func (e *Error) IsUnavailable() bool + func (e *Error) Unwrap() error + type EventClient interface + SubscribeMintEvents func(ctx context.Context, req *SubscribeMintEventsRequest) (<-chan *MintEvent, <-chan error, error) + SubscribeReceiveEvents func(ctx context.Context, req *SubscribeReceiveEventsRequest) (<-chan *ReceiveEventRecord, <-chan error, error) + SubscribeSendEvents func(ctx context.Context, req *SubscribeSendEventsRequest) (<-chan *SendEventRecord, <-chan error, error) + type EventHandler struct + OnDisconnect func(streamName string, err error, nextRetry time.Duration) + OnError func(streamName string, err error) + OnMint func(ctx context.Context, event *MintEvent) + OnReceive func(ctx context.Context, event *ReceiveEvent) + OnSend func(ctx context.Context, event *SendEvent) + type EventListener struct + func NewEventListener(client EventClient, handler EventHandler, opts ...EventListenerOption) *EventListener + func (l *EventListener) Running() bool + func (l *EventListener) Start(ctx context.Context) error + func (l *EventListener) Stop() error + type EventListenerConfig struct + BackoffMultiplier float64 + InitialBackoff time.Duration + MaxBackoff time.Duration + MaxRetries int + MintFilter *SubscribeMintEventsRequest + ReceiveFilter *SubscribeReceiveEventsRequest + SendFilter *SubscribeSendEventsRequest + type EventListenerOption func(*EventListenerConfig) + func WithBackoffMultiplier(m float64) EventListenerOption + func WithInitialBackoff(d time.Duration) EventListenerOption + func WithMaxBackoff(d time.Duration) EventListenerOption + func WithMaxRetries(n int) EventListenerOption + func WithMintFilter(f *SubscribeMintEventsRequest) EventListenerOption + func WithReceiveFilter(f *SubscribeReceiveEventsRequest) EventListenerOption + func WithSendFilter(f *SubscribeSendEventsRequest) EventListenerOption + type ExportBackupRequest struct + Mode BackupMode + type ExportBackupResponse struct + Backup []byte + type ExternalIssuanceSigner interface + SignIssuance func(context.Context, IssuanceSigningRequest) (SignedIssuance, error) + type ExternalKey struct + DerivationPath string + MasterFingerprint [4]byte + XPub string + type FederationServer struct + Host string + ID int32 + type FederationSyncConfig struct + AssetSyncConfigs []AssetFederationSyncConfig + GlobalSyncConfigs []GlobalFederationSyncConfig + type FeeRate struct + func NewFeeRateSatPerKVByte(satPerKVByte uint64) FeeRate + func NewFeeRateSatPerVByte(satPerVByte uint64) (FeeRate, error) + func ParseFeeRateSatPerVByte(value string) (FeeRate, error) + func (r *FeeRate) UnmarshalText(text []byte) error + func (r FeeRate) IsZero() bool + func (r FeeRate) MarshalText() ([]byte, error) + func (r FeeRate) SatPerKVByte() uint64 + func (r FeeRate) SatPerKWeight() uint64 + func (r FeeRate) SatPerVByteCeil() uint64 + func (r FeeRate) SatPerVByteFloor() uint64 + func (r FeeRate) String() string + type FetchAssetMetaRequest struct + AssetRef *AssetRef + MetaHash *Hash + type FinalizeBatchRequest struct + BatchSibling *BatchSibling + FeeRate FeeRate + ShortResponse bool + type FundBatchRequest struct + BatchSibling *BatchSibling + FeeRate FeeRate + ShortResponse bool + type FundedTransfer struct + FundedPsbt []byte + PassiveAssetPsbts [][]byte + type FungibleAssetSpec struct + Amount uint64 + AssetMeta *AssetMeta + AssetVersion AssetVersion + DecimalDisplay uint32 + EnableSupplyCommitments bool + Name string + ScriptKey *ScriptKey + type GenesisInfo struct + AssetType AssetType + GenesisPoint string + IssuanceID AssetID + MetaHash Hash + Name string + OutputIndex uint32 + type GlobalFederationSyncConfig struct + AllowSyncExport bool + AllowSyncInsert bool + ProofType ProofType + type GroupKeyRequest struct + AnchorGenesis *GenesisInfo + ExternalKey *ExternalKey + NewAsset []byte + RawKey *KeyDescriptor + TapscriptRoot []byte + type GroupVirtualTx struct + GenesisID AssetID + PrevOut *TxOut + Transaction []byte + TweakedKey *PubKey + type GroupWitness struct + GenesisID AssetID + Witness [][]byte + type GroupedUniverseEvents struct + Date string + NewProofEvents uint64 + SyncEvents uint64 + type Hash [32]byte + func ParseHash(b []byte) (Hash, error) + func ParseHashHex(s string) (Hash, error) + func (h Hash) String() string + type ImportBackupRequest struct + Backup []byte + type ImportBackupResponse struct + NumImported uint32 + type Info struct + BlockHash chainhash.Hash + BlockHeight uint32 + LndIdentityPubkey PubKey + LndVersion string + Network string + NodeAlias string + SyncedToChain bool + Version string + type InteractiveSendRequest struct + Amount uint64 + AssetRef AssetRef + ReceiverKeys DerivedKeys + type InteractiveTxBuilder struct + func (b *InteractiveTxBuilder) Execute(ctx context.Context) (*AssetTransfer, error) + func (b *InteractiveTxBuilder) SetAsset(ref AssetRef, amount uint64) *InteractiveTxBuilder + func (b *InteractiveTxBuilder) SetLockTime(lockTime uint64) *InteractiveTxBuilder + func (b *InteractiveTxBuilder) SetReceiverKeys(keys DerivedKeys) *InteractiveTxBuilder + func (b *InteractiveTxBuilder) SetRelativeLockTime(relativeLockTime uint64) *InteractiveTxBuilder + func (b *InteractiveTxBuilder) WithAltLeaves(scriptKey PubKey, leaves [][]byte) *InteractiveTxBuilder + type InternalKey struct + KeyLocator KeyLocator + PubKey PubKey + type Issuance struct + Amount uint64 + AssetRef AssetRef + IssuanceID AssetID + MetaHash Hash + Name string + func (i Issuance) Ref() AssetRef + type IssuanceGenesis struct + FirstPrevOut Outpoint + IssuanceID AssetID + MetaHash Hash + OutputIndex uint32 + Tag string + Type AssetType + type IssuanceOperation uint8 + const IssuanceOperationCreateAsset + const IssuanceOperationCreateCollection + const IssuanceOperationIssueAsset + const IssuanceOperationMintCollectionItem + const IssuanceOperationUnknown + func (o IssuanceOperation) String() string + type IssuanceSigningRequest struct + Amount uint64 + AnchorGenesis *GenesisInfo + AssetRef AssetRef + AssetType AssetType + ExternalKey ExternalKey + Name string + Operation IssuanceOperation + ScriptKey *ScriptKey + VirtualPSBT string + VirtualTx *GroupVirtualTx + type Issuer struct + func NewIssuer(client Client) *Issuer + func (i *Issuer) CreateCollection(ctx context.Context, firstItem NFTSpec, opts ...MintOption) (*CollectionMintResult, error) + func (i *Issuer) CreateFungible(ctx context.Context, spec FungibleAssetSpec, opts ...MintOption) (*Asset, error) + func (i *Issuer) CreateNFT(ctx context.Context, spec NFTSpec, opts ...MintOption) (*Asset, error) + func (i *Issuer) IssueFungible(ctx context.Context, ref AssetRef, amount uint64, opts ...MintOption) (*Issuance, error) + func (i *Issuer) MintCollectionItem(ctx context.Context, collectionRef AssetRef, item NFTSpec, opts ...MintOption) (*Asset, error) + type KeyDescriptor struct + KeyLocator KeyLocator + RawKeyBytes PubKey + type KeyLocator struct + Family uint32 + Index uint32 + type ListAssetsRequest struct + AnchorOutpoint *Outpoint + AssetRef *AssetRef + IncludeLeased bool + IncludeSpent bool + IncludeUnconfirmedMints bool + MaxAmount uint64 + MinAmount uint64 + ScriptKeyType *ScriptKeyTypeQuery + WithWitness bool + type ListBalancesRequest struct + AssetRef *AssetRef + IncludeLeased bool + ScriptKeyType *ScriptKeyTypeQuery + type ListBalancesResponse struct + Balances map[string]*Balance + UnconfirmedTransfers uint64 + type ListBatchesRequest struct + BatchKey *PubKey + Verbose bool + type ListBurnsRequest struct + AnchorTxid *Hash + AssetRef *AssetRef + type ListCollectionItemsRequest struct + AssetRef *AssetRef + CollectionRef *AssetRef + type ListCollectionsRequest struct + AssetRef *AssetRef + type ListIssuancesRequest struct + AssetRef *AssetRef + type ListTransfersRequest struct + AnchorTxid string + type ListUtxosRequest struct + IncludeLeased bool + ScriptKeyType *ScriptKeyTypeQuery + type MacaroonSource = macaroon.Source + func MacaroonFromDir(dir string) MacaroonSource + func MacaroonFromHex(hex string) MacaroonSource + func MacaroonFromPath(path string) MacaroonSource + type ManagedUtxo struct + AmtSat int64 + Assets []*AssetRecord + InternalKey PubKey + LeaseExpiryUnix int64 + LeaseOwner []byte + MerkleRoot Hash + OutPoint Outpoint + TaprootAssetRoot Hash + type MerkleSumNode struct + RootHash Hash + RootSum int64 + type MintAsset struct + AllowIssuance bool + AssetMeta *AssetMeta + AssetType AssetType + AssetVersion AssetVersion + DecimalDisplay uint32 + EnableSupplyCommitments bool + ExternalGroupKey *ExternalKey + GroupInternalKey *KeyDescriptor + GroupTapscriptRoot []byte + InitialSupply uint64 + Name string + ScriptKey *ScriptKey + type MintAssetRequest struct + Asset *MintAsset + ShortResponse bool + type MintClient interface + CancelBatch func(ctx context.Context) (*CancelBatchResponse, error) + FinalizeBatch func(ctx context.Context, req *FinalizeBatchRequest) (*MintingBatch, error) + FundBatch func(ctx context.Context, req *FundBatchRequest) (*VerboseMintingBatch, error) + ListBatches func(ctx context.Context, req *ListBatchesRequest) ([]*VerboseMintingBatch, error) + MintAsset func(ctx context.Context, req *MintAssetRequest) (*MintingBatch, error) + MintIssuance func(ctx context.Context, req *MintIssuanceRequest) (*MintingBatch, error) + SealBatch func(ctx context.Context, req *SealBatchRequest) (*MintingBatch, error) + type MintEvent struct + Batch *MintingBatch + BatchState BatchState + Error string + Timestamp int64 + type MintIssuance struct + Amount uint64 + AssetMeta *AssetMeta + AssetRef AssetRef + AssetType AssetType + AssetVersion AssetVersion + DecimalDisplay uint32 + ExternalGroupKey *ExternalKey + Name string + ScriptKey *ScriptKey + type MintIssuanceRequest struct + Issuance *MintIssuance + ShortResponse bool + type MintOption func(*MintOptions) + func WithExternalIssuanceKey(key ExternalKey) MintOption + func WithExternalIssuanceSigner(signer ExternalIssuanceSigner) MintOption + func WithMintFeeRate(feeRate FeeRate) MintOption + func WithMintResolveTimeout(timeout time.Duration) MintOption + type MintOptions struct + type MintingBatch struct + Assets []PendingMintAsset + BatchKey PubKey + BatchPSBT []byte + BatchTxid string + CreatedAt int64 + HeightHint uint32 + State BatchState + type NFTSpec struct + AssetMeta *AssetMeta + AssetVersion AssetVersion + Name string + ScriptKey *ScriptKey + type Network string + const NetworkMainnet + const NetworkRegtest + const NetworkSignet + const NetworkSimnet + const NetworkTestnet + const NetworkTestnet4 + type NewAddressRequest struct + AddressVersion *AddressVersion + Amount uint64 + AssetRef AssetRef + AssetVersion *AssetVersion + InternalKey *KeyDescriptor + ProofCourierAddr string + ScriptKey *ScriptKey + SkipProofCourierConnCheck bool + TapscriptSibling []byte + type Outpoint struct + Index uint32 + Txid [32]byte + func NewOutpointFromStr(s string) (Outpoint, error) + func (o Outpoint) String() string + type OwnershipOption func(*ownershipOptions) + func WithAllOwnedCollectionItems() OwnershipOption + func WithOwnershipAmount(amount uint64) OwnershipOption + func WithOwnershipChallenge(challenge []byte) OwnershipOption + type OwnershipProof struct + Amount uint64 + AssetRef AssetRef + IssuanceID AssetID + Outpoint Outpoint + ProofWithWitness []byte + ScriptKey PubKey + type OwnershipProofSet struct + AssetRef AssetRef + Proofs []OwnershipProof + type ParcelType uint8 + const ParcelTypeAddress + const ParcelTypePending + const ParcelTypePreAnchored + const ParcelTypePreSigned + type PendingMintAsset struct + Amount uint64 + AssetMeta *AssetMeta + AssetType AssetType + AssetVersion AssetVersion + GroupAnchor string + GroupInternalKey *KeyDescriptor + GroupKey *PubKey + GroupTapscriptRoot []byte + Name string + NewGroupedAsset bool + ScriptKey *ScriptKey + type PrevID struct + IssuanceID AssetID + Outpoint Outpoint + ScriptKey PubKey + type ProofBundle struct + AssetRef AssetRef + Entries []ProofEntry + type ProofClient interface + DecodeProof func(ctx context.Context, rawProof []byte) (*DecodedProof, error) + ExportProof func(ctx context.Context, ref AssetRef, scriptKey PubKey, outpoint *Outpoint) (*ProofFile, error) + RegisterTransfer func(ctx context.Context, assetRef AssetRef, scriptKey PubKey, outpoint Outpoint) (*RegisteredAsset, error) + UnpackProofFile func(ctx context.Context, rawProofFile []byte) ([][]byte, error) + type ProofEntry struct + Amount uint64 + AssetRef AssetRef + IssuanceID AssetID + Outpoint *Outpoint + ProofFile []byte + ScriptKey PubKey + type ProofFile struct + GenesisPoint Outpoint + RawProofFile []byte + type ProofType int + const ProofTypeIssuance + const ProofTypeTransfer + const ProofTypeUnspecified + type ProveOwnershipRequest struct + AssetRef AssetRef + Challenge []byte + Outpoint Outpoint + ScriptKey PubKey + type PubKey [33]byte + func ParseGroupRefKey(s string) (PubKey, error) + func ParsePubKey(b []byte) (PubKey, error) + func ParsePubKeyHex(s string) (PubKey, error) + func ParseScriptKey(b []byte) (PubKey, error) + func ParseTaprootPubKey(b []byte) (PubKey, error) + func (k PubKey) Bytes() []byte + func (k PubKey) String() string + func (k PubKey) XOnly() XOnlyPubKey + type QueryEventsRequest struct + EndTimestamp int64 + StartTimestamp int64 + type QueryRootResponse struct + IssuanceRoot *UniverseRoot + TransferRoot *UniverseRoot + type ReceiveEvent struct + Amount uint64 + AssetRef AssetRef + ConfirmationHeight uint32 + Error string + Outpoint string + Status AddressEventStatus + Timestamp int64 + func NewReceiveEvent(record *ReceiveEventRecord) *ReceiveEvent + type ReceiveEventRecord struct + Address *Address + ConfirmationHeight uint32 + Error string + Outpoint string + Status AddressEventStatus + Timestamp int64 + type Recipient struct + Address string + func RecipientWithAmount(address string, amount uint64) Recipient + func RecipientWithEmbeddedAmount(address string) Recipient + func (r Recipient) Amount() (uint64, bool) + type RegisteredAsset struct + Amount uint64 + AssetRef AssetRef + IssuanceID AssetID + Outpoint Outpoint + ScriptKey PubKey + type ScriptKey struct + KeyDesc KeyDescriptor + PubKey PubKey + TapTweak []byte + type ScriptKeyType uint8 + const ScriptKeyTypeBIP86 + const ScriptKeyTypeBurn + const ScriptKeyTypeChannel + const ScriptKeyTypeScriptPathExternal + const ScriptKeyTypeTombstone + const ScriptKeyTypeUniquePedersen + const ScriptKeyTypeUnknown + func (t ScriptKeyType) Valid() bool + type ScriptKeyTypeQuery struct + AllTypes bool + ExplicitType *ScriptKeyType + func (q *ScriptKeyTypeQuery) Validate() error + type SealBatchRequest struct + GroupWitnesses []GroupWitness + ShortResponse bool + SignedGroupVirtualPSBTs []string + type SendAssetRequest struct + FeeRate FeeRate + Label string + Recipients []Recipient + SkipProofCourierPingCheck bool + type SendEvent struct + AssetRefs []AssetRef + Error string + NextSendState SendState + SendState SendState + Timestamp int64 + Transfer *Transfer + TransferLabel string + func NewSendEvent(record *SendEventRecord) *SendEvent + type SendEventRecord struct + Addresses []*Address + AnchorTransaction *AnchorTransaction + Error string + NextSendState SendState + ParcelType ParcelType + PassiveVirtualPackets [][]byte + SendState SendState + Timestamp int64 + Transfer *AssetTransfer + TransferLabel string + VirtualPackets [][]byte + type SendOption func(*SendOptions) + func WithAmount(amount uint64) SendOption + func WithFeeRate(feeRate FeeRate) SendOption + func WithLabel(label string) SendOption + func WithSkipProofCourierPingCheck() SendOption + type SendOptions struct + type SendState string + const SendStateAnchorSign + const SendStateBroadcast + const SendStateComplete + const SendStateStartHandleAddrParcel + const SendStateStorePostAnchorTxConf + const SendStateStorePreBroadcast + const SendStateTransferProofs + const SendStateVerifyPreBroadcast + const SendStateVirtualCommitmentSelect + const SendStateVirtualSign + const SendStateWaitTxConf + type SignedIssuance struct + VirtualPSBT string + type SortDirection uint8 + const SortAscending + const SortDescending + type SubscribeMintEventsRequest struct + ShortResponse bool + type SubscribeReceiveEventsRequest struct + FilterAddr string + StartTimestamp int64 + type SubscribeSendEventsRequest struct + FilterLabel string + FilterScriptKey []byte + StartTimestamp int64 + type SyncRequest struct + SyncMode UniverseSyncMode + SyncTargets []SyncTarget + UniverseHost string + type SyncTarget struct + ID UniverseID + type SyncedUniverse struct + NewAssetLeaves []AssetLeaf + NewAssetRoot *UniverseRoot + OldAssetRoot *UniverseRoot + type TapBranch struct + LeftTapHash Hash + RightTapHash Hash + type TapLeaf struct + Script []byte + type TapscriptFullTree struct + Leaves []TapLeaf + type Transfer struct + AnchorTxBlockHeight uint32 + AnchorTxChainFees int64 + AnchorTxid string + Inputs []TransferAsset + Label string + Outputs []TransferAsset + TransferTimestamp int64 + func NewTransfer(raw *AssetTransfer) *Transfer + type TransferAsset struct + Amount uint64 + AssetRef AssetRef + IssuanceID AssetID + Outpoint Outpoint + ScriptKey PubKey + Type AssetType + type TransferInput struct + Amount uint64 + AnchorPoint Outpoint + AssetType AssetType + GroupKey *PubKey + IssuanceID AssetID + ScriptKey PubKey + type TransferOutput struct + AltLeaves [][]byte + Amount uint64 + AnchorOutpoint Outpoint + AnchorValue int64 + AssetType AssetType + GroupKey *PubKey + IssuanceID AssetID + ProofBlob []byte + ScriptKey PubKey + type TxBuilder struct + func (b *TxBuilder) AddInput(input PrevID) *TxBuilder + func (b *TxBuilder) AddRecipient(address string, amount uint64) *TxBuilder + func (b *TxBuilder) AddTapAddress(address string) *TxBuilder + func (b *TxBuilder) Commit(ctx context.Context) (*CommittedTransfer, error) + func (b *TxBuilder) Execute(ctx context.Context, opts ...TxBuilderOption) (*AssetPacket, error) + func (b *TxBuilder) Finish(ctx context.Context, opts ...TxBuilderOption) (*AssetPacket, error) + func (b *TxBuilder) Fund(ctx context.Context) (*FundedTransfer, error) + func (b *TxBuilder) SetAnchorPsbt(anchorPsbt []byte) *TxBuilder + func (b *TxBuilder) SetAnchorSigner(signer AnchorSigner) *TxBuilder + func (b *TxBuilder) SetFeeRate(feeRate FeeRate) *TxBuilder + func (b *TxBuilder) SetFundedPsbt(fundedPsbt []byte) *TxBuilder + func (b *TxBuilder) SetPassivePsbts(passivePsbts [][]byte) *TxBuilder + func (b *TxBuilder) SetRecipients(recipients []Recipient) *TxBuilder + func (b *TxBuilder) SetSignedPsbt(signedPsbt []byte) *TxBuilder + func (b *TxBuilder) Sign(ctx context.Context) ([]byte, error) + type TxBuilderOption func(*txBuilderOptions) + func WithSkipBroadcast() TxBuilderOption + type TxOut struct + PkScript []byte + Value int64 + type Universe struct + func NewUniverse(client UniverseClient) *Universe + func (u *Universe) GetProof(ctx context.Context, ref AssetRef, leafKey AssetLeafKey, ...) (*UniverseProof, error) + func (u *Universe) GetRoots(ctx context.Context, ref AssetRef) (*UniverseRoots, error) + func (u *Universe) HasAsset(ctx context.Context, ref AssetRef) (bool, error) + func (u *Universe) ListProofs(ctx context.Context, ref AssetRef, opts ...UniverseProofOption) ([]*UniverseProof, error) + func (u *Universe) SyncAsset(ctx context.Context, ref AssetRef, host string, opts ...UniverseSyncOption) (*UniverseSyncResult, error) + func (u *Universe) SyncAssets(ctx context.Context, refs []AssetRef, host string, opts ...UniverseSyncOption) ([]*UniverseSyncResult, error) + type UniverseClient interface + AddFederationServer func(ctx context.Context, servers []FederationServer) error + AssetLeafKeys func(ctx context.Context, req *AssetLeafKeysRequest) ([]AssetLeafKey, error) + AssetLeaves func(ctx context.Context, id *UniverseID) ([]AssetLeaf, error) + AssetRoots func(ctx context.Context, req *AssetRootRequest) (map[string]*UniverseRoot, error) + DeleteAssetRoot func(ctx context.Context, id *UniverseID) error + DeleteFederationServer func(ctx context.Context, servers []FederationServer) error + Info func(ctx context.Context) (*UniverseInfo, error) + InsertProof func(ctx context.Context, rawProof []byte, decoded *DecodedProof) error + ListFederationServers func(ctx context.Context) ([]FederationServer, error) + QueryAssetRoots func(ctx context.Context, id *UniverseID) (*QueryRootResponse, error) + QueryAssetStats func(ctx context.Context, req *AssetStatsQuery) ([]AssetStatsSnapshot, error) + QueryEvents func(ctx context.Context, req *QueryEventsRequest) ([]GroupedUniverseEvents, error) + QueryFederationSyncConfig func(ctx context.Context, ids []UniverseID) (*FederationSyncConfig, error) + QueryProof func(ctx context.Context, key *UniverseKey) (*AssetProofResponse, error) + SetFederationSyncConfig func(ctx context.Context, global []GlobalFederationSyncConfig, ...) error + SyncUniverse func(ctx context.Context, req *SyncRequest) ([]SyncedUniverse, error) + UniverseStats func(ctx context.Context) (*UniverseStats, error) + type UniverseID struct + AssetRef AssetRef + ProofType ProofType + func UniverseIDFromRef(ref AssetRef, proofType ProofType) UniverseID + type UniverseInfo struct + RuntimeID int64 + type UniverseKey struct + ID UniverseID + LeafKey AssetLeafKey + type UniverseProof struct + Asset *AssetRecord + AssetRef AssetRef + LeafKey AssetLeafKey + MultiverseInclusionProof []byte + MultiverseRoot *MerkleSumNode + Proof []byte + ProofType ProofType + UniverseInclusionProof []byte + UniverseRoot *UniverseRoot + type UniverseProofOption func(*universeProofOptions) + func WithUniverseProofDirection(direction SortDirection) UniverseProofOption + func WithUniverseProofPage(offset, limit int32) UniverseProofOption + func WithUniverseProofType(proofType ProofType) UniverseProofOption + type UniverseRoot struct + AmountsByIssuanceID map[string]uint64 + AssetName string + ID UniverseID + MSSMTRoot *MerkleSumNode + type UniverseRoots struct + AssetRef AssetRef + IssuanceRoot *UniverseRoot + TransferRoot *UniverseRoot + func (r *UniverseRoots) HasRoots() bool + type UniverseStats struct + NumTotalAssets int64 + NumTotalGroups int64 + NumTotalProofs int64 + NumTotalSyncs int64 + type UniverseSyncMode int + const SyncFull + const SyncIssuanceOnly + type UniverseSyncOption func(*universeSyncOptions) + func WithUniverseSyncMode(mode UniverseSyncMode) UniverseSyncOption + type UniverseSyncResult struct + AssetRef AssetRef + Issuance *SyncedUniverse + Transfer *SyncedUniverse + type UnsealedMintAsset struct + Asset *PendingMintAsset + GroupKeyRequest *GroupKeyRequest + GroupVirtualPSBT string + GroupVirtualTx *GroupVirtualTx + type VerboseMintingBatch struct + Batch MintingBatch + UnsealedAssets []UnsealedMintAsset + type VerifyOwnershipRequest struct + Challenge []byte + ProofWithWitness []byte + type VerifyOwnershipResponse struct + BlockHash Hash + BlockHeight uint32 + Outpoint Outpoint + Valid bool + type VerifyProofResponse struct + DecodedProof *DecodedProof + Valid bool + type Wallet struct + func NewWallet(client Client, network Network, opts ...WalletOption) *Wallet + func (s *Wallet) Burn(ctx context.Context, ref AssetRef, amount uint64, opts ...BurnOption) (*Burn, error) + func (s *Wallet) Client() Client + func (s *Wallet) Close() error + func (s *Wallet) DeriveKeys(ctx context.Context) (*DerivedKeys, error) + func (s *Wallet) ExportProof(ctx context.Context, ref AssetRef) (*ProofBundle, error) + func (s *Wallet) ExportProofFile(ctx context.Context, ref AssetRef, scriptKey PubKey, outpoint *Outpoint) (*ProofFile, error) + func (s *Wallet) GetBalance(ctx context.Context, ref AssetRef) (uint64, error) + func (s *Wallet) ImportProof(ctx context.Context, bundle *ProofBundle) ([]*RegisteredAsset, error) + func (s *Wallet) ImportProofFile(ctx context.Context, proofFile *ProofFile) (*RegisteredAsset, error) + func (s *Wallet) ListAssets(ctx context.Context, req *ListAssetsRequest) ([]*Asset, error) + func (s *Wallet) ListBalances(ctx context.Context, req *ListBalancesRequest) (*ListBalancesResponse, error) + func (s *Wallet) ListBurns(ctx context.Context, req *ListBurnsRequest) ([]*BurnRecord, error) + func (s *Wallet) ListCollectionItems(ctx context.Context, req *ListCollectionItemsRequest) ([]*Asset, error) + func (s *Wallet) ListCollections(ctx context.Context, req *ListCollectionsRequest) ([]*Collection, error) + func (s *Wallet) ListIssuances(ctx context.Context, req *ListIssuancesRequest) ([]*Issuance, error) + func (s *Wallet) ListTransfers(ctx context.Context, req *ListTransfersRequest) ([]*Transfer, error) + func (s *Wallet) NewInteractiveTxBuilder() *InteractiveTxBuilder + func (s *Wallet) NewIssuer() *Issuer + func (s *Wallet) NewReceiveAddress(ctx context.Context, ref AssetRef) (*Address, error) + func (s *Wallet) NewTxBuilder() *TxBuilder + func (s *Wallet) NewUniverse() *Universe + func (s *Wallet) ProveOwnership(ctx context.Context, ref AssetRef, opts ...OwnershipOption) (*OwnershipProofSet, error) + func (s *Wallet) Send(ctx context.Context, addr string, opts ...SendOption) (*AssetTransfer, error) + func (s *Wallet) SendMulti(ctx context.Context, recipients []Recipient, opts ...SendOption) (*AssetTransfer, error) + func (s *Wallet) VerifyOwnership(ctx context.Context, proof []byte, opts ...OwnershipOption) (*VerifyOwnershipResponse, error) + type WalletClient interface + AddrReceives func(ctx context.Context, query *AddressReceivesQuery) ([]*AddressEvent, error) + BurnAsset func(ctx context.Context, req *BurnAssetRequest) (*BurnAssetResponse, error) + DecodeAddr func(ctx context.Context, addr string) (*Address, error) + FetchAssetMeta func(ctx context.Context, req *FetchAssetMetaRequest) (*AssetMeta, error) + GetInfo func(ctx context.Context) (*Info, error) + ListAssetGroups func(ctx context.Context) ([]AssetGroupRecord, error) + ListAssetRecords func(ctx context.Context, req *ListAssetsRequest) ([]*AssetRecord, error) + ListBalances func(ctx context.Context, req *ListBalancesRequest) (*ListBalancesResponse, error) + ListBurns func(ctx context.Context, req *ListBurnsRequest) ([]*BurnRecord, error) + ListTransfers func(ctx context.Context, req *ListTransfersRequest) ([]*AssetTransfer, error) + ListUtxos func(ctx context.Context, req *ListUtxosRequest) (map[string]*ManagedUtxo, error) + NewAddr func(ctx context.Context, req *NewAddressRequest) (*Address, error) + QueryAddrs func(ctx context.Context, query *AddressQuery) ([]*Address, error) + SendAsset func(ctx context.Context, req *SendAssetRequest) (*AssetTransfer, error) + VerifyProof func(ctx context.Context, rawProofFile []byte) (*VerifyProofResponse, error) + type WalletKitClient interface + AnchorVirtualPsbts func(ctx context.Context, signedPsbts [][]byte) (*AssetTransfer, error) + CommitVirtualPsbts func(ctx context.Context, virtualPsbts [][]byte, passivePsbts [][]byte, ...) (*CommittedTransfer, error) + DeclareScriptKey func(ctx context.Context, req *DeclareScriptKeyRequest) (*ScriptKey, error) + DeriveInternalKey func(ctx context.Context) (*InternalKey, error) + DeriveScriptKey func(ctx context.Context) (*ScriptKey, error) + ExportBackup func(ctx context.Context, mode BackupMode) ([]byte, error) + FundInteractivePsbt func(ctx context.Context, psbt []byte) (*FundedTransfer, error) + FundTransfer func(ctx context.Context, recipients []Recipient, inputs []PrevID) (*FundedTransfer, error) + ImportBackup func(ctx context.Context, backup []byte) (uint32, error) + ProveAssetOwnership func(ctx context.Context, req *ProveOwnershipRequest) (*OwnershipProof, error) + PublishAndLogTransfer func(ctx context.Context, anchorPsbt []byte, virtualPsbts [][]byte, ...) (*AssetPacket, error) + QueryInternalKey func(ctx context.Context, internalKey []byte) (*KeyDescriptor, error) + QueryScriptKey func(ctx context.Context, tweakedScriptKey []byte) (*ScriptKey, error) + RemoveUTXOLease func(ctx context.Context, outpoint Outpoint) error + SignVirtualPsbt func(ctx context.Context, fundedPsbt []byte) ([]byte, error) + VerifyAssetOwnership func(ctx context.Context, req *VerifyOwnershipRequest) (*VerifyOwnershipResponse, error) + type WalletOption func(*Wallet) + func WithAuthMailboxCourier(host string) WalletOption + func WithDefaultProofCourierAddr(addr string) WalletOption + type XOnlyPubKey [32]byte + func ParseXOnlyPubKey(b []byte) (XOnlyPubKey, error) + func (k XOnlyPubKey) Bytes() []byte
Go to main page