Documentation
¶
Index ¶
- Constants
- Variables
- type AddressEvent
- type Info
- type Input
- type Outpoint
- type Output
- type RedeemTransaction
- type Round
- type RoundEvent
- type RoundEventChannel
- type RoundFailedEvent
- type RoundFinalizationEvent
- type RoundFinalizedEvent
- type RoundSigningNoncesGeneratedEvent
- type RoundSigningStartedEvent
- type RoundStage
- type RoundTransaction
- type TapscriptsVtxo
- type TransactionEvent
- type TransportClient
- type Vtxo
Constants ¶
View Source
const ( GrpcClient = "grpc" RestClient = "rest" )
Variables ¶
View Source
var (
ErrConnectionClosedByServer = fmt.Errorf("connection closed by server")
)
Functions ¶
This section is empty.
Types ¶
type AddressEvent ¶
type Info ¶
type Info struct {
Version string
PubKey string
VtxoTreeExpiry int64
UnilateralExitDelay int64
RoundInterval int64
Network string
Dust uint64
BoardingExitDelay int64
BoardingDescriptorTemplate string
ForfeitAddress string
MarketHourStartTime int64
MarketHourEndTime int64
MarketHourPeriod int64
MarketHourRoundInterval int64
UtxoMinAmount int64
UtxoMaxAmount int64
VtxoMinAmount int64
VtxoMaxAmount int64
}
type RedeemTransaction ¶
type RoundEvent ¶
type RoundEvent interface {
// contains filtered or unexported methods
}
type RoundEventChannel ¶
type RoundEventChannel struct {
Event RoundEvent
Err error
}
type RoundFailedEvent ¶
type RoundFinalizationEvent ¶
type RoundFinalizedEvent ¶
type RoundSigningNoncesGeneratedEvent ¶
type RoundSigningNoncesGeneratedEvent struct {
ID string
Nonces tree.TreeNonces
}
type RoundStage ¶
type RoundStage int
const ( RoundStageUndefined RoundStage = iota RoundStageRegistration RoundStageFinalization RoundStageFinalized RoundStageFailed )
func (RoundStage) String ¶
func (s RoundStage) String() string
type RoundTransaction ¶
type TapscriptsVtxo ¶
type TransactionEvent ¶
type TransactionEvent struct {
Round *RoundTransaction
Redeem *RedeemTransaction
Err error
}
type TransportClient ¶
type TransportClient interface {
GetInfo(ctx context.Context) (*Info, error)
RegisterInputsForNextRound(
ctx context.Context, inputs []Input,
) (string, error)
RegisterIntent(
ctx context.Context, signature, message string,
) (string, error)
RegisterNotesForNextRound(
ctx context.Context, notes []string,
) (string, error)
RegisterOutputsForNextRound(
ctx context.Context, requestID string, outputs []Output, musig2 *tree.Musig2,
) error
SubmitTreeNonces(
ctx context.Context, roundID, cosignerPubkey string, nonces tree.TreeNonces,
) error
SubmitTreeSignatures(
ctx context.Context, roundID, cosignerPubkey string, signatures tree.TreePartialSigs,
) error
SubmitSignedForfeitTxs(
ctx context.Context, signedForfeitTxs []string, signedRoundTx string,
) error
GetEventStream(
ctx context.Context, requestID string,
) (<-chan RoundEventChannel, func(), error)
Ping(ctx context.Context, requestID string) error
SubmitRedeemTx(
ctx context.Context, partialSignedRedeemTx string,
) (signedRedeemTx, redeemTxid string, err error)
ListVtxos(ctx context.Context, addr string) ([]Vtxo, []Vtxo, error)
GetRound(ctx context.Context, txID string) (*Round, error)
GetRoundByID(ctx context.Context, roundID string) (*Round, error)
Close()
GetTransactionsStream(ctx context.Context) (<-chan TransactionEvent, func(), error)
SubscribeForAddress(ctx context.Context, address string) (<-chan AddressEvent, func(), error)
}
Click to show internal directories.
Click to hide internal directories.