Nunchaku Pizza Master

    blockchain-express-middleware
    TypeScript icon, indicating that this package has built-in type declarations

    1.4.3 • Public • Published

    Blockchain.info receive payments API express middleware

    Travis Coverage Downloads Version License

    Express middleware for receiving bitcoin payments using blockchain.info payments receiving API without any fees.

    • Generates unique payment addresses for each transaction using HD wallet.
    • Displays payment request QR code with custom message.
    • Provides payment state.
    • Keeps track of state transitions.
    • Supports multiple transactions to a single address.
    • Supports underpayment and overpayment (amount state).
    • Provides a working example express server application.
    • Requires Blockchain.info receive API key and extended public key (xPub).
    • Written in TypeScript, no need for extra typings.

    Example application

    Installation

    This package is distributed via npm

    npm install blockchain-express-middleware

    Configuration

    The example application requires API key (see this) and extended public key to work.

    To set these, create a ".env" file in the project root directory with contents like:

    SERVER_HOST=example.com
    SERVER_PORT=3000
    SERVER_USE_SSL=false
    SERVER_CERT=fullchain.pem
    SERVER_KEY=privkey.pem
    
    API_KEY=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    API_XPUB=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    
    APP_SECRET=XWzk3tMcPw8JTGfjZzDHdPKguAhh2Adw
    APP_REQUIRED_CONFIRMATIONS=4
    

    Commands

    • yarn start to start the example application.
    • yarn build to build the production version.
    • yarn test to run tests.
    • yarn coverage to gather code coverage.
    • yarn lint to lint the codebase.
    • yarn prettier to run prettier.
    • yarn audit to run all pre-commit checks (prettier, build, lint, test)

    Keywords

    none

    Install

    npm i blockchain-express-middleware

    DownloadsWeekly Downloads

    40

    Version

    1.4.3

    License

    MIT

    Unpacked Size

    330 kB

    Total Files

    78

    Last publish

    Collaborators

    • kallaspriit