From 41eb1dc4524bff40320b826d1135812ae87df96b Mon Sep 17 00:00:00 2001 From: sairaj mote Date: Sun, 20 Oct 2019 01:07:28 +0530 Subject: [PATCH] added description for floBlockchainAPI and compact IDB operations --- README.md | 112 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 112 insertions(+) diff --git a/README.md b/README.md index 0115093..fd7a439 100644 --- a/README.md +++ b/README.md @@ -78,3 +78,115 @@ This template contains standard operations that can be used for the following: 1. data - data of the given signature 2. signature - signature of the data 3. publicKey - public key of the signer + +## FLO Blockchain API Operations +`floBlockchainAPI` object method can be used to send/recieve data to/from blockchain.These functions are asynchronous and return a promise. Contains the following functions. + +#### promisedAJAX + floBlockchainAPI.promisedAJAX(method, uri) +`promisedAJAX` resolves a responce from server on success or rejects the responce on failure. +1. method - GET/POST + a. GET - Requests data from a specified resource. + b. POST - Submits data to be processed to a specified resource. +2. uri(Uniform Resource Identifier) - identifier for AJAX resource. It is used to create URL(Uniform Resource Locator) for further operations. + +#### getBalalnce + floBlockchainAPI.getBalance(addr) +`getBalance` resolves balance for specified FLO address. +1. addr - FLO address for which balance has to be retrieved. + +#### writeData + floBlockchainAPI.writeData(senderAddr, Data, PrivKey, receiverAddr = floGlobals.adminID) +`writeData` writes data into blockchain. +1. senderAddr - FLO address from which the data and amount has to be sent. +2. Data - Actual FLO data that will be sent as string of 1040 characters. +3. receiverAddr - FLO address to which has to be sent. Default is specified in floGlobals.adminID. +4. PrivKey - Private key of sender to verify sender. + +#### sendTx + floBlockchainAPI.sendTx(senderAddr, receiverAddr, sendAmt, PrivKey, floData = '') +`sendTx` sends a transaction to blockchain, resolves transaction id if the transacation was succsessful. +1. senderAddr - FLO address from which the data and amount has to be sent. +2. receiverAddr - FLO address to which has to be sent. +3. sendAmt - Amount of FLO coins to be sent to receiver. +4. PrivKey - Private key of sender to verify sender. +5. floData - Actual FLO data that will be sent as string of 1040 characters. + +#### readTxs + floBlockchainAPI.readTxs(addr, from, to) +`readTxs` reads transactions of specified address between from and to. +1. addr - FLO address for which the transactions has to be read. +2. from - Reading transactions starts from 'from'. +3. to - Reading transactions ends on 'to'. + +#### readAllTxs + floBlockchainAPI.readTxs(addr) +`readAllTxs` reads all transactions of specified address(newest first). +1. addr - FLO address for which the transactions has to be read. + +#### readData + floBlockchainAPI.readData(addr, options = {}) +`readData` reads FLO data from transactions of specified address +1. addr - FLO address for which the transactions data has to be read. +2. options - Contains options for filter data from transactions. + a. limit : maximum number of filtered data (default = 1000, negative = no limit) + b. ignoreOld : ignore old transactions (default = 0) + c. sentOnly : filters only sent data + d. pattern : filters data that starts with a pattern + e. contains : filters data that contains a string + f. filter : custom filter funtion for floData (eg . filter: d => {return d[0] == '$'}) + +## Compact IndexedDB operations +`compactIDB` operations can be used to perform basic IndexedDB operations such as add, read/write, modify and remove.Contains following operations. + +#### setDefaultDB + compactIDB.setDefaultDB(dbName) +`setDefaultDB` sets the database on which further operations will be performed. +1. dbName - This is the name of default database to be used. + +#### initDB + compactIDB.initDB(dbName, objectStores = {}) +`initDB` initializes new IndexedDB. +1. dbName - Specifies database to be initialized. +2. objectStores - This is an object containing various objectStores to be initiazed when creating an IDB. + +#### openDB + compactIDB.openDB(dbName) +`openDB` returns a promise that resolves to a default database object. + +#### deleteDB + compactIDB.deleteDB(dbName) +`deleteDB` deletes the specified database. + +#### writeData + compactIDB.writeData(obsName, data) +`writeData` writes specified data into the database if data doesn't exists or replaces it when data is already present. +1. obsName - object store name in which the data is to be written. +2. data - data that has to be written in specified object store. + +#### addData + compactIDB.addData(obsName, data) +`addData` writes new data into object store. If data already exists, it will return an error. +1. obsName - Object store name in which has to be stored. +2. data - The data which has to be added to obeject store. + +#### removeData + compactDB.removeData(obsName, key) +`removeData` deletes data from specified object store using primary key. +1. obsName - Name of object store from which the data has to be removed. +2. key - Primary key of the specified object store. + +#### readData + compactDB.readData(obsName, key) +`readData` reads the data from object store associated with specified key. +1. obsName - Name of object store from which the data has to be retrieved. +2. key - 2.key - Primary key of the specified object store. + +#### readAllData + compactDB.readAllData(obsName) +`readAllData` reads all the data from specified object store using IndexedDB openCursor method. +1. obsName - Name of object store from which the data has to be retrieved. +`signData` signs the data using the private key +1. data - data to sign +2. privateKey - private key of the signer +