Skip to content

Latest commit

 

History

History

backend

README.md

zk-swap-ai

API

/api/swap {
  safe: Address,
  inToken: Address,
  outToken: Address,
  dx: string,
  minDy: string,
  nonce: string,
  signature: ArrayBuffer,
}
/api/blockchain/balance
/api/blockchain/blockNumber
/api/blockchain/getPrice/:dex // A or B
/api/blockchain/dexStats/:dex // A or B

Development

  • morgan
    • HTTP request logger middleware for node.js
  • helmet
    • Helmet helps you secure your Express apps by setting various HTTP headers. It's not a silver bullet, but it can help!
  • dotenv
    • Dotenv is a zero-dependency module that loads environment variables from a .env file into process.env
  • cors
    • CORS is a node.js package for providing a Connect/Express middleware that can be used to enable CORS with various options.

Development utilities:

  • typescript
    • TypeScript is a language for application-scale JavaScript.
  • ts-node
    • TypeScript execution and REPL for node.js, with source map and native ESM support.
  • nodemon
    • nodemon is a tool that helps develop node.js based applications by automatically restarting the node application when file changes in the directory are detected.
  • eslint
    • ESLint is a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code.
  • typescript-eslint
    • Tooling which enables ESLint to support TypeScript.
  • jest
    • Jest is a delightful JavaScript Testing Framework with a focus on simplicity.
  • supertest
    • HTTP assertions made easy via superagent.

Setup

yarn install

Lint

yarn run lint

Test

yarn run test

Development

yarn run dev