mintrpc

type BatchState int32

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

type CancelBatchResponse struct {

	// The internal public key of the batch.
	BatchKey []byte `protobuf:"bytes,1,opt,name=batch_key,json=batchKey,proto3" json:"batch_key,omitempty"`
	// contains filtered or unexported fields
}

type FinalizeBatchRequest struct {

	// If true, then the assets currently in the batch won't be returned in the
	// response. This is mainly to avoid a lot of data being transmitted and
	// possibly printed on the command line in the case of a very large batch.
	ShortResponse bool `protobuf:"varint,1,opt,name=short_response,json=shortResponse,proto3" json:"short_response,omitempty"`
	// The optional fee rate to use for the minting transaction, in sat/kw.
	FeeRate uint32 `protobuf:"varint,2,opt,name=fee_rate,json=feeRate,proto3" json:"fee_rate,omitempty"`
	// The optional tapscript sibling that will be used when deriving the genesis
	// output for the batch. This sibling is a tapscript tree, which allows the
	// minter to encumber future transfers of assets in the batch with Tapscript.
	//
	// Types that are valid to be assigned to BatchSibling:
	//
	//	*FinalizeBatchRequest_FullTree
	//	*FinalizeBatchRequest_Branch
	BatchSibling isFinalizeBatchRequest_BatchSibling `protobuf_oneof:"batch_sibling"`
	// contains filtered or unexported fields
}

type FinalizeBatchRequest_Branch struct {
	// A TapBranch that represents a Tapscript tree managed externally.
	Branch *taprpc.TapBranch `protobuf:"bytes,4,opt,name=branch,proto3,oneof"`
}

type FinalizeBatchRequest_FullTree struct {
	// An ordered list of TapLeafs, which will be used to construct a
	// Tapscript tree.
	FullTree *taprpc.TapscriptFullTree `protobuf:"bytes,3,opt,name=full_tree,json=fullTree,proto3,oneof"`
}

type FinalizeBatchResponse struct {

	// The finalized batch.
	Batch *MintingBatch `protobuf:"bytes,1,opt,name=batch,proto3" json:"batch,omitempty"`
	// contains filtered or unexported fields
}

type FundBatchRequest struct {

	// If true, then the assets currently in the batch won't be returned in the
	// response. This is mainly to avoid a lot of data being transmitted and
	// possibly printed on the command line in the case of a very large batch.
	ShortResponse bool `protobuf:"varint,1,opt,name=short_response,json=shortResponse,proto3" json:"short_response,omitempty"`
	// The optional fee rate to use for the minting transaction, in sat/kw.
	FeeRate uint32 `protobuf:"varint,2,opt,name=fee_rate,json=feeRate,proto3" json:"fee_rate,omitempty"`
	// The optional tapscript sibling that will be used when deriving the genesis
	// output for the batch. This sibling is a tapscript tree, which allows the
	// minter to encumber future transfers of assets in the batch with Tapscript.
	//
	// Types that are valid to be assigned to BatchSibling:
	//
	//	*FundBatchRequest_FullTree
	//	*FundBatchRequest_Branch
	BatchSibling isFundBatchRequest_BatchSibling `protobuf_oneof:"batch_sibling"`
	// contains filtered or unexported fields
}

type FundBatchRequest_Branch struct {
	// A TapBranch that represents a Tapscript tree managed externally.
	Branch *taprpc.TapBranch `protobuf:"bytes,4,opt,name=branch,proto3,oneof"`
}

type FundBatchRequest_FullTree struct {
	// An ordered list of TapLeafs, which will be used to construct a
	// Tapscript tree.
	FullTree *taprpc.TapscriptFullTree `protobuf:"bytes,3,opt,name=full_tree,json=fullTree,proto3,oneof"`
}

type FundBatchResponse struct {

	// The funded batch.
	Batch *VerboseBatch `protobuf:"bytes,1,opt,name=batch,proto3" json:"batch,omitempty"`
	// contains filtered or unexported fields
}

