Crate rgb_lib

A library to manage wallets for RGB assets.

Wallet

The main component of the library is the Wallet.

It allows to create and operate an RGB wallet that can issue, send and receive RGB20 and RGB25 assets. The library also manages UTXOs and asset allocations.

Backend

The library uses BDK for walleting operations and several components from the RGB ecosystem for RGB asset operations.

Database

A SQLite database is used to persist data to disk.

Database support is designed in order to support multiple database backends. At the moment only SQLite is supported but adding more should be relatively easy.

Api

RGB asset transfers require the exchange of off-chain data in the form of consignment or media files.

The library currently implements the API for a proxy server to support these data exchanges between sender and receiver.

Errors

Errors are handled with the crate thiserror.

FFI

Library functionality is exposed for other languages via the sub-crate rgb-lib-ffi.

It uses uniffi and the exposed functionality is defined in the rgb-lib-ffi/src/rgb-lib.udl file.

Examples

Create an RGB wallet

use rgb_lib::wallet::{DatabaseType, Wallet, WalletData};
use rgb_lib::{generate_keys, BitcoinNetwork};

fn main() -> Result<(), rgb_lib::Error> {
    let data_dir = tempfile::tempdir()?;
    let keys = generate_keys(BitcoinNetwork::Regtest);
    let wallet_data = WalletData {
        data_dir: data_dir.path().to_str().unwrap().to_string(),
        bitcoin_network: BitcoinNetwork::Regtest,
        database_type: DatabaseType::Sqlite,
        max_allocations_per_utxo: 5,
        pubkey: keys.xpub,
        mnemonic: Some(keys.mnemonic),
        vanilla_keychain: None,
    };
    let wallet = Wallet::new(wallet_data)?;

    Ok(())
}

Re-exports

• pub use crate::keys::generate_keys;
• pub use crate::keys::restore_keys;
• pub use crate::utils::BitcoinNetwork;
• pub use crate::wallet::TransactionType;
• pub use crate::wallet::TransferKind;
• pub use crate::wallet::Wallet;

Modules

• keys
  RGB wallet keys
• utils
  RGB utilities
• wallet
  RGB wallet

Structs

• ScriptBuf
  An owned, growable script.
• SecretSeal
  Blind version of transaction outpoint-based single-use-seal
• SignOptions
  Options for a software signer

Enums

• AssetSchema
  The schema of an asset.
• Error
  The error variants returned by functions.
• TransferStatus
  The status of a crate::wallet::Transfer.
• TransportType
  The type of an RGB transport.

Functions

• restore_backup
  Restore a backup from the given file and password to the provided target directory.