Skip to content

Latest commit

 

History

History
65 lines (42 loc) · 1.41 KB

README.md

File metadata and controls

65 lines (42 loc) · 1.41 KB
Raw

kinetic-node-starter

This starter shows how to implement a simple API that allows you to send KIN to a Solana account using Kinetic.

Read the details in .env.example about how to create an Payment Account.

Make sure to protect your endpoints for malicious users, so they don't drain your Payment Account.

It also implements the webhook listener for the Kinetic API.

Requirements

  • Basic Node and TypeScript knowledge
  • Node 16+
  • Yarn 1.22.x

Running this project

1. Clone the repo

git clone https://github.com/kin-starters/kinetic-node-starter.git
cd kinetic-node-starter

2. Install the dependencies

yarn install

3. Configure your environment

You need to create the .env file and configure the settings. All the env vars are required.

Read the .env.example file for configuration options.

// Or use your editor to copy the file...
cp .env.example .env

4. Run the server

yarn dev

5. Invoke the endpoint

You can now invoke the /payment endpoint on the API, adding the public key of the Solana destination account as the first and the amount of KIN to send as second parameter:

curl http://localhost:9876/payment/FaFGzKRFhrQffH7voPUgzpJA2ngsvJvtYPXcye6w4DJ9/42

Docker

You can also run this project using Docker.

cp .env.example .env
# Edit the .env file
docker compose up