Skip to content

Latest commit

 

History

History
87 lines (58 loc) · 2.57 KB

README.md

File metadata and controls

87 lines (58 loc) · 2.57 KB
Raw

LTO github readme

LTO API npm version

Client for LTO Network. Integration for both public blockchain and private event-chain.

Installation

npm install @ltonetwork/lto

or

yarn add @ltonetwork/lto

Alternatively you can download the library as bundle.

Usage

The chain id is 'L' for the mainnet and 'T' testnet.

import LTO, {Binary} from '@ltonetwork/lto';

const lto = new LTO('T');

const account = lto.account();

const seed = 'satisfy sustain shiver skill betray mother appear pupil coconut weasel firm top puzzle monkey seek';
const accountFromSeed = lto.account({ seed });

lto.transfer(account, recipient, 100_00000000);
lto.massTransfer(account, [{recipient: recipient1, amount: 100_00000000}, {recipient: recipient2, amount: 50_00000000}]);
lto.anchor(account, new Binary('some value').hash(), new Binary('other value').hash());
lto.associate(account, 0x3400, recipient);
lto.revokeAssociation(account, 0x3400, recipient);
lto.lease(account, recipient, 10000_00000000);
lto.cancelLease(account, leaseId);
lto.sponsor(account, otherAccount);
lto.cancelSponsorship(account, otherAccount);

lto.getBalance(account);
lto.setData(account, {foo: 'bar'});
lto.getData(account);

Amounts are in LTO * 10^8. Eg: 12.46 LTO is 12_46000000.

Documentation

For more advanced use cases, please read the documentation.

Download bundle

The library is also available as a bundle. This bundle includes the library and all its dependencies. This bundle is useful if you want to use the library in a browser environment.

You can download the bundle from the GitHub releases page.

The library is bundles as a UMD module. This means you can use it in the browser as global variable LTO, or you can import it as a module in your JavaScript code.

Browser

<script src="lto.js"></script>
<script>
    const lto = LTO.connect('T');
    const account = lto.account();
    console.log(account.address);
    
    lto.anchor(account, new LTO.Binary('test').hash())
      .then(tx => console.log(tx.id));
</script>

Troubleshooting

Global variable LTO is an object with all exported classes and functions. If you try to do new LTO() you will get the error:

TypeError: LTO is not a constructor

Use LTO.connect() instead.