Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/zebedeeio/zbd-payments-typescript-sdk

@zbddev/payments-sdk TypeScript SDK for ZBD Payments
https://github.com/zebedeeio/zbd-payments-typescript-sdk

bitcoin fiat global payments sdk

Last synced: about 1 month ago
JSON representation

@zbddev/payments-sdk TypeScript SDK for ZBD Payments

Awesome Lists containing this project

README 

        
# ZBD Payments TypeScript SDK



[![NPM version](https://img.shields.io/npm/v/@zbddev/payments-sdk.svg)](https://npmjs.org/package/@zbddev/payments-sdk) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@zbddev/payments-sdk)



This library provides convenient access to the ZBD Payments REST API from server-side TypeScript or JavaScript.



The REST API documentation can be found on [zbd.dev](https://zbd.dev). The full API of this library can be found in [api.md](api.md).



## Installation



```sh

npm install @zbddev/payments-sdk

```



## Usage



The full API of this library can be found in [api.md](api.md).



```js

import ZbdPayments from '@zbddev/payments-sdk';



const client = new ZbdPayments({

  apikey: process.env['ZBD_PAYMENTS_API_KEY'], // This is the default and can be omitted

});



async function main() {

  await client.lightningAddress.sendPayment({

    amount: '500000',

    comment: 'Instant global payments',

    lnAddress: '[email protected]',

  });

}



main();

```



### Request & Response types



This library includes TypeScript definitions for all request params and response fields. You may import and use them like so:



```ts

import ZbdPayments from '@zbddev/payments-sdk';



const client = new ZbdPayments({

  apikey: process.env['ZBD_PAYMENTS_API_KEY'], // This is the default and can be omitted

});



async function main() {

  const params: ZbdPayments.LightningAddressSendPaymentParams = {

    amount: '500000',

    comment: 'Instant global payments',

    lnAddress: '[email protected]',

  };

  await client.lightningAddress.sendPayment(params);

}



main();

```



Documentation for each method, request param, and response field are available in docstrings and will appear on hover in most modern editors.



## Handling errors



When the library is unable to connect to the API,

or if the API returns a non-success status code (i.e., 4xx or 5xx response),

a subclass of `APIError` will be thrown:



```ts

async function main() {

  const response = await client.lightningAddress

    .sendPayment({ amount: '500000', comment: 'Instant global payments', lnAddress: '[email protected]' })

    .catch(async (err) => {

      if (err instanceof ZbdPayments.APIError) {

        console.log(err.status); // 400

        console.log(err.name); // BadRequestError

        console.log(err.headers); // {server: 'nginx', ...}

      } else {

        throw err;

      }

    });

}



main();

```



Error codes are as followed:



| Status Code | Error Type                 |

| ----------- | -------------------------- |

| 400         | `BadRequestError`          |

| 401         | `AuthenticationError`      |

| 403         | `PermissionDeniedError`    |

| 404         | `NotFoundError`            |

| 422         | `UnprocessableEntityError` |

| 429         | `RateLimitError`           |

| >=500       | `InternalServerError`      |

| N/A         | `APIConnectionError`       |



### Retries



Certain errors will be automatically retried 2 times by default, with a short exponential backoff.

Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,

429 Rate Limit, and >=500 Internal errors will all be retried by default.



You can use the `maxRetries` option to configure or disable this:



```js

// Configure the default for all requests:

const client = new ZbdPayments({

  maxRetries: 0, // default is 2

});



// Or, configure per-request:

await client.lightningAddress.sendPayment({ amount: '500000', comment: 'Instant global payments', lnAddress: '[email protected]' }, {

  maxRetries: 5,

});

```



### Timeouts



Requests time out after 1 minute by default. You can configure this with a `timeout` option:



```ts

// Configure the default for all requests:

const client = new ZbdPayments({

  timeout: 20 * 1000, // 20 seconds (default is 1 minute)

});



// Override per-request:

await client.lightningAddress.sendPayment({ amount: '500000', comment: 'Instant global payments', lnAddress: '[email protected]' }, {

  timeout: 5 * 1000,

});

```



On timeout, an `APIConnectionTimeoutError` is thrown.



Note that requests which time out will be [retried twice by default](#retries).



## Advanced Usage



### Accessing raw Response data (e.g., headers)



The "raw" `Response` returned by `fetch()` can be accessed through the `.asResponse()` method on the `APIPromise` type that all methods return.

This method returns as soon as the headers for a successful response are received and does not consume the response body, so you are free to write custom parsing or streaming logic.



You can also use the `.withResponse()` method to get the raw `Response` along with the parsed data.

Unlike `.asResponse()` this method consumes the body, returning once it is parsed.



```ts

const client = new ZbdPayments();



const response = await client.lightningAddress

  .sendPayment({ amount: '500000', comment: 'Instant global payments', lnAddress: '[email protected]' })

  .asResponse();

console.log(response.headers.get('X-My-Header'));

console.log(response.statusText); // access the underlying Response object



const { data: result, response: raw } = await client.lightningAddress

  .sendPayment({ amount: '500000', comment: 'Instant global payments', lnAddress: '[email protected]' })

  .withResponse();

console.log(raw.headers.get('X-My-Header'));

console.log(result);

```



### Logging



> [!IMPORTANT]

> All log messages are intended for debugging only. The format and content of log messages

> may change between releases.



#### Log levels



The log level can be configured in two ways:



1. Via the `ZBD_PAYMENTS_LOG` environment variable

2. Using the `logLevel` client option (overrides the environment variable if set)



```ts

import ZbdPayments from '@zbddev/payments-sdk';



const client = new ZbdPayments({

  logLevel: 'debug', // Show all log messages

});

```



Available log levels, from most to least verbose:



- `'debug'` - Show debug messages, info, warnings, and errors

- `'info'` - Show info messages, warnings, and errors

- `'warn'` - Show warnings and errors (default)

- `'error'` - Show only errors

- `'off'` - Disable all logging



At the `'debug'` level, all HTTP requests and responses are logged, including headers and bodies.

Some authentication-related headers are redacted, but sensitive data in request and response bodies

may still be visible.



#### Custom logger



By default, this library logs to `globalThis.console`. You can also provide a custom logger.

Most logging libraries are supported, including [pino](https://www.npmjs.com/package/pino), [winston](https://www.npmjs.com/package/winston), [bunyan](https://www.npmjs.com/package/bunyan), [consola](https://www.npmjs.com/package/consola), [signale](https://www.npmjs.com/package/signale), and [@std/log](https://jsr.io/@std/log). If your logger doesn't work, please open an issue.



When providing a custom logger, the `logLevel` option still controls which messages are emitted, messages

below the configured level will not be sent to your logger.



```ts

import ZbdPayments from '@zbddev/payments-sdk';

import pino from 'pino';



const logger = pino();



const client = new ZbdPayments({

  logger: logger.child({ name: 'ZbdPayments' }),

  logLevel: 'debug', // Send all messages to pino, allowing it to filter

});

```



### Making custom/undocumented requests



This library is typed for convenient access to the documented API. If you need to access undocumented

endpoints, params, or response properties, the library can still be used.



#### Undocumented endpoints



To make requests to undocumented endpoints, you can use `client.get`, `client.post`, and other HTTP verbs.

Options on the client, such as retries, will be respected when making these requests.



```ts

await client.post('/some/path', {

  body: { some_prop: 'foo' },

  query: { some_query_arg: 'bar' },

});

```



#### Undocumented request params



To make requests using undocumented parameters, you may use `// @ts-expect-error` on the undocumented

parameter. This library doesn't validate at runtime that the request matches the type, so any extra values you

send will be sent as-is.



```ts

client.foo.create({

  foo: 'my_param',

  bar: 12,

  // @ts-expect-error baz is not yet public

  baz: 'undocumented option',

});

```



For requests with the `GET` verb, any extra params will be in the query, all other requests will send the

extra param in the body.



If you want to explicitly send an extra argument, you can do so with the `query`, `body`, and `headers` request

options.



#### Undocumented response properties



To access undocumented response properties, you may access the response object with `// @ts-expect-error` on

the response object, or cast the response object to the requisite type. Like the request params, we do not

validate or strip extra properties from the response from the API.



### Customizing the fetch client



By default, this library expects a global `fetch` function is defined.



If you want to use a different `fetch` function, you can either polyfill the global:



```ts

import fetch from 'my-fetch';



globalThis.fetch = fetch;

```



Or pass it to the client:



```ts

import ZbdPayments from '@zbddev/payments-sdk';

import fetch from 'my-fetch';



const client = new ZbdPayments({ fetch });

```



### Fetch options



If you want to set custom `fetch` options without overriding the `fetch` function, you can provide a `fetchOptions` object when instantiating the client or making a request. (Request-specific options override client options.)



```ts

import ZbdPayments from '@zbddev/payments-sdk';



const client = new ZbdPayments({

  fetchOptions: {

    // `RequestInit` options

  },

});

```



#### Configuring proxies



To modify proxy behavior, you can provide custom `fetchOptions` that add runtime-specific proxy

options to requests:



 **Node** [[docs](https://github.com/nodejs/undici/blob/main/docs/docs/api/ProxyAgent.md#example---proxyagent-with-fetch)]



```ts

import ZbdPayments from '@zbddev/payments-sdk';

import * as undici from 'undici';



const proxyAgent = new undici.ProxyAgent('http://localhost:8888');

const client = new ZbdPayments({

  fetchOptions: {

    dispatcher: proxyAgent,

  },

});

```



 **Bun** [[docs](https://bun.sh/guides/http/proxy)]



```ts

import ZbdPayments from '@zbddev/payments-sdk';



const client = new ZbdPayments({

  fetchOptions: {

    proxy: 'http://localhost:8888',

  },

});

```



 **Deno** [[docs](https://docs.deno.com/api/deno/~/Deno.createHttpClient)]



```ts

import ZbdPayments from 'npm:@zbddev/payments-sdk';



const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });

const client = new ZbdPayments({

  fetchOptions: {

    client: httpClient,

  },

});

```



## Frequently Asked Questions



## Semantic versioning



This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:



1. Changes that only affect static types, without breaking runtime behavior.

2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_

3. Changes that we do not expect to impact the vast majority of users in practice.



We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.



We are keen for your feedback; please open an [issue](https://www.github.com/zebedeeio/zbd-payments-typescript-sdk/issues) with questions, bugs, or suggestions.



## Requirements



TypeScript >= 4.9 is supported.



The following runtimes are supported:



- Web browsers (Up-to-date Chrome, Firefox, Safari, Edge, and more)

- Node.js 18 LTS or later ([non-EOL](https://endoflife.date/nodejs)) versions.

- Deno v1.28.0 or higher.

- Bun 1.0 or later.

- Cloudflare Workers.

- Vercel Edge Runtime.

- Jest 28 or greater with the `"node"` environment (`"jsdom"` is not supported at this time).

- Nitro v2.6 or greater.



Note that React Native is not supported at this time.



If you are interested in other runtime environments, please open or upvote an issue on GitHub.



## Contributing



See [the contributing documentation](./CONTRIBUTING.md).