whisky 1.0.17

The Cardano Rust SDK, inspired by MeshJS
Documentation

Licence Test Publish Docs

Twitter/X Crates.io NPM

whisky

Whisky is an open-source Cardano Rust SDK, containing following modules:

  • whisky - The core Rust crate supporting Cardano DApp development in Rust.
  • whisky-common - Serving universal types and utilities.
  • whisky-csl - The crate to implement most cardano-serialization-lib wrapper.
  • whisky-provider - The crate to connect external services like blockfrost or maestro.
  • whisky-wallet - The crate to handle wallet signing and provide key encryption utility.
  • whisky-macros - The crate to provide Rust macros utility.
  • whisky-js - An point of output for wasm package for @meshsdk/core-csl.

With whisky, you can

  • Builder transaction with cardano-cli-like APIs, supporting serious DApps’ backend on the Rust codebase.
  • Handling transaction signing in Rust
  • Interacting with blockchain with provider services like Maestro and Blockfrost
  • Off-node evaluation on transaction execution units, and updating the transaction accordingly with TxPipe's uplc integrated.

Installation

Rust Library

cargo add whisky

JS / TS WASM Lib

# For nodejs package
yarn add @sidan-lab/whisky-js-nodejs
# For browser package
yarn add @sidan-lab/whisky-js-browser

Getting Started

use whisky::*;

pub fn send_lovelace(
    recipient_address: &str,
    my_address: &str,
    inputs: &[UTxO],
) -> Result<String, WError> {
    let mut tx_builder = TxBuilder::new_core();
    tx_builder
        .tx_out(
            recipient_address,
            &[Asset::new_from_str("lovelace", "1000000")],
        )
        .change_address(my_address)
        .select_utxos_from(inputs, 5000000)
        .complete_sync(None)?;

    Ok(tx_builder.tx_hex())
}

Contributor Guides

Make sure llvm is installed

Maintainers List

  • Hinson Wong (Github Handle: HinsonSIDAN) - Maintainer
  • Tsz Wai (Github Handle: twwu123) - Maintainer
  • Ken Lau (Github Handle: kenlau666) - Maintainer
  • Anson Chui (Github Handle: AnsonSIDAN) - Project Manager

APIs

Please refer to the hosted documentation for the list of endpoints.

Alt

Community Channel Invite

Please join SIDAN Lab's discord server for regular update using https://discord.gg/prJvB6b6p4.

Please view SIDAN Lab's dedicated channel for any SIDAN - Whisky V2 - Cardano Rust SDK with Pallas Catalyst Project Update in https://discord.com/channels/1166784293805228061/1441817320245952532.