type ListBatchRequest struct {

	// The optional batch key of the batch to list.
	//
	// Types that are valid to be assigned to Filter:
	//
	//	*ListBatchRequest_BatchKey
	//	*ListBatchRequest_BatchKeyStr
	Filter isListBatchRequest_Filter `protobuf_oneof:"filter"`
	// If true, pending asset group details will be included for any funded,
	// non-empty pending batch. Unfunded or empty batches will be excluded.
	Verbose bool `protobuf:"varint,3,opt,name=verbose,proto3" json:"verbose,omitempty"`
	// contains filtered or unexported fields
}

type ListBatchRequest_BatchKey struct {
	// The optional batch key of the batch to list, specified as raw bytes
	// (gRPC only).
	BatchKey []byte `protobuf:"bytes,1,opt,name=batch_key,json=batchKey,proto3,oneof"`
}

type ListBatchRequest_BatchKeyStr struct {
	// The optional batch key of the batch to list, specified as a hex
	// encoded string (use this for REST).
	BatchKeyStr string `protobuf:"bytes,2,opt,name=batch_key_str,json=batchKeyStr,proto3,oneof"`
}

type ListBatchResponse struct {
	Batches []*VerboseBatch `protobuf:"bytes,1,rep,name=batches,proto3" json:"batches,omitempty"`
	// contains filtered or unexported fields
}

type MintAsset struct {

	// The version of asset to mint.
	AssetVersion taprpc.AssetVersion `protobuf:"varint,1,opt,name=asset_version,json=assetVersion,proto3,enum=taprpc.AssetVersion" json:"asset_version,omitempty"`
	// The type of the asset to be created.
	AssetType taprpc.AssetType `protobuf:"varint,2,opt,name=asset_type,json=assetType,proto3,enum=taprpc.AssetType" json:"asset_type,omitempty"`
	// The name, or "tag" of the asset. This will affect the final asset ID.
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// A blob that resents metadata related to the asset. This will affect the
	// final asset ID.
	AssetMeta *taprpc.AssetMeta `protobuf:"bytes,4,opt,name=asset_meta,json=assetMeta,proto3" json:"asset_meta,omitempty"`
	// The total amount of units of the new asset that should be created. If the
	// AssetType is Collectible, then this field cannot be set.
	Amount uint64 `protobuf:"varint,5,opt,name=amount,proto3" json:"amount,omitempty"`
	// If true, then the asset will be created with a group key, which allows for
	// future asset issuance.
	NewGroupedAsset bool `protobuf:"varint,6,opt,name=new_grouped_asset,json=newGroupedAsset,proto3" json:"new_grouped_asset,omitempty"`
	// If true, then a group key or group anchor can be set to mint this asset into
	// an existing asset group.
	GroupedAsset bool `protobuf:"varint,7,opt,name=grouped_asset,json=groupedAsset,proto3" json:"grouped_asset,omitempty"`
	// The specific existing group key this asset should be minted with.
	GroupKey []byte `protobuf:"bytes,8,opt,name=group_key,json=groupKey,proto3" json:"group_key,omitempty"`
	// The name of the asset in the batch that will anchor a new asset group.
	// This asset will be minted with the same group key as the anchor asset.
	GroupAnchor string `protobuf:"bytes,9,opt,name=group_anchor,json=groupAnchor,proto3" json:"group_anchor,omitempty"`
	// The optional key that will be used as the internal key for an asset group
	// created with this asset.
	//
	// If this field is set then external_group_key must be unset, and vice versa.
	GroupInternalKey *taprpc.KeyDescriptor `protobuf:"bytes,10,opt,name=group_internal_key,json=groupInternalKey,proto3" json:"group_internal_key,omitempty"`
	// An optional root of a Tapscript tree used when constructing a new asset
	// group key. This allows for future asset issuance authorized using a
	// script witness.
	//
	// If an external group key is provided, the V1 scheme for group key script
	// construction will be used, which supports PSBT signing. In this scheme,
	// the user-supplied Tapscript root is extended by two levels of Tapscript
	// siblings that commit to the group anchor's asset ID. As a result, the
	// provided Tapscript root becomes a branch within a larger Tapscript tree,
	// and the final Tapscript root will differ from the one specified here.
	GroupTapscriptRoot []byte `protobuf:"bytes,11,opt,name=group_tapscript_root,json=groupTapscriptRoot,proto3" json:"group_tapscript_root,omitempty"`
	// The optional script key to use for the new asset. If no script key is given,
	// a BIP-86 key will be derived from the underlying wallet.
	ScriptKey *taprpc.ScriptKey `protobuf:"bytes,12,opt,name=script_key,json=scriptKey,proto3" json:"script_key,omitempty"`
	// Decimal display dictates the number of decimal places to shift the amount to
	// the left converting from Taproot Asset integer representation to a
	// UX-recognizable fractional quantity.
	//
	// For example, if the decimal_display value is 2 and there's 100 of those
	// assets, then a wallet would display the amount as "1.00". This field is
	// intended as information for wallets that display balances and has no impact
	// on the behavior of the daemon or any other part of the protocol. This value
	// is encoded in the MetaData field as a JSON field, therefore it is only
	// compatible with assets that have a JSON MetaData field.
	DecimalDisplay uint32 `protobuf:"varint,13,opt,name=decimal_display,json=decimalDisplay,proto3" json:"decimal_display,omitempty"`
	// The external group key is an optional field that allows specifying an
	// external signing key for the group virtual transaction during minting.
	// This key enables signing operations to be performed externally, outside
	// the daemon.
	//
	// If this field is set then group_internal_key must be unset, and vice versa.
	ExternalGroupKey *taprpc.ExternalKey `protobuf:"bytes,14,opt,name=external_group_key,json=externalGroupKey,proto3" json:"external_group_key,omitempty"`
	// Enables the supply commitments feature for a new asset group.
	//
	// Supply commitments are minter‑controlled, on‑chain attestations that
	// anchor and verify the evolving aggregate supply state of an asset group.
	//
	// When enabled, the batch must be a single asset group (all assets share the
	// same group key). Valid only for creating a new asset group (the first
	// minting tranche).
	EnableSupplyCommitments bool `` /* 134-byte string literal not displayed */
	// contains filtered or unexported fields
}

