Nomnom Pumpernickle Muffins

    ts-api-js

    0.9.1 • Public • Published

    TRTL Service JS API Interface

    This wrapper allows you to easily interact with the TRTL Services v1 API to quickly develop applications that interact with the TurtleCoin Network. This entire project uses Javascript Promises to make things fast, easy, and safe.

    Table of Contents

    1. Installation
    2. Intialization
    3. Documentation
    4. Methods

    Installation

    npm i --save ts-api-js

    Intialization

    const TRTLServices = require('ts-api-js')
     
    const connect = new TRTLServices({
      token: 'eyJhbGciOiJIUzUxMiIsInR5fCI6IkpXVCJ9.eyJuYW1lIjoidGVzdCIsImFwcElkIjo0LCJ1c2VySWQiOjYsInBlcm1pc3Npb25zIjpbIwFkZHJlc3M6bmV3Il0sImlhdCI6MTUzMjU4NTM2NywiZXhwIjoxNT25MTc3MzY3LCJhdWQiOiJ0dXJ0bGV3YWxsZXQuaW8iLCJpc3MiOiJUUlRMIFNlcnZpY2VzIiwianRpIjoiMzMioQ.AEHXmvTo8RfNuZ15Y3IGPRhZPaJxFSmOZvVv2YGN9L4We7bXslIPxhMv_n_5cNW8sIgE2Fr-46OTb5H5AFgpjA',
      timeout: 2000
    })

    Documentation

    API documentation is available at https://trtl.services/docs

    Methods

    createAddress()

    Create a new TRTL addresses

    TS.createAddress()

    getAddress(address)

    Get address details by address

    TS.getAddress("TRTLuxH78akDMCsXycnU5HjJE6zPCgM4KRNNQSboqh1yiTnvxuhNVUL9tK92j9kurSKdXVHFmjSRkaNBxM6Nb3G8eQGL7aj113A")

    deleteAddress(address)

    Delete a selected TRTL addresses

    TS.deleteAdddress("TRTLuxH78akDMCsXycnU5HjJE6zPCgM4KRNNQSboqh1yiTnvxuhNVUL9tK92j9kurSKdXVHFmjSRkaNBxM6Nb3G8eQGL7aj113A")

    getAddresses()

    View all addresses belonging to the specified token.

    TS.getAddresses()

    scanAddress(address, blockIndex)

    Scan an address for transactions between a 100 block range starting from the specified blockIndex.

    TS.scanAddress("TRTLuxH78akDMCsXycnU5HjJE6zPCgM4KRNNQSboqh1yiTnvxuhNVUL9tK92j9kurSKdXVHFmjSRkaNBxM6Nb3G8eQGL7aj113A", 899093)

    getAddressKeys(address)

    Get the public and secret spend key of an address.

    TS.getAddressKeys("TRTLuxH78akDMCsXycnU5HjJE6zPCgM4KRNNQSboqh1yiTnvxuhNVUL9tK92j9kurSKdXVHFmjSRkaNBxM6Nb3G8eQGL7aj113A")

    integrateAddress(address, paymentId)

    Create an integrated address with an address and payment ID.

    TS.integrateAddress("TRTLuxH78akDMCsXycnU5HjJE6zPCgM4KRNNQSboqh1yiTnvxuhNVUL9tK92j9kurSKdXVHFmjSRkaNBxM6Nb3G8eQGL7aj113A", "7d89a2d16365a1198c46db5bbe1af03d2b503a06404f39496d1d94a0a46f8804")

    getIntegratedAddresses(address)

    Create an integrated address with an address and payment ID.

    TS.getIntegratedAddresses("TRTLuxH78akDMCsXycnU5HjJE6zPCgM4KRNNQSboqh1yiTnvxuhNVUL9tK92j9kurSKdXVHFmjSRkaNBxM6Nb3G8eQGL7aj113A")

    getFee(amount)

    Calculate the TRTL Services fee for an amount specified in TRTL with two decimal points.

    TS.getFee(1092.19)

    createTransfer(sender, receiver, amount, fee, paymentId, extra)

    Send a TRTL transaction with an address with the amount specified two decimal points.

    TS.createTransfer(
      "TRTLuxH78akDMCsXycnU5HjJE6zPCgM4KRNNQSboqh1yiTnvxuhNVUL9tK92j9kurSKdXVHFmjSRkaNBxM6Nb3G8eQGL7aj113A",
      "TRTLuzAzNs1E1RBFhteX56A5353vyHuSJ5AYYQfoN97PNbcMDvwQo4pUWHs7SYpuD9ThvA7AD3r742kwTmWh5o9WFaB9JXH8evP",
      1000.01,
      1.2,
      "7d89a2d16365a1198c46db5bbe1af03d2b503a06404f39496d1d94a0a46f8804",
      "3938f915a11582f62d93f82f710df9203a029f929fd2f915f2701d947f920f99"
    )

    You can leave the last two fields (paymentId and extra) blank.

    getTransfer(address)

    Get a transaction details specified by transaction hash.

    TS.getTransfer("EohMUzR1DELyeQM9RVVwpmn5Y1DP0lh1b1ZpLQrfXQsgtvGHnDdJSG31nX2yESYZ")

    getWallet()

    Get wallet container info and health check.

    TS.getWallet()

    getStatus()

    Get the current status of the TRTL Services infrastructure.

    TS.getStatus()

    License

    Copyright (C) 2018 Fexra, The TurtleCoin Developers
    
    Please see the included LICENSE file for more information.
    

    Install

    npm i ts-api-js

    DownloadsWeekly Downloads

    0

    Version

    0.9.1

    License

    AGPL-3.0

    Unpacked Size

    46.8 kB

    Total Files

    5

    Last publish

    Collaborators

    • fexra