Node.js SDK for ZBD API


  // Import @zbd/node library
  import { zbd } from '@zbd/node';

  // Create ZBD instance
  const ZBD = new zbd(API_KEY);

  // Send Bitcoin payment
  const response = await ZBD.sendLightningAddressPayment({
    amount: 50000,
    lnAddress: 'andre@zbd.gg',
    comment: 'Lightning fast!',
  });

  // Done!

View SDK DocsOpen Playground

View other SDK options

Getting Started

The Node.js library for ZBD API is available under @zbd/node. When building tools with ZBD support we encourage you to include zbd in the keywords field in package.json.

All you have to do to get started is install @zbd/node as a dependency to your Node.js-based project. You can do so using npm:

npm install @zbd/node --save

Or if you are using yarn:

yarn add @zbd/node

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 @zbd/node SDK. You can find your Project API Key in the ZBD Developer Dashboard.

First you must import the zbd SDK 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).

import { zbd } from '@zbd/node'

const ZBD = new zbd(YOUR_API_KEY_HERE)

const payment = await ZBD.sendPayment( ... )

You're all set. Now let's move some money at the speed of the internet! Check the Dev Playground or the SDK API Reference below for more information on how to use the @zbd/node SDK.

Dev Playground

The best way to get started using the @zbd/node SDK for the ZBD API is to check out our Dev Playground -- a web-based tool that allows you to test and interact with the @zbd/node library without writing any code.

The Dev Playground has built-in modules and source code showing the usage of the @zbd/node SDK to perform Payins and Payouts in Bitcoin. From creating Charges, to editing Static QR codes, to sending Lightning Address payments -- there's a module for everything.

To make the most of the Dev Playground, clone the source code repository to your local machine and follow the instructions in the README to get started.

git clone https://github.com/zebedeeio/nextjs-zebedee-starter.git

Once you've connected your ZBD API Key as a local environment variable and started the Next.js server, you can open your local Dev Playground at localhost:3000/playground.

You may also check out a LIVE running version of the Dev Playground here.

Open Dev Playground

@zbd/node

The goal of the project is to create a beautiful and extensible experience for developers using ZBD APIs in a Node.js environment. Our focus will be primarily around providing parity with ZBD REST API, as well as providing further stability for developers.

In the future, we anticipate adding Node.js-only APIs to this SDK. We also anticipate the community will come up with innovative additions to enhance what could be the simplest and most powerful Bitcoin payments API.

API Reference

Below is a comprehensive list of the methods and functions available in the @zbd/node SDK. These methods are ONLY available to the zbd client instance after it's been properly authenticated with a Project's API Key.

Method Entity Description

createCharge

Charge

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

Parameters:

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

Resources:

Node.js SDK for ZBD API

Getting Started

Authentication

Dev Playground

@zbd/node

API Reference

Community Support