type MintAssetRequest struct {

	// The asset to be minted.
	Asset *MintAsset `protobuf:"bytes,1,opt,name=asset,proto3" json:"asset,omitempty"`
	// If true, then the assets currently in the batch won't be returned in the
	// response. This is mainly to avoid a lot of data being transmitted and
	// possibly printed on the command line in the case of a very large batch.
	ShortResponse bool `protobuf:"varint,2,opt,name=short_response,json=shortResponse,proto3" json:"short_response,omitempty"`
	// contains filtered or unexported fields
}

type MintAssetResponse struct {

	// The pending batch the asset was added to.
	PendingBatch *MintingBatch `protobuf:"bytes,1,opt,name=pending_batch,json=pendingBatch,proto3" json:"pending_batch,omitempty"`
	// contains filtered or unexported fields
}

type MintClient interface {
	// tapcli: `assets mint`
	// MintAsset will attempt to mint the set of assets (async by default to
	// ensure proper batching) specified in the request. The pending batch is
	// returned that shows the other pending assets that are part of the next
	// batch. This call will block until the operation succeeds (asset is staged
	// in the batch) or fails.
	MintAsset(ctx context.Context, in *MintAssetRequest, opts ...grpc.CallOption) (*MintAssetResponse, error)
	// tapcli `assets mint fund`
	// FundBatch will attempt to fund the current pending batch with a genesis
	// input, or create a new funded batch if no batch exists yet. This RPC is only
	// needed if a custom witness is needed to finalize the batch. Otherwise,
	// FinalizeBatch can be called directly.
	FundBatch(ctx context.Context, in *FundBatchRequest, opts ...grpc.CallOption) (*FundBatchResponse, error)
	// tapcli `assets mint seal`
	// SealBatch will attempt to seal the current pending batch by creating and
	// validating asset group witness for all assets in the batch. If a witness
	// is not provided, a signature will be derived to serve as the witness. This
	// RPC is only needed if any assets in the batch have a custom asset group key
	// that require an external signer. Otherwise, FinalizeBatch can be called
	// directly.
	SealBatch(ctx context.Context, in *SealBatchRequest, opts ...grpc.CallOption) (*SealBatchResponse, error)
	// tapcli: `assets mint finalize`
	// FinalizeBatch will attempt to finalize the current pending batch.
	FinalizeBatch(ctx context.Context, in *FinalizeBatchRequest, opts ...grpc.CallOption) (*FinalizeBatchResponse, error)
	// tapcli: `assets mint cancel`
	// CancelBatch will attempt to cancel the current pending batch.
	CancelBatch(ctx context.Context, in *CancelBatchRequest, opts ...grpc.CallOption) (*CancelBatchResponse, error)
	// tapcli: `assets mint batches`
	// ListBatches lists the set of batches submitted to the daemon, including
	// pending and cancelled batches.
	ListBatches(ctx context.Context, in *ListBatchRequest, opts ...grpc.CallOption) (*ListBatchResponse, error)
	// tapcli: `events mint`
	// SubscribeMintEvents allows a caller to subscribe to mint events for asset
	// creation batches.
	SubscribeMintEvents(ctx context.Context, in *SubscribeMintEventsRequest, opts ...grpc.CallOption) (Mint_SubscribeMintEventsClient, error)
}

