Documentation
¶
Index ¶
- Constants
- type Address
- type Asset
- type AssetInfo
- type Config
- type ConfigStore
- type ControlAsset
- type DeprecatedSigner
- type ExistingControlAsset
- type FeeInfo
- type NewControlAsset
- type OnchainAddressEvent
- type OnchainOutput
- type Outpoint
- type Receiver
- type Store
- type StreamConnectionEvent
- type StreamConnectionState
- type SyncEvent
- type Transaction
- type TransactionEvent
- type TransactionKey
- type TxEventType
- type TxType
- type Utxo
- type UtxoEvent
- type UtxoEventType
- type Vtxo
- type VtxoEvent
- type VtxoEventType
- type VtxoWithTapTree
Constants ¶
View Source
const ( InMemoryStore = "inmemory" FileStore = "file" KVStore = "kv" SQLStore = "sql" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
ServerUrl string
SignerPubKey *btcec.PublicKey
ForfeitPubKey *btcec.PublicKey
WalletType string
Network arklib.Network
SessionDuration int64
UnilateralExitDelay arklib.RelativeLocktime
Dust uint64
BoardingExitDelay arklib.RelativeLocktime
ExplorerURL string
ForfeitAddress string
UtxoMinAmount int64
UtxoMaxAmount int64
VtxoMinAmount int64
VtxoMaxAmount int64
CheckpointTapscript string
Fees FeeInfo
}
func (Config) CheckpointExitPath ¶
type ConfigStore ¶
type ControlAsset ¶
type ControlAsset interface {
// contains filtered or unexported methods
}
ControlAsset represents the control asset configuration for issuing new assets. Use either NewControlAsset to create a new control asset, or ExistingControlAsset
type DeprecatedSigner ¶
type ExistingControlAsset ¶
type ExistingControlAsset struct {
ID string
}
ExistingControlAsset references an existing control asset by its ID.
type NewControlAsset ¶
type NewControlAsset struct {
Amount uint64
}
NewControlAsset creates a new control asset with the specified amount.
type OnchainAddressEvent ¶
type OnchainAddressEvent struct {
Error error
SpentUtxos []OnchainOutput
NewUtxos []OnchainOutput
ConfirmedUtxos []OnchainOutput
Replacements map[string]string // replacedTxid -> replacementTxid
}
type OnchainOutput ¶
type Receiver ¶
func (Receiver) ToArkFeeOutput ¶
type Store ¶
type Store interface {
ConfigStore() ConfigStore
Clean(ctx context.Context)
Close()
}
type StreamConnectionEvent ¶
type StreamConnectionState ¶
type StreamConnectionState string
const ( StreamConnectionStateDisconnected StreamConnectionState = "DISCONNECTED" StreamConnectionStateReconnected StreamConnectionState = "RECONNECTED" StreamConnectionStateReady StreamConnectionState = "READY" )
type Transaction ¶
type Transaction struct {
TransactionKey
Amount uint64
Type TxType
CreatedAt time.Time
Hex string
SettledBy string
AssetPacket asset.Packet
}
func (Transaction) String ¶
func (t Transaction) String() string
type TransactionEvent ¶
type TransactionEvent struct {
Type TxEventType
Txs []Transaction
Replacements map[string]string
}
type TransactionKey ¶
func (TransactionKey) String ¶
func (t TransactionKey) String() string
type TxEventType ¶
type TxEventType int
const ( TxsAdded TxEventType = iota TxsSettled TxsConfirmed TxsReplaced TxsUpdated )
func (TxEventType) String ¶
func (e TxEventType) String() string
type Utxo ¶
type Utxo struct {
Outpoint
Amount uint64
Script string
Delay arklib.RelativeLocktime
SpendableAt time.Time
CreatedAt time.Time
Tapscripts []string
Spent bool
SpentBy string
Tx string
}
func (Utxo) IsConfirmed ¶
func (Utxo) ToArkFeeInput ¶
func (u Utxo) ToArkFeeInput() arkfee.OnchainInput
type UtxoEvent ¶
type UtxoEvent struct {
Type UtxoEventType
Utxos []Utxo
}
type UtxoEventType ¶
type UtxoEventType int
const ( UtxosAdded UtxoEventType = iota UtxosConfirmed UtxosReplaced UtxosSpent )
func (UtxoEventType) String ¶
func (e UtxoEventType) String() string
type Vtxo ¶
type Vtxo struct {
Outpoint
Script string
Amount uint64
CommitmentTxids []string
ExpiresAt time.Time
CreatedAt time.Time
Preconfirmed bool
Swept bool
Unrolled bool
Spent bool
SpentBy string
SettledBy string
ArkTxid string
Assets []Asset
}
func (Vtxo) IsRecoverable ¶
type VtxoEvent ¶
type VtxoEvent struct {
Type VtxoEventType
Vtxos []Vtxo
}
type VtxoEventType ¶
type VtxoEventType int
const ( VtxosAdded VtxoEventType = iota VtxosSpent VtxosUpdated )
func (VtxoEventType) String ¶
func (e VtxoEventType) String() string
type VtxoWithTapTree ¶
func (VtxoWithTapTree) ToArkFeeInput ¶
func (v VtxoWithTapTree) ToArkFeeInput() arkfee.OffchainInput
Click to show internal directories.
Click to hide internal directories.