trtl-apps
a node-js package for interacting with turtle apps.
Full API Documentation can be found here
Quickstart
Create an app using the TRTL apps console
Install the package
npm install trtl-apps --save
Initialize your app
; TrtlApp.initialize'YOUR_APP_ID', 'YOUR_APP_SECRET';
Create accounts
;; console.log`alice deposit address: `;
Transfer from one account to another
; if transfer
Account preview withdrawal
;;; ; if preview
Account withdraw
; if withdrawal
CI/CD
This project uses Github actions to automatically build and publish the node package to NPM when a new release tag is created. For this to work correctly the following secret must be added to Github at settings -> secrets
:
secret name: NPM_TOKEN
secret value: YOUR NPM TOKEN
Contributing
Documentation
Compile the javascript
tsc
Generate documentation website. The copyfiles package must be installed globally
npm i copyfiles -g
Use the following command to generate the static documentation site.
npm run docs
Documentation is automatically hosted using github pages with each commit to the master branch