type MintEvent struct {

	// Execute timestamp (Unix timestamp in microseconds).
	Timestamp int64 `protobuf:"varint,1,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// The last state of the batch that was successfully executed. If error
	// below is set, then the batch_state is the state that lead to the error
	// during its execution.
	BatchState BatchState `protobuf:"varint,2,opt,name=batch_state,json=batchState,proto3,enum=mintrpc.BatchState" json:"batch_state,omitempty"`
	// The batch that the event is for.
	Batch *MintingBatch `protobuf:"bytes,3,opt,name=batch,proto3" json:"batch,omitempty"`
	// An optional error, indicating that executing the batch_state failed.
	Error string `protobuf:"bytes,4,opt,name=error,proto3" json:"error,omitempty"`
	// contains filtered or unexported fields
}

type MintServer interface {
	// tapcli: `assets mint`
	// MintAsset will attempt to mint the set of assets (async by default to
	// ensure proper batching) specified in the request. The pending batch is
	// returned that shows the other pending assets that are part of the next
	// batch. This call will block until the operation succeeds (asset is staged
	// in the batch) or fails.
	MintAsset(context.Context, *MintAssetRequest) (*MintAssetResponse, error)
	// tapcli `assets mint fund`
	// FundBatch will attempt to fund the current pending batch with a genesis
	// input, or create a new funded batch if no batch exists yet. This RPC is only
	// needed if a custom witness is needed to finalize the batch. Otherwise,
	// FinalizeBatch can be called directly.
	FundBatch(context.Context, *FundBatchRequest) (*FundBatchResponse, error)
	// tapcli `assets mint seal`
	// SealBatch will attempt to seal the current pending batch by creating and
	// validating asset group witness for all assets in the batch. If a witness
	// is not provided, a signature will be derived to serve as the witness. This
	// RPC is only needed if any assets in the batch have a custom asset group key
	// that require an external signer. Otherwise, FinalizeBatch can be called
	// directly.
	SealBatch(context.Context, *SealBatchRequest) (*SealBatchResponse, error)
	// tapcli: `assets mint finalize`
	// FinalizeBatch will attempt to finalize the current pending batch.
	FinalizeBatch(context.Context, *FinalizeBatchRequest) (*FinalizeBatchResponse, error)
	// tapcli: `assets mint cancel`
	// CancelBatch will attempt to cancel the current pending batch.
	CancelBatch(context.Context, *CancelBatchRequest) (*CancelBatchResponse, error)
	// tapcli: `assets mint batches`
	// ListBatches lists the set of batches submitted to the daemon, including
	// pending and cancelled batches.
	ListBatches(context.Context, *ListBatchRequest) (*ListBatchResponse, error)
	// tapcli: `events mint`
	// SubscribeMintEvents allows a caller to subscribe to mint events for asset
	// creation batches.
	SubscribeMintEvents(*SubscribeMintEventsRequest, Mint_SubscribeMintEventsServer) error
	// contains filtered or unexported methods
}

type Mint_SubscribeMintEventsClient interface {
	Recv() (*MintEvent, error)
	grpc.ClientStream
}

type Mint_SubscribeMintEventsServer interface {
	Send(*MintEvent) error
	grpc.ServerStream
}

type MintingBatch struct {

	// A public key serialized in compressed format that can be used to uniquely
	// identify a pending minting batch. Responses that share the same key will be
	// batched into the same minting transaction.
	BatchKey []byte `protobuf:"bytes,1,opt,name=batch_key,json=batchKey,proto3" json:"batch_key,omitempty"`
	// The transaction ID of the batch. Only populated if the batch has been
	// committed.
	BatchTxid string `protobuf:"bytes,2,opt,name=batch_txid,json=batchTxid,proto3" json:"batch_txid,omitempty"`
	// The state of the batch.
	State BatchState `protobuf:"varint,3,opt,name=state,proto3,enum=mintrpc.BatchState" json:"state,omitempty"`
	// The assets that are part of the batch.
	Assets []*PendingAsset `protobuf:"bytes,4,rep,name=assets,proto3" json:"assets,omitempty"`
	// The time the batch was created as a Unix timestamp (in seconds).
	CreatedAt int64 `protobuf:"varint,5,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// The current height of the block chain at the time of the batch creation.
	HeightHint uint32 `protobuf:"varint,6,opt,name=height_hint,json=heightHint,proto3" json:"height_hint,omitempty"`
	// The genesis transaction as a PSBT packet. Only populated if the batch has
	// been committed.
	BatchPsbt []byte `protobuf:"bytes,7,opt,name=batch_psbt,json=batchPsbt,proto3" json:"batch_psbt,omitempty"`
	// contains filtered or unexported fields
}

type PendingAsset struct {

	// The version of asset to mint.
	AssetVersion taprpc.AssetVersion `protobuf:"varint,1,opt,name=asset_version,json=assetVersion,proto3,enum=taprpc.AssetVersion" json:"asset_version,omitempty"`
	// The type of the asset to be created.
	AssetType taprpc.AssetType `protobuf:"varint,2,opt,name=asset_type,json=assetType,proto3,enum=taprpc.AssetType" json:"asset_type,omitempty"`
	// The name, or "tag" of the asset. This will affect the final asset ID.
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// A blob that resents metadata related to the asset. This will affect the
	// final asset ID.
	AssetMeta *taprpc.AssetMeta `protobuf:"bytes,4,opt,name=asset_meta,json=assetMeta,proto3" json:"asset_meta,omitempty"`
	// The total amount of units of the new asset that should be created. If the
	// AssetType is Collectible, then this field cannot be set.
	Amount uint64 `protobuf:"varint,5,opt,name=amount,proto3" json:"amount,omitempty"`
	// If true, then the asset will be created with a new group key, which allows
	// for future asset issuance.
	NewGroupedAsset bool `protobuf:"varint,6,opt,name=new_grouped_asset,json=newGroupedAsset,proto3" json:"new_grouped_asset,omitempty"`
	// The specific existing group key this asset should be minted with.
	GroupKey []byte `protobuf:"bytes,7,opt,name=group_key,json=groupKey,proto3" json:"group_key,omitempty"`
	// The name of the asset in the batch that will anchor a new asset group.
	// This asset will be minted with the same group key as the anchor asset.
	GroupAnchor string `protobuf:"bytes,8,opt,name=group_anchor,json=groupAnchor,proto3" json:"group_anchor,omitempty"`
	// The optional key that will be used as the internal key for an asset group
	// created with this asset.
	GroupInternalKey *taprpc.KeyDescriptor `protobuf:"bytes,9,opt,name=group_internal_key,json=groupInternalKey,proto3" json:"group_internal_key,omitempty"`
	// The optional root of a tapscript tree that will be used when constructing a
	// new asset group key. This enables future issuance authorized with a script
	// witness.
	GroupTapscriptRoot []byte `protobuf:"bytes,10,opt,name=group_tapscript_root,json=groupTapscriptRoot,proto3" json:"group_tapscript_root,omitempty"`
	// The optional script key to use for the new asset. If no script key is given,
	// a BIP-86 key will be derived from the underlying wallet.
	ScriptKey *taprpc.ScriptKey `protobuf:"bytes,11,opt,name=script_key,json=scriptKey,proto3" json:"script_key,omitempty"`
	// contains filtered or unexported fields
}

type SealBatchRequest struct {

	// If true, then the assets currently in the batch won't be returned in the
	// response. This is mainly to avoid a lot of data being transmitted and
	// possibly printed on the command line in the case of a very large batch.
	ShortResponse bool `protobuf:"varint,1,opt,name=short_response,json=shortResponse,proto3" json:"short_response,omitempty"`
	// The assetID, witness pairs that authorize asset membership in a group.
	// This field should not be used in conjunction with
	// `signed_group_virtual_psbts`; use one or the other.
	GroupWitnesses []*taprpc.GroupWitness `protobuf:"bytes,2,rep,name=group_witnesses,json=groupWitnesses,proto3" json:"group_witnesses,omitempty"`
	// The base64 encoded signed group virtual PSBTs.
	// This field should not be used in conjunction with `group_witnesses`;
	// use one or the other.
	SignedGroupVirtualPsbts []string `` /* 134-byte string literal not displayed */
	// contains filtered or unexported fields
}

type SealBatchResponse struct {

	// The sealed batch.
	Batch *MintingBatch `protobuf:"bytes,1,opt,name=batch,proto3" json:"batch,omitempty"`
	// contains filtered or unexported fields
}

type SubscribeMintEventsRequest struct {

	// If true, then the assets currently in the batch won't be returned in the
	// event's batch. This is mainly to avoid a lot of data being transmitted and
	// possibly printed on the command line in the case of a very large batch.
	ShortResponse bool `protobuf:"varint,1,opt,name=short_response,json=shortResponse,proto3" json:"short_response,omitempty"`
	// contains filtered or unexported fields
}

type UnimplementedMintServer struct {
}

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

type UnsealedAsset struct {

	// The pending asset with an unsealed asset group.
	Asset *PendingAsset `protobuf:"bytes,1,opt,name=asset,proto3" json:"asset,omitempty"`
	// The group key request for the asset.
	GroupKeyRequest *taprpc.GroupKeyRequest `protobuf:"bytes,2,opt,name=group_key_request,json=groupKeyRequest,proto3" json:"group_key_request,omitempty"`
	// The group virtual transaction for the asset.
	GroupVirtualTx *taprpc.GroupVirtualTx `protobuf:"bytes,3,opt,name=group_virtual_tx,json=groupVirtualTx,proto3" json:"group_virtual_tx,omitempty"`
	// The byte serialized PSBT equivalent of the group virtual transaction.
	GroupVirtualPsbt string `protobuf:"bytes,4,opt,name=group_virtual_psbt,json=groupVirtualPsbt,proto3" json:"group_virtual_psbt,omitempty"`
	// contains filtered or unexported fields
}

type VerboseBatch struct {

	// The minting batch, without any assets.
	Batch *MintingBatch `protobuf:"bytes,1,opt,name=batch,proto3" json:"batch,omitempty"`
	// The assets that are part of the batch.
	UnsealedAssets []*UnsealedAsset `protobuf:"bytes,2,rep,name=unsealed_assets,json=unsealedAssets,proto3" json:"unsealed_assets,omitempty"`
	// contains filtered or unexported fields
}