Skip to content

Latest commit

 

History

History
76 lines (46 loc) · 3.49 KB

README.md

File metadata and controls

76 lines (46 loc) · 3.49 KB
Raw

Trust Enterprises: Simple Self Hosted Hedera API Services

Welcome to your self-hosted Hedera API, you can find out more about the project and running your first client through reading the docs.

You can look at our postman docs by clicking the button below.

Run in Postman

Who is this for?

Projects or individuals that want to either:

a) Develop a proof of concept application and not worry about complexity of deploying their own service and working with the technology b) Have the starting point of an API for services to begin (used by DOVU, Amplify, Inky's Art Club, and countless community members.)

You provide a system where you want control to manage tokens, or work with consensus without having to worry about identity and wallets.

What does it do?

Deploy and configure this API to services such as Digital Ocean App Platform, Vercel, and other serverless PaaS platforms.

This API provides a simple but opinionated functionality layer between the Hedera JS client, we have cherry-picked and enhanced a number of capabilities including:

  • Consensus logging
  • Token creation
  • Custodial account generation
  • An entire NFT flow for the creation, minting, and management of assets.
  • HCS20 Inscriptions

Our API flow for the management of NFTs has been built from the ground up and includes special functionality for NFT-pass driven experiences that isn't present anywhere else.

In turn, you can create a surprisingly large amount of applications from marketplaces, staking platforms, low/no-code apps, and more.

This project isn't for everyone, if you require more granular control it is likely you'll write your own calls to your respective SDK.

However, we encourage using (or forking) this project to begin your adventures with Hedera the architecture of this API is scalable, tested, as CI/CD, and used in production by multiple flagship Hedera applications.

Versioning requirements, major version release.

For version 2 of the API, which includes the NFT flow you need to use node 16 or higher.

We have removed GitHub Actions CI checks for Node 12 & 14.

Deploy with 1 click

Deploy with Vercel

Developing and testing locally

  • Setup your environment variables
  • Run the linter and basic tests
yarn lint
yarn test

If you want to run all the tests, including the e2e tests for your config use:

yarn test:all

First, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.js. The page auto-updates as you edit the file.

Have a look at the REST API documentation to see how you can start sending requests to your new shiny client.