122 lines
3.6 KiB
Rust
122 lines
3.6 KiB
Rust
// Magical Bitcoin Library
|
|
// Written in 2020 by
|
|
// Alekos Filini <alekos.filini@gmail.com>
|
|
//
|
|
// Copyright (c) 2020 Magical Bitcoin
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
// of this software and associated documentation files (the "Software"), to deal
|
|
// in the Software without restriction, including without limitation the rights
|
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
// copies of the Software, and to permit persons to whom the Software is
|
|
// furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in all
|
|
// copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
// SOFTWARE.
|
|
|
|
use std::convert::AsRef;
|
|
|
|
use bitcoin::blockdata::transaction::{OutPoint, Transaction, TxOut};
|
|
use bitcoin::hash_types::Txid;
|
|
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
/// Types of keychains
|
|
#[derive(Serialize, Deserialize, Debug, Clone, Copy, PartialEq, Eq, Hash)]
|
|
pub enum KeychainKind {
|
|
/// External
|
|
External = 0,
|
|
/// Internal, usually used for change outputs
|
|
Internal = 1,
|
|
}
|
|
|
|
impl KeychainKind {
|
|
/// Return [`KeychainKind`] as a byte
|
|
pub fn as_byte(&self) -> u8 {
|
|
match self {
|
|
KeychainKind::External => b'e',
|
|
KeychainKind::Internal => b'i',
|
|
}
|
|
}
|
|
}
|
|
|
|
impl AsRef<[u8]> for KeychainKind {
|
|
fn as_ref(&self) -> &[u8] {
|
|
match self {
|
|
KeychainKind::External => b"e",
|
|
KeychainKind::Internal => b"i",
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Fee rate
|
|
#[derive(Debug, Copy, Clone, PartialEq, PartialOrd)]
|
|
// Internally stored as satoshi/vbyte
|
|
pub struct FeeRate(f32);
|
|
|
|
impl FeeRate {
|
|
/// Create a new instance of [`FeeRate`] given a float fee rate in btc/kvbytes
|
|
pub fn from_btc_per_kvb(btc_per_kvb: f32) -> Self {
|
|
FeeRate(btc_per_kvb * 1e5)
|
|
}
|
|
|
|
/// Create a new instance of [`FeeRate`] given a float fee rate in satoshi/vbyte
|
|
pub fn from_sat_per_vb(sat_per_vb: f32) -> Self {
|
|
FeeRate(sat_per_vb)
|
|
}
|
|
|
|
/// Create a new [`FeeRate`] with the default min relay fee value
|
|
pub fn default_min_relay_fee() -> Self {
|
|
FeeRate(1.0)
|
|
}
|
|
|
|
/// Return the value as satoshi/vbyte
|
|
pub fn as_sat_vb(&self) -> f32 {
|
|
self.0
|
|
}
|
|
}
|
|
|
|
impl std::default::Default for FeeRate {
|
|
fn default() -> Self {
|
|
FeeRate::default_min_relay_fee()
|
|
}
|
|
}
|
|
|
|
/// A wallet unspent output
|
|
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
|
|
pub struct UTXO {
|
|
/// Reference to a transaction output
|
|
pub outpoint: OutPoint,
|
|
/// Transaction output
|
|
pub txout: TxOut,
|
|
/// Type of keychain
|
|
pub keychain: KeychainKind,
|
|
}
|
|
|
|
/// A wallet transaction
|
|
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, Default)]
|
|
pub struct TransactionDetails {
|
|
/// Optional transaction
|
|
pub transaction: Option<Transaction>,
|
|
/// Transaction id
|
|
pub txid: Txid,
|
|
/// Timestamp
|
|
pub timestamp: u64,
|
|
/// Received value (sats)
|
|
pub received: u64,
|
|
/// Sent value (sats)
|
|
pub sent: u64,
|
|
/// Fee value (sats)
|
|
pub fees: u64,
|
|
/// Confirmed in block height, `None` means unconfirmed
|
|
pub height: Option<u32>,
|
|
}
|