Skip to content

payxn-io/payxn-api

Repository files navigation

Writing a Payxn Solana API using NestJS

Tips for using the backend API

To use a backend Payxn API app using NestJS and Solana web3.js, you can follow these steps to integrate Solana blockchain functionality within a NestJS application. This guide assumes you are familiar with both NestJS and the basics of Solana development.

Payxn Logo

A progressive Node.js framework for building efficient and scalable server-side applications.

NPM Version Package License Follow us on Twitter

Sample API Interface

Screenshot 2024-10-06 at 4 05 16 PM

Diagram of Payxn User Journey

Screenshot 2024-10-04 at 11 54 30 AM

Steps

  • Install Dependencies
  • Create a Solana Service
  • Create a Controller
  • Register the Solana Module
  • Install Swagger Dependencies
  • Configure Swagger in main.ts
  • Add Swagger Decorators to the Controller
  • Run the Application

Description

Payxn is an abstracted virtual solana payment channel.

Getting Started

npm i -g @nestjs/cli
nest new payxn-api
npm install @solana/web3.js

Create a solana service

nest generate module solana 
nest generate service solana

Create a Controller

nest generate controller solana

Resources

Check out a few resources that may come in handy when working with NestJS:

  • Visit the NestJS Documentation to learn more about the framework.
  • For questions and support, please visit our Discord channel.
  • To dive deeper and get more hands-on experience, check out our official video courses.
  • Visualize your application graph and interact with the NestJS application in real-time using NestJS Devtools.
  • Need help with your project (part-time to full-time)? Check out our official enterprise support.
  • To stay in the loop and get updates, follow us on X and LinkedIn.
  • Looking for a job, or have a job to offer? Check out our official Jobs board.

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

License

Nest is MIT licensed.

About

Loose coupling of payxn interfaces

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published