Skip to content

Latest commit

 

History

History
92 lines (60 loc) · 1.65 KB

README.md

File metadata and controls

92 lines (60 loc) · 1.65 KB
Raw

algo-fetch

Unofficial fetch wrapper for Algorand RPC

Please visit one of the official packages for integrating with Algorand:

TLDR

This is a fetch wrapper for the Algorand RPC API. It is generated from the openapi schema provided by Algorand. It is intended to be used in the browser and in nodejs.

Motivation

This demonstrates a way of working with RPC specifications with a clear separation of concerns. Projects like algokit, algosdk and algo-models could benefit from this approach by sharing the same generated types and fetch clients.

This approach is already used in algosdk but only for the models, we purpose also exporting the interface from the operations definition.

Get Started[WIP]

npm install @algofam/algod-fetch
npm install @algofam/indexer-fetch
npm install @algofam/kmd-fetch

Contributing[WIP]

Clone the project

git clone [email protected]:awesome-algorand/algo-fetch.git

Install the dependencies

npm install

Commands

All projects share the same commands with the same intents

dev

Runs vitest ui in development mode

npm run dev

build

Builds project

npm run build

test

Runs the tests

npm run test

coverage

Creates a coverage report

npm run coverage

lint

Runs the linter

npm run lint

TODO:

  • Automate the generation of the clients when the openapi schema changes, look into the action
  • Add tests