Skip to main content

Crate ark_client

Crate ark_client 

Source

Re-exports§

pub use error::Error;
pub use key_provider::Bip32KeyProvider;
pub use key_provider::KeyProvider;
pub use key_provider::StaticKeyProvider;
pub use swap_storage::InMemorySwapStorage;
pub use swap_storage::SwapStorage;
pub use lightning_invoice;

Modules§

error
key_provider
swap_storage
Swap Storage
vtxo_watcher
Background VTXO watcher that auto-delegates and auto-renews VTXOs.
wallet

Structs§

AddressVtxos
ChainSwapData
Data for a pending chain swap (ARK ↔ BTC).
ChainSwapResult
Result of creating a chain swap.
Client
A client to interact with Ark server
DeprecatedSignerMigrationReport
Result of a Client::migrate_deprecated_signer_vtxos pass, split into two symmetric legs: a VTXO leg and a boarding leg. They are never combined into a single intent.
DeprecatedSignerReport
Read-only, per-signer status of the deprecated server signers the wallet currently holds funds under. Produced by Client::deprecated_signer_status.
IssueAssetResult
Result of an asset issuance.
MigrationLegReport
Outcome of one Client::migrate_deprecated_signer_vtxos leg.
MigrationVtxoRef
A single VTXO or boarding output referenced in a DeprecatedSignerMigrationReport.
OffChainBalance
OfflineClient
A client to interact with Ark Server
PendingVhtlcSpendTx
A pending (submitted but not finalized) VHTLC spend transaction.
ReverseSwapData
Data related to a reverse submarine swap.
SpendStatus
SubmarineSwapData
Data related to a submarine swap.
SwapStatusInfo
Status information for a Boltz swap.
TimeoutBlockHeights
TxStatus

Enums§

ChainSwapAmount
The amount specification for a chain swap.
ChainSwapDirection
Direction of a chain swap.
DeprecatedSignerStatus
Status of a deprecated server signer at a specific point in time.
MigrationSkipReason
Why a single migration leg (DeprecatedSignerMigrationReport::vtxo or DeprecatedSignerMigrationReport::boarding) settled nothing.
PendingVhtlcSpendType
The type of VHTLC spend that was submitted but not yet finalized.
SwapAmount
The amount to be shared with Boltz when creating a reverse submarine swap.
SwapStatus
All possible states of a Boltz swap.
SwapType
The type of a Boltz swap.

Constants§

DEFAULT_BOLTZ_REFERRAL_ID
Default Boltz referralId sent with swap creation requests when the caller does not provide one. Identifies traffic originating from this SDK.
DEFAULT_GAP_LIMIT
Default gap limit for BIP44-style key discovery
MAX_VTXOS_PER_SETTLEMENT
Maximum number of inputs a single deprecated-signer migration leg will settle in one batch.

Traits§

Blockchain