models

type ProtobufAny struct {

	// at type
	AtType string `json:"@type,omitempty"`

	// protobuf any
	ProtobufAny map[string]interface{} `json:"-"`
}

type RPCStatus struct {

	// code
	Code int32 `json:"code,omitempty"`

	// details
	Details []*ProtobufAny `json:"details"`

	// message
	Message string `json:"message,omitempty"`
}

type V1Bip322Signature struct {

	// message
	Message string `json:"message,omitempty"`

	// signature
	Signature string `json:"signature,omitempty"`
}

type V1GetBoardingAddressRequest struct {

	// pubkey
	Pubkey string `json:"pubkey,omitempty"`
}

type V1GetBoardingAddressResponse struct {

	// address
	Address string `json:"address,omitempty"`

	// descriptor
	Descriptor string `json:"descriptor,omitempty"`

	// tapscripts
	Tapscripts *V1Tapscripts `json:"tapscripts,omitempty"`
}

type V1GetEventStreamResponse struct {

	// round failed
	RoundFailed *V1RoundFailed `json:"roundFailed,omitempty"`

	// round finalization
	RoundFinalization *V1RoundFinalizationEvent `json:"roundFinalization,omitempty"`

	// round finalized
	RoundFinalized *V1RoundFinalizedEvent `json:"roundFinalized,omitempty"`

	// round signing
	RoundSigning *V1RoundSigningEvent `json:"roundSigning,omitempty"`

	// round signing nonces generated
	RoundSigningNoncesGenerated *V1RoundSigningNoncesGeneratedEvent `json:"roundSigningNoncesGenerated,omitempty"`
}

type V1GetInfoResponse struct {

	// boarding descriptor template
	BoardingDescriptorTemplate string `json:"boardingDescriptorTemplate,omitempty"`

	// boarding exit delay
	BoardingExitDelay string `json:"boardingExitDelay,omitempty"`

	// dust
	Dust string `json:"dust,omitempty"`

	// forfeit address
	ForfeitAddress string `json:"forfeitAddress,omitempty"`

	// market hour
	MarketHour *V1MarketHour `json:"marketHour,omitempty"`

	// network
	Network string `json:"network,omitempty"`

	// pubkey
	Pubkey string `json:"pubkey,omitempty"`

	// round interval
	RoundInterval string `json:"roundInterval,omitempty"`

	// unilateral exit delay
	UnilateralExitDelay string `json:"unilateralExitDelay,omitempty"`

	// -1 means no limit (default), 0 means boarding not allowed
	UtxoMaxAmount string `json:"utxoMaxAmount,omitempty"`

	// -1 means native dust limit (default)
	UtxoMinAmount string `json:"utxoMinAmount,omitempty"`

	// version
	Version string `json:"version,omitempty"`

	// vtxo descriptor templates
	VtxoDescriptorTemplates []string `json:"vtxoDescriptorTemplates"`

	// -1 means no limit (default)
	VtxoMaxAmount string `json:"vtxoMaxAmount,omitempty"`

	// -1 means native dust limit (default)
	VtxoMinAmount string `json:"vtxoMinAmount,omitempty"`

	// vtxo tree expiry
	VtxoTreeExpiry string `json:"vtxoTreeExpiry,omitempty"`
}

type V1GetRoundByIDResponse struct {

	// round
	Round *V1Round `json:"round,omitempty"`
}

type V1GetRoundResponse struct {

	// round
	Round *V1Round `json:"round,omitempty"`
}

type V1GetTransactionsStreamResponse struct {

	// redeem
	Redeem *V1RedeemTransaction `json:"redeem,omitempty"`

	// round
	Round *V1RoundTransaction `json:"round,omitempty"`
}

type V1Input struct {

	// descriptor
	Descriptor string `json:"descriptor,omitempty"`

	// outpoint
	Outpoint *V1Outpoint `json:"outpoint,omitempty"`

	// tapscripts
	Tapscripts *V1Tapscripts `json:"tapscripts,omitempty"`
}

type V1ListVtxosResponse struct {

	// spendable vtxos
	SpendableVtxos []*V1Vtxo `json:"spendableVtxos"`

	// spent vtxos
	SpentVtxos []*V1Vtxo `json:"spentVtxos"`
}

type V1MarketHour struct {

	// next end time
	NextEndTime string `json:"nextEndTime,omitempty"`

	// next start time
	NextStartTime string `json:"nextStartTime,omitempty"`

	// period
	Period string `json:"period,omitempty"`

	// round interval
	RoundInterval string `json:"roundInterval,omitempty"`
}

type V1Musig2 struct {

	// cosigners public keys
	CosignersPublicKeys []string `json:"cosignersPublicKeys"`

	// signing all
	SigningAll bool `json:"signingAll,omitempty"`
}

type V1Node struct {

	// parent txid
	ParentTxid string `json:"parentTxid,omitempty"`

	// tx
	Tx string `json:"tx,omitempty"`

	// txid
	Txid string `json:"txid,omitempty"`
}

type V1Outpoint struct {

	// txid
	Txid string `json:"txid,omitempty"`

	// vout
	Vout int64 `json:"vout,omitempty"`
}

type V1Output struct {

	// onchain or off-chain
	Address string `json:"address,omitempty"`

	// Amount to send in satoshis.
	Amount string `json:"amount,omitempty"`
}

type V1PingResponse interface{}

type V1RedeemTransaction struct {

	// hex
	Hex string `json:"hex,omitempty"`

	// spendable vtxos
	SpendableVtxos []*V1Vtxo `json:"spendableVtxos"`

	// spent vtxos
	SpentVtxos []*V1Vtxo `json:"spentVtxos"`

	// txid
	Txid string `json:"txid,omitempty"`
}

type V1RegisterInputsForNextRoundRequest struct {

	// inputs
	Inputs []*V1Input `json:"inputs"`

	// notes
	Notes []string `json:"notes"`
}

type V1RegisterInputsForNextRoundResponse struct {

	// request Id
	RequestID string `json:"requestId,omitempty"`
}

type V1RegisterIntentRequest struct {

	// BIP322 signature embeds the outpoints and the proof of funds
	Bip322Signature *V1Bip322Signature `json:"bip322Signature,omitempty"`

	// notes
	Notes []string `json:"notes"`
}

type V1RegisterIntentResponse struct {

	// request Id
	RequestID string `json:"requestId,omitempty"`
}

type V1RegisterOutputsForNextRoundRequest struct {

	// musig2
	Musig2 *V1Musig2 `json:"musig2,omitempty"`

	// List of receivers for to convert to leaves in the next VTXO tree.
	Outputs []*V1Output `json:"outputs"`

	// request Id
	RequestID string `json:"requestId,omitempty"`
}

type V1RegisterOutputsForNextRoundResponse interface{}

type V1Round struct {

	// connectors
	Connectors *V1Tree `json:"connectors,omitempty"`

	// end
	End string `json:"end,omitempty"`

	// forfeit txs
	ForfeitTxs []string `json:"forfeitTxs"`

	// id
	ID string `json:"id,omitempty"`

	// round tx
	RoundTx string `json:"roundTx,omitempty"`

	// stage
	Stage *V1RoundStage `json:"stage,omitempty"`

	// start
	Start string `json:"start,omitempty"`

	// vtxo tree
	VtxoTree *V1Tree `json:"vtxoTree,omitempty"`
}

type V1RoundFailed struct {

	// id
	ID string `json:"id,omitempty"`

	// reason
	Reason string `json:"reason,omitempty"`
}

type V1RoundFinalizationEvent struct {

	// connectors
	Connectors *V1Tree `json:"connectors,omitempty"`

	// vtxo outpoint encoded as string -> connector outpoint
	ConnectorsIndex map[string]V1Outpoint `json:"connectorsIndex,omitempty"`

	// id
	ID string `json:"id,omitempty"`

	// min relay fee rate
	MinRelayFeeRate string `json:"minRelayFeeRate,omitempty"`

	// round tx
	RoundTx string `json:"roundTx,omitempty"`

	// vtxo tree
	VtxoTree *V1Tree `json:"vtxoTree,omitempty"`
}

type V1RoundFinalizedEvent struct {

	// id
	ID string `json:"id,omitempty"`

	// round txid
	RoundTxid string `json:"roundTxid,omitempty"`
}

type V1RoundSigningEvent struct {

	// cosigners pubkeys
	CosignersPubkeys []string `json:"cosignersPubkeys"`

	// id
	ID string `json:"id,omitempty"`

	// unsigned round tx
	UnsignedRoundTx string `json:"unsignedRoundTx,omitempty"`

	// unsigned vtxo tree
	UnsignedVtxoTree *V1Tree `json:"unsignedVtxoTree,omitempty"`
}

type V1RoundSigningNoncesGeneratedEvent struct {

	// id
	ID string `json:"id,omitempty"`

	// tree nonces
	TreeNonces string `json:"treeNonces,omitempty"`
}

type V1RoundStage string

type V1RoundTransaction struct {

	// claimed boarding utxos
	ClaimedBoardingUtxos []*V1Outpoint `json:"claimedBoardingUtxos"`

	// hex
	Hex string `json:"hex,omitempty"`

	// spendable vtxos
	SpendableVtxos []*V1Vtxo `json:"spendableVtxos"`

	// spent vtxos
	SpentVtxos []*V1Vtxo `json:"spentVtxos"`

	// txid
	Txid string `json:"txid,omitempty"`
}

type V1SubmitRedeemTxRequest struct {

	// redeem tx
	RedeemTx string `json:"redeemTx,omitempty"`
}

type V1SubmitRedeemTxResponse struct {

	// signed redeem tx
	SignedRedeemTx string `json:"signedRedeemTx,omitempty"`

	// txid
	Txid string `json:"txid,omitempty"`
}

type V1SubmitSignedForfeitTxsRequest struct {

	// Forfeit txs signed by the user.
	SignedForfeitTxs []string `json:"signedForfeitTxs"`

	// The user has to sign also the round tx if he registerd a boarding UTXO.
	SignedRoundTx string `json:"signedRoundTx,omitempty"`
}

type V1SubmitSignedForfeitTxsResponse interface{}

type V1SubmitTreeNoncesRequest struct {

	// pubkey
	Pubkey string `json:"pubkey,omitempty"`

	// round Id
	RoundID string `json:"roundId,omitempty"`

	// tree nonces
	TreeNonces string `json:"treeNonces,omitempty"`
}

type V1SubmitTreeNoncesResponse interface{}

type V1SubmitTreeSignaturesRequest struct {

	// pubkey
	Pubkey string `json:"pubkey,omitempty"`

	// round Id
	RoundID string `json:"roundId,omitempty"`

	// tree signatures
	TreeSignatures string `json:"treeSignatures,omitempty"`
}

type V1SubmitTreeSignaturesResponse interface{}

type V1SubscribeForAddressResponse struct {

	// new vtxos
	NewVtxos []*V1Vtxo `json:"newVtxos"`

	// spent vtxos
	SpentVtxos []*V1Vtxo `json:"spentVtxos"`
}

type V1Tapscripts struct {

	// scripts
	Scripts []string `json:"scripts"`
}

type V1Tree struct {

	// levels
	Levels []*V1TreeLevel `json:"levels"`
}

type V1TreeLevel struct {

	// nodes
	Nodes []*V1Node `json:"nodes"`
}

type V1Vtxo struct {

	// amount
	Amount string `json:"amount,omitempty"`

	// created at
	CreatedAt string `json:"createdAt,omitempty"`

	// expire at
	ExpireAt string `json:"expireAt,omitempty"`

	// is pending
	IsPending bool `json:"isPending,omitempty"`

	// outpoint
	Outpoint *V1Outpoint `json:"outpoint,omitempty"`

	// pubkey
	Pubkey string `json:"pubkey,omitempty"`

	// redeem tx
	RedeemTx string `json:"redeemTx,omitempty"`

	// round txid
	RoundTxid string `json:"roundTxid,omitempty"`

	// spent
	Spent bool `json:"spent,omitempty"`

	// spent by
	SpentBy string `json:"spentBy,omitempty"`

	// swept
	Swept bool `json:"swept,omitempty"`
}