Rust Crate for ZBD API


  use std::env;
  use zebedee_rust::{ln_address::*, ZebedeeClient};

  #[tokio::main]
  async fn main() {
    let apikey: String = env::var("ZBD_API_KEY").unwrap();
    let zebedee_client = ZebedeeClient::new().apikey(apikey).build();

    // Create a Lightning payment
    let payment = LnPayment {
      ln_address: String::from("dannym@zbd.gg"),
      amount: String::from("10000"),
      ..Default::default()
    };

    // Initiate the payment
    let payment_res = zebedee_client.pay_ln_address(&payment).await.unwrap();
    
    // Print the result
    println!("Internal transfer result: {:?}", payment_res);
  }

View Crate Docs

View other SDK options

Getting Started

The Rust Crate for ZBD API is available under zebedee-rust. When building tools with ZBD support we encourage you to include zbd in the keywords field in Cargo.toml.

All you have to do to get started is add zebedee-rust as a dependency to your Rust-based project. You can do so using cargo:

cargo add zebedee_rust

Now let's authenticate a specific Wallet with that ZBD Project's API Key.

In order to authenticate your Project Wallet with the ZBD API, you will need to provide your ZBD Project's API Key to the zebedee-rust crate. You can find your Project API Key in the ZBD Developer Dashboard.

First you must import the zebedee-rust crate client into your codebase, and then instantiate it with your Project API Key (replace `YOUR_API_KEY_HERE` below with your actual ZBD Project's API Key).


  use zebedee_rust::{ZebedeeClient};

  let zbd_client = ZebedeeClient::new()
    .apikey(YOUR_API_KEY_HERE)
    .build();

  let payment = GamertagPayment{...};

  let payment_res = zbd_client.pay_gamertag(&payment).await.unwrap();

You're all set. Now let's move some money at the speed of the internet! Check the SDK API Reference below for more information on how to use the zebedee-rust crate.

zebedee-rust

The goal of the project is to create a beautiful and extensible experience for developers using ZBD APIs in a Rust environment. The ZBD community has taken on the challenge and built the Rust SDK themselves. The focus is to provide parity with ZBD REST API, as well as providing further stability for developers.

API Reference

Below is a comprehensive list of the methods and functions available in the zebedee-rust crate. These methods are ONLY available to the ZebedeeClient client instance after it's been properly authenticated with a Project's API Key.

Method Entity Description

create_charge

Charge

Creates a new Charge / Payment Request in the Bitcoin Lightning Network, payable by any Bitcoin Lightning wallet.

Struct:

charge: &Charge The Charge reference containing the required parameters.

Parameters:

`amount` required	The amount for the Charge -> in millisatoshis.
`description` required	Note or comment for this Charge (visible to payer).
`expires_in`	Time until charge expiration -> in seconds.
`internal_id`	Open metadata string property.
`callback_url`	The endpoint ZBD will POST Charge updates to.

Resources:

Rust Crate for ZBD API

Getting Started

Authentication

zebedee-rust

API Reference

Community Support