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

import { TrtlApp } from 'trtl-apps';

TrtlApp.initialize('YOUR_APP_ID', 'YOUR_APP_SECRET');

Create accounts

const [alice, error]  = await TrtlApp.createAccount();
const [bob, error]    = await TrtlApp.createAccount();

console.log(`alice deposit address: ${alice.depositAddress}`);

Transfer from one account to another

const [transfer, error] = await TrtlApp.transfer(alice.id, bob.id, 120);

if (transfer) {
    console.log(`transfer succeeded, transfer id: ${transfer.id}`);
}

Account preview withdrawal

const accountId = '8RgwiWmgiYKQlUHWGaTW';
const amount = 2100;
const address = 'TRTLv2fdtVVDjWKueQ1aAETchiGVWkDvi1ATNgqZ3nKc7biCLm7KzLYeCzfS46mWYNRe8JaMPcTGWAR874kkN2zQ7Mt16J1vzcA';

const [preview, error] = await TrtlApp.withdrawalPreview(accountId, amount, address);

if (preview) {
 console.log(`Withdrawal preview created successfully, id: ${preview.id}, fee: ${preview.fee}`);
}

Account withdraw

const [withdrawal, error] = await TrtlApp.withdraw(preview.id);

if (withdrawal) {
 console.log(`Withdrawal request created successfully and is beeing processed, paymentId: ${withdrawal.paymentId}`);
}

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