TruBudget-API
Api Code Documentation / Exports
Environment Variables#
| Env Variable | Required | Default Value | Description |
|---|---|---|---|
| LOG_LEVEL | no | info | Defines the log output. Supported levels are trace, debug, info, warn, error, fatal |
| ORGANIZATION | yes | - | In the blockchain network, each node is represented by its organization name. This environment variable sets this organization name. It is used to create the organization stream on the blockchain and is also displayed in the frontend's top right corner. |
| ORGANIZATION_VAULT_SECRET | yes | - | This is the key to en-/decrypt user data of an organization. If you want to add a new node for your organization, you want users to be able to log in on either node. Caution: If you want to run TruBudget in production, make sure NOT to use the default value from the .env_example file! |
| PORT | no | 8080 | The port used to expose the API for your installation. Example: If you run TruBudget locally and set API_PORT to 8080, you can reach the API via localhost:8080/api. |
| PRETTY_PRINT | no | false | Decides whether the logs printed by the API are pretty printed or not. Pretty printed logs are easier to read while non-pretty printed logs are easier to store and use e.g. in the ELK (Elasticsearch-Logstash-Kabana) stack. |
| ROOT_SECRET | no | [random] | The root secret is the password for the root user. If you start with an empty blockchain, the root user is needed to add other users, approve new nodes,.. If you don't set a value via the environment variable, the API generates one randomly and prints it to the console Caution: If you want to run TruBudget in production, make sure to set a secure root secret. |
| MULTICHAIN_RPC_HOST | no | localhost | The IP address of the blockchain (not multichain daemon,but they are usally the same) you want to connect to. |
| BLOCKCHAIN_PORT | no | 8085 | The Port of the blockchain (not multichain daemon,but they are usally the same) you want to connect to. |
| MULTICHAIN_RPC_USER | no | multichainrpc | The user used to connect to the multichain daemon. |
| MULTICHAIN_RPC_PASSWORD | no | [hardcoded] | Password used by the API to connect to the blockchain. The password is set by the origin node upon start. Every beta node needs to use the same RPC password in order to be able to connect to the blockchain. Hint: Although the MULTICHAIN_RPC_PASSWORD is not required it is highly recommended to set an own secure one |
| MULTICHAIN_RPC_PORT | no | 8000 | The port used to expose the multichain daemon of your Trubudget blockchain installation(bc). The port used to connect to the multichain daemon(api). This will be used internally for the communication between the API and the multichain daemon. |
SWAGGER_BASEPATH deprecated | no | / | This variable was used to choose which environment (prod or test) is used for testing the requests. The variable is deprecated now, as the Swagger documentation can be used for the prod and test environment separately. |
| JWT_SECRET | no | [random] | A string that is used to sign JWT which are created by the authenticate endpoint of the api |
| DOCUMENT_FEATURE_ENABLED | no | false | If true, all uploaded documents are stored using trubudget's storage-service. If false, the document feature of TruBudget is disabled, and trying to upload a document will result in an error. |
| STORAGE_SERVICE_HOST | no | localhost | IP of connected storage service |
| STORAGE_SERVICE_PORT | no | 8090 | Port of connected storage service |
| STORAGE_SERVICE_EXTERNAL_URL | no | - | IP and port of own connected storage service accessible externally |
| ENCRYPTION_PASSWORD | no | - | If set, all data that is send to the MultiChain node and external storage will be symmetrically encrypted by the ENCRYPTION_PASSWORD |
| SIGNING_METHOD | no | node | Possible signing methods are: node and user. Transactions on the chain will be signed using either the address of the node or the address of the specific user publishing that transaction. |
| NODE_ENV | no | production | If set to development api will allow any string as password. If set to production passwords must satisfy safePasswordSchema, see lib/joiValidation-.ts & -.spec.ts files |
| ACCESS_CONTROL_ALLOW_ORIGIN | no | "*" | Since the service uses CORS, the domain by which it can be called needs to be set. Setting this value to "*" means that it can be called from any domain. Read more about this topic here. |
Setup#
Development#
Check out our the ADRs to learn about our current way of doing things.
HTTP.Project <- Multichain.Project <- Project.Project -> Notification.Project
Get started#
When not yet provisioned, it's recommended to start the server directly with node:
npm run tsc && node dist/index.jsAfter that, live-reloading doesn't hinder provisioning anymore, plus it's quite convenient, so you might want to use this instead:
npm run devRun tests#
npm testBuild a container#
docker build .API Swagger documentation#
The documentation is hosted by the API itself. Assuming it's running on your local machine on port 8080, you should see it at localhost:8080/api/documentation.
API code documentation#
For code documentation the API is using TypeDoc.
To generate the documentation in docs/developer/api-docs use following commands:
cd apinpm installnpm run build-docsAfter executing the above commands the api-docs folder is create in docs/developer/api-docs
This folder is used by the project trubudget-website to show all documented functions of TruBudget's API.
To check out how it looks like in production checkout trubudget.net.
To locally spin up the trubudget-website with the build-docs folder copy the build-docs folder into trubudget-website/docs/developer/ before starting the website locally with npm start.
:::hint Currently only domain layer functions are documented. If #1164 is resolved the entire api will be documented. :::