ki-safe-transfer-lib

Kirobo

Kirobo Transfer Library Documentation

return home

Contents

What this library is intended to do?

This library is an interface for a convenient two-way work with Retrievable Transfer Service by Kirobo and a set of blockchain services - Find UTXOs and Find Free and Used Addresses. A set of endpoints provides access to full spectrum of Kirobo API services. It is kept up to date with current API development.

The library is built with both front-end and back-end in mind. Use of TypeScript allows to provide a convenient and stable work.

to top

How does it work?

Step by step explanation of the process, life-cycle of the transaction on server and more details are discussed here.

to top

Dependencies

Current version (v2) uses the following dependencies:

These libraries are needed to set up the socket communication with the server, for address validation and are used in functions. Some of the functionality of these libraries are exposed through the library API.

to top

Points to mention

Despite library is built to work with Kirobo API, when used on the back-end library will be occasionally checking the ability to resolve google.com, to ensure, that the connection with API is still on. In case of failure, the library will disconnect the service and reconnect when the Internet connection is back. This is done to ensure, that in case of connection restore the database can automatically refresh the status (block height, server status and latest average fee), as well as to obtain the status of the last Collectables requested.

to top

Terminology

What is Retrievable? What is Collectable? We are going to use these many times.

Retrievable is a transaction object which contains all the data for deposit and collect. It also contains enough data to retrieve it. Some data is encrypted to ensure the security of the transactions, other data is open and available from the blockchain. Collectable is brief version of Retrievable, so it would be safe to display it to the recipient. Without passcode, recipient will not know anything besides specific data sender would like him to know. More on the structure, as well as to read about life cycle of the above you can find here.

to top

return home