Giter Site home page Giter Site logo

klc-api's Introduction

KLC API

An API to interact with KalyChain to buy KLC via AlchemyPay.

Description

This API serves as a bridge between AlchemyPay and KalyChain, allowing users to purchase KLC tokens. It handles incoming webhooks from AlchemyPay, processes transactions, and communicates with the KalyChain network.

Setup & Installation

  1. Clone the Repository:
git clone https://github.com/kalycoinproject/klc-api.git
cd klc-api
  1. Install Dependencies: npm install

  2. Environment Variables:

  • Create a .env file in the root directory.
  • Add the necessary environment variables:
    APP_SECRET=your_app_secret
    RPC_URL=your_rpc_url
    YOUR_JWT_TOKEN=your_jwt_token
    
  1. Start the API: npm start

Local Setup & Development

Please see localDev.md

Features

  • Webhook Handling: Processes incoming webhooks from AlchemyPay.
  • Transaction Management: Sends transactions to the KalyChain network.
  • Idempotency: Ensures that webhooks are processed only once.
  • Error Handling & Retries: In case of transaction failures, the API retries up to 10 times at 60-second intervals.

Contributing

If you'd like to contribute, please fork the repository and make changes as you'd like. Pull requests are warmly welcome.

License

This project is licensed under the MIT License.

Credits

Developed by NicoDFS a.k.a TheDude.

klc-api's People

Contributors

nicodfs avatar

Watchers

 avatar

Forkers

kalycoinproject

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.