BTCPay Greenfield Node Client

Installation

yarn add btcpay-greenfield-node-client

or

npm install btcpay-greenfield-node-client

Configuration

btcpay-greenfield-node-client uses Btcpay Greenfield API keys. To create an API Key in BTCPay:

1. Click on the "Account" icon on the bottom-left corner of BTCPay.
2. Click "Manage Account"
3. Click into the "API Keys" tab.
4. Go through the "Generate Key" process.

Set Base URL

import { OpenAPI } from 'btcpay-greenfield-node-client';

OpenAPI.BASE = 'https://your-btcpayserver-url.com';

Authorization

API Key

import { OpenAPI } from 'btcpay-greenfield-node-client';

OpenAPI.TOKEN = process.env.BTCPAY_API_KEY;
// or as a function
OpenAPI.TOKEN = () => {
  return 'SOME_TOKEN';
};

Username & Password

import { OpenAPI } from 'btcpay-greenfield-node-client';

OpenAPI.USERNAME = process.env.BTCPAY_USERNAME;
OpenAPI.PASSWORD = process.env.BTCPAY_PASSWORD;
// or as function
OpenAPI.USERNAME = () => {
  return 'USERNAME';
};
OpenAPI.PASSWORD = () => {
  return 'PASSWORD';
};

Usage

Development

1. Run yarn generate
2. Commit
3. Run yarn build
4. Publish to npm

Acknowledgement

This library leverages the work done by @ferdikoomen in openapi-typescript-codegen.