Yellowcard-bitcoin-api NPM

enter image description here

Yellowcard-bitcoin-api

Serverless api to interact with the yellowcard bitcoin node ✨

Structural flow

enter image description here

Recieving Transaction

The flow of how receiving a transaction works Untitled Diagram (1)

API

All Function calls on this repo is invoked internally

~ getNodeInfo

description:- view node details

data:- none

~getWalletInfo

description:- view wallet details

data: - none

~getAllWallets

description:- view all wallets created in node

data:- none

~getAllAccounts

description:- view all accounts in node and their balance

data:- none

getAccountInfo

description:- view details about a specific account

data:- accountName

~createAccount

description:- create a wallet account

data:- name(string), passphase(string)

~getWalletTX

description:- view all transaction performed by wallet

data:- none

~getAccountAddress

description:- get the current recieving address of an account

data:- accountName

~generateAddress

description:- generate a new recieving wallet for an account

data:- accountName

getAccountByAddress

description:- get an account detail using a wallet address

data:- accountName

~getBalance

description:- get total balance in an account

data:- accountName

createTX

description:- Create a raw tnx to external wallet

data:- address(string), amount(string), fee(number)

sendTX

description:- Send btc to external wallet

data:- rawtx

getAccountTx

description:- get all transactions made by an account

data:- txid

getTxByHash

description:- get transaction details using a tx hash

data:- txid(string)

estimateFee

description:- estimates the fees require to add a transaction to the block

data:-blocks

Installing

Clone the repository and install dependencies

git clone https://github.com/yellowcardfinancial/yellowcard-bitcoin-api.git
cd yellowcard-bitcoin-api

Ensure Node Version

Download and install: NVM — Node Version Manager

nvm install 8.10.0
nvm use node

And now you're ready to install dependencies.

npm install

Run Development Server

This will start a server on localhost:3000 and will run an instance of the API

sls offline start

BUGS 😭😭😭

still having bugs? no issue go to we hate bugs locate your bugs in the list with solutions if bug is 404 in list then ask anyone for help