This is the official Javascript library for the IOTA Core. It implements both the official API, as well as newly proposed functionality (such as signing, bundles, utilities and conversion).
It should be noted that the Javascript Library as it stands right now is an early beta release. As such, there might be some unexpected results. Please join the community (see links below) and post issues on here, to ensure that the developers of the library can improve it.
Join the Discussion
If you want to get involved in the community, need help with getting setup, have any issues related with the library or just want to discuss Blockchain, Distributed Ledgers and IoT with other people, feel free to join our Slack. Slack You can also ask questions on our dedicated forum at: IOTA Forum.
npm install iota.lib.js
bower install iota.lib.js
Once you've built the dist with gulp, you can either use iota.js or the minified version iota.min.js in the browser.
It should be noted that this is a temporary home for the official documentation. We are currently transitioning to a new developer hub, where we will have a dedicated website for the API documentation with concrete examples. The below documentation should be sufficient in enabling you to get started in the meantime.
After you've successfully installed the library, it is fairly easy to get started by simply launching a new instance of the IOTA object with an optional settings object. When instantiating the object you have the option to decide the API provider that is used to send the requests to and you can also connect directly to the Sandbox environment.
The optional settings object can have the following values:
host:StringHost you want to connect to. Can be DNS, IPv4 or IPv6. Defaults tolocalhostport:Intport of the host you want to connect to. Defaults to 14265.provider:StringIf you don't provide host and port, you can supply the full provider value to connect tosandbox:BoolOptional value to determine if your provider is the IOTA Sandbox or not.token:StringToken string used for authenticating with the IOTA Sandbox ifsandboxis set totrue.
You can either supply the remote node directly via the provider option, or individually with host and port, as can be seen in the example below:
// Create IOTA instance with host and port as provider
var iota = new IOTA({
'host': 'http://localhost',
'port': 14265
});
// Create IOTA instance directly with provider
var iota = new IOTA({
'provider': 'http://localhost:14265'
});
// now you can start using all of the functions
iota.api.getNodeInfo();
// you can also get the version
iota.version
Overall, there are currently four subclasses that are accessible from the IOTA object:
api: Core API functionality for interacting with the IOTA core.utils: Utility related functions for conversions, validation and so onmultisig: Functions for creating and signing multi-signature addresses and transactions.valid: Validator functions that can help with determining whether the inputs or results that you get are valid.
You also have access to the version of the library
version: Current version of the library
In the future new IOTA Core modules (such as Flash, MAM) and all IXI related functionality will be available.
It should be noted that most API calls are done asynchronously. What this means is that you have to utilize callbacks in order to catch the response successfully. We will add support for sync API calls, as well as event listeners in future versions.
Here is a simple example of how to access the getNodeInfo function:
iota.api.getNodeInfo(function(error, success) {
if (error) {
console.error(error);
} else {
console.log(success);
}
})
This Javascript library has implemented all of the core API calls that are made available by the current IOTA Reference Implementation. For the full documentation of all the Standard API calls, please refer to the official documentation: official API.
You can simply use any of the available options from the api object then. For example, if you want to use the getTips function, you would simply do it as such:
iota.api.getTips(function(error, success) {
// do stuff here
})
Wrapper function for getTrytes and the Utility function transactionObjects. This function basically returns the entire transaction objects for a list of transaction hashes.
iota.api.getTransactionsObjects(hashes, callback)
hashes:ArrayList of transaction hashescallback:Functioncallback.
Array- list of all the transaction objects from the corresponding hashes.
Wrapper function for findTransactions, getTrytes and the Utility function transactionObjects. This function basically returns the entire transaction objects for a list of key values which you would usually use for findTransactions. Acceptable key values are:
bundles: List of bundle hashesaddresses: List of addressestags: List of transaction tags (27 trytes length)approvees: List of approvees
iota.api.findTransactionObjects(searchValues, callback)
searchValues:ObjectList of transaction hashes. e.g.{'hashes': ['ABCD']}callback:Functioncallback.
Array- list of all the transaction objects from the corresponding hashes.
Wrapper function for getNodeInfo and getInclusionStates. It simply takes the most recent solid milestone as returned by getNodeInfo, and uses it to get the inclusion states of a list of transaction hashes.
iota.api.getLatestInclusion(hashes, callback)
hashes:ArrayList of transaction hashescallback:Functioncallback.
Array- list of all the inclusion states of the transaction hashes
Wrapper function for broadcastTransactions and storeTransactions.
iota.api.broadcastAndStore(trytes, callback)
trytes:ArrayList of transaction trytes to be broadcast and stored. Has to be trytes that were returned fromattachToTanglecallback:Functioncallback.
Object - empty object.
Generates a new address from a seed and returns the address. This is either done deterministically, or by providing the index of the new address to be generated. When generating an address, you have the option to choose different security levels for your private keys. A different security level with the same key index, means that you will get a different address obviously (as such, you could argue that single seed has 3 different accounts, depending on the security level chosen).
In total, there are 3 different security options available to choose from:
| Input | Security Level | Security |
|---|---|---|
| 1 | Low | 81-trits |
| 2 | Medium | 162-trits |
| 3 | High | 243-trits |
iota.api.getNewAddress(seed [, options], callback)
seed:Stringtryte-encoded seed. It should be noted that this seed is not transferredoptions:Objectwhich is optional:
index:IntIf the index is provided, the generation of the address is not deterministic.checksum:BoolAdds 9-tryte address checksumtotal:IntTotal number of addresses to generate.security:IntSecurity level to be used for the private key / address. Can be 1, 2 or 3returnAll:BoolIf true, it returns all addresses which were deterministically generated (until findTransactions returns null)
callback:FunctionOptional callback.
String | Array - returns either a string, or an array of strings.
Gets all possible inputs of a seed and returns them with the total balance. This is either done deterministically (by genearating all addresses until findTransactions returns null for a corresponding address), or by providing a key range to use for searching through.
You can also define the minimum threshold that is required. This means that if you provide the threshold value, you can specify that the inputs should only be returned if their collective balance is above the threshold value.
iota.api.getInputs(seed, [, options], callback)
seed:Stringtryte-encoded seed. It should be noted that this seed is not transferredoptions:Objectwhich is optional:
start:intStarting key indexend:intEnding key indexsecurity:IntSecurity level to be used for the private key / address. Can be 1, 2 or 3threshold:intMinimum threshold of accumulated balances from the inputs that is requested
callback:FunctionOptional callback.
Object- an object with the following keys:inputsArray- list of inputs objects consisting ofaddress,balanceandkeyIndextotalBalanceint- aggregated balance of all inputs
Main purpose of this function is to get an array of transfer objects as input, and then prepare the transfer by generating the correct bundle, as well as choosing and signing the inputs if necessary (if it's a value transfer). The output of this function is an array of the raw transaction data (trytes).
You can provide multiple transfer objects, which means that your prepared bundle will have multiple outputs to the same, or different recipients. As single transfer object takes the values of: address, value, message, tag. The message and tag values are required to be tryte-encoded. If you do not supply a message or a tag, the library will automatically enter empty ones for you. As such the only required fields in each transfers object are address and value.
If you provide an address with a checksum, this function will automatically validate the address for you with the Utils function isValidChecksum.
For the options, you can provide a list of inputs, that will be used for signing the transfer's inputs. It should be noted that these inputs (an array of objects) should have the provided 'security', keyIndex and address values:
var inputs = [{
'keyIndex': //VALUE,
'address': //VALUE,
'security': //VALUE
}]
The library validates these inputs then and ensures that you have sufficient balance. When defining these inputs, you can also provide multiple inputs on different security levels. The library will correctly sign these inputs using your seed and the corresponding private keys. Here is an example using security level 3 and 2 for a transfer:
iota.api.prepareTransfers(seed,
[{
'address': 'SSEWOZSDXOVIURQRBTBDLQXWIXOLEUXHYBGAVASVPZ9HBTYJJEWBR9PDTGMXZGKPTGSUDW9QLFPJHTIEQZNXDGNRJE',
'value': 10000
}], {
'inputs': [
{
address: 'XB9IBINADVMP9K9FEIIR9AYEOFUU9DP9EBCKOTPSDVSNRRNVSJOPTFUHSKSLPDJLEHUBOVEIOJFPDCZS9',
balance: 1500,
keyIndex: 0,
security: 3
}, {
address: 'W9AZFNWZZZNTAQIOOGYZHKYJHSVMALVTWJSSZDDRVEIXXWPNWEALONZLPQPTCDZRZLHNIHSUKZRSZAZ9W',
balance: 8500,
keyIndex: 7,
security: 2
}
], function(e, s) {
console.log(e,s);
})
The address option can be used to define the address to which a remainder balance (if that is the case), will be sent to. So if all your inputs have a combined balance of 2000, and your spending 1800 of them, 200 of your tokens will be sent to that remainder address. If you do not supply the address, the library will simply generate a new one from your seed (taking security into account, or using the standard security value of 2 (medium)).
iota.api.prepareTransfers(seed, transfersArray [, options], callback)
seed:Stringtryte-encoded seed. It should be noted that this seed is not transferredtransfersArray:Arrayof transfer objects:
address:String81-tryte encoded address of recipientvalue:Intvalue to be transferred.message:Stringtryte-encoded message to be included in the bundle.tag:StringTryte-encoded tag. Maximum value is 27 trytes.
options:Objectwhich is optional:
inputs:ArrayList of inputs used for funding the transferaddress:Stringif defined, this address will be used for sending the remainder value (of the inputs) to.security:IntSecurity level to be used for the private key / addresses. This is for inputs and generating of the remainder address in case you did not specify it. Can be 1, 2 or 3
callback:FunctionOptional callback.
Array - an array that contains the trytes of the new bundle.
Wrapper function that does attachToTangle and finally, it broadcasts and stores the transactions.
iota.api.sendTrytes(trytes, depth, minWeightMagnitude, callback)
trytesArraytrytesdepthIntdepth value that determines how far to go for tip selectionminWeightMagnitudeIntminWeightMagnitudecallback:FunctionOptional callback.
Array - returns an array of the transfer (transaction objects).
Wrapper function that basically does prepareTransfers, as well as attachToTangle and finally, it broadcasts and stores the transactions locally.
iota.api.sendTransfer(seed, depth, minWeightMagnitude, transfers [, options], callback)
seedStringtryte-encoded seed. If provided, will be used for signing and picking inputs.depthIntdepthminWeightMagnitudeIntminWeightMagnitudetransfers:Arrayof transfer objects:
address:String81-tryte encoded address of recipientvalue:Intvalue to be transferred.message:Stringtryte-encoded message to be included in the bundle.tag:String27-tryte encoded tag.
options:Objectwhich is optional:
inputs:ArrayList of inputs used for funding the transferaddress:Stringif defined, this address will be used for sending the remainder value (of the inputs) to.
callback:FunctionOptional callback.
Array - returns an array of the transfer (transaction objects).
Takes a tail transaction hash as input, gets the bundle associated with the transaction and then replays the bundle by attaching it to the tangle.
iota.api.replayBundle(transaction, depth, minWeightMagnitude [, callback])
transaction:StringTransaction hash, has to be tail.depthIntdepthminWeightMagnitudeIntminWeightMagnitudecallback:FunctionOptional callback
Takes a tail transaction hash as input, gets the bundle associated with the transaction and then rebroadcasts the entire bundle.
iota.api.broadcastBundle(transaction [, callback])
transaction:StringTransaction hash, has to be tail.callback:FunctionOptional callback
This function returns the bundle which is associated with a transaction. Input has to be a tail transaction (i.e. currentIndex = 0). If there are conflicting bundles (because of a replay for example) it will return multiple bundles. It also does important validation checking (signatures, sum, order) to ensure that the correct bundle is returned.
iota.api.getBundle(transaction, callback)
transaction:StringTransaction hash of a tail transaction.callback:FunctionOptional callback
Array - returns an array of the corresponding bundle of a tail transaction. The bundle itself consists of individual transaction objects.
Returns the transfers which are associated with a seed. The transfers are determined by either calculating deterministically which addresses were already used, or by providing a list of indexes to get the addresses and the associated transfers from. The transfers are sorted by their timestamp. It should be noted that, because timestamps are not enforced in IOTA, that this may lead to incorrectly sorted bundles (meaning that their chronological ordering in the Tangle is different).
If you want to have your transfers split into received / sent, you can use the utility function categorizeTransfers
iota.api.getTransfers(seed [, options], callback)
seed:Stringtryte-encoded seed. It should be noted that this seed is not transferredoptions:Objectwhich is optional:
start:IntStarting key index for searchend:IntEnding key index for searchsecurity:IntSecurity level to be used for the private key / addresses, which is used for getting all associated transfers.inclusionStates:BoolIf True, it gets the inclusion states of the transfers.
callback:FunctionOptional callback.
Array - returns an array of transfers. Each array is a bundle for the entire transfer.
Similar to getTransfers, just a bit more comprehensive in the sense that it also returns the addresses, transfers, inputs and balance that are associated and have been used with your account (seed). This function is useful in getting all the relevant information of your account. If you want to have your transfers split into received / sent, you can use the utility function categorizeTransfers
iota.api.getAccountData(seed [, options], callback)
seed:Stringtryte-encoded seed. It should be noted that this seed is not transferredoptions:Objectwhich is optional:
start:IntStarting key index for searchend:IntEnding key index for searchsecurity:IntSecurity level to be used for the private key / addresses, which is used for getting all associated transfers.
callback:FunctionOptional callback.
Object - returns an object of your account data in the following format:
{
'latestAddress': '', // Latest, unused address which has no transactions in the tangle
'addresses': [], // List of all used addresses which have transactions associated with them
'transfers': [], // List of all transfers associated with the addresses
'inputs': [], // List of all inputs available for the seed. Follows the getInputs format of `address`, `balance`, `security` and `keyIndex`
'balance': 0 // latest confirmed balance
}
This API function helps you to determine whether you should replay a transaction or make a completely new transaction with a different seed. What this function does, is it takes an input address (i.e. from a spent transaction) as input and then checks whether any transactions with a value transferred are confirmed. If yes, it means that this input address has already been successfully used in a different transaction and as such you should no longer replay the transaction.
iota.api.isReattachable(inputAddress, callback)
inputAddress:String | Arrayaddress used as input in a transaction. Either string or array.callback:Functioncallback function
Bool - true / false (if you provided an array, it's an array of bools)
All utils function are done synchronously.
IOTA utilizes the Standard system of Units. See below for all available units:
'i' : 1,
'Ki' : 1000,
'Mi' : 1000000,
'Gi' : 1000000000,
'Ti' : 1000000000000,
'Pi' : 1000000000000000
iota.utils.convertUnits(value, fromUnit, toUnit)
value:Integer || StringValue to be converted. Can be string, an integer or float.fromUnit:StringCurrent unit of the value. See above for the available units to utilize for conversion.toUnit:StringUnit to convert the from value into.
Integer - returns the converted unit (fromUnit => toUnit).
Takes a tryte-encoded input value and adds a checksum (length is user defined). Standard checksum length is 9 trytes. If isAddress is defined as true, it will validate if it's a correct 81-tryte enocded address.
iota.utils.addChecksum(inputValue, checksumLength, isAddress)
inputValue:String | ListEither an individual tryte value, or a list of tryte values.checksumLength:IntChecksum length. Default is 9 trytesisAddress:Boolindicates whether the input value should be validated as an address (81-trytes). Default is true.
String | List - returns the input value + checksum either as a string or list, depending on the input.
Takes an 90-trytes address as input and simply removes the checksum.
iota.utils.noChecksum(address)
address:String | List90-trytes address. Either string or a list
String | List - returns the 81-tryte address(es)
Takes an 90-trytes checksummed address and returns a true / false if it is valid.
iota.utils.isValidChecksum(addressWithChecksum)
addressWithChecksum:String90-trytes address
Bool - True / False whether the checksum is valid or not
Converts the trytes of a transaction into its transaction object.
iota.utils.transactionObject(trytes)
trytes:String2673-trytes of a transaction
Object - Transaction object
Converts a valid transaction object into trytes. Please refer to [TODO] for more information what a valid transaction object looks like.
iota.utils.transactionTrytes(transactionObject)
transactionObject:Objectvalid transaction object
trytes - converted trytes of
Categorizes a list of transfers into sent and received. It is important to note that zero value transfers (which for example, is being used for storing addresses in the Tangle), are seen as received in this function.
iota.utils.categorizeTransfers(transfers, addresses)
transfers:ArrayA list of bundles. Basically is an array, of arrays (bundles), as is returned from getTransfers or getAccountDataaddresses:ArrayList of addresses that belong to you. With these addresses as input, it's determined whether it's a sent or a receive transaction. Therefore make sure that these addresses actually belong to you.
object - the transfers categorized into sent and received
Converts ASCII characters into trytes according to our encoding schema (read the source code for more info as to how it works). Currently only works with valid ASCII characters. As such, if you provide invalid characters the function will return null. In case you want to convert JSON data, stringify it first.
iota.utils.toTrytes(input)
input:StringString you want to convert into trytes. All non-string values should be converted into strings first.
string || null - trytes, or null in case you provided an invalid ASCII character
Reverse of toTrytes.
iota.utils.fromTrytes(trytes)
trytes:StringTrytes you want to convert to string
string - string
This function takes a bundle as input and from the signatureMessageFragments extracts the JSON encoded data which was sent with the transfer. This currently only works with the toTrytes and fromTrytes function that use the ASCII <-> Trytes encoding scheme. In case there is no JSON data, or invalid one, this function will return null
iota.utils.extractJson(bundle)
bundle:Arraybundle from which you want to extract the JSON data.
String - Stringified JSON object which was extracted from the transactions.
This function makes it possible for each of the co-signers in the multi-signature to independently verify that a generated transaction with the corresponding signatures of the co-signers is valid. This function is safe to use and does not require any sharing of digests or key values.
iota.utils.validateSignatures(signedBundle, inputAddress)
signedBundle:Arraysigned bundle by all of the co-signersinputAddress:Stringinput address as provided toinitiateTransfer.
bool - true / false
Checks if the provided bundle is valid. The provided bundle has to be ordered tail (i.e. currentIndex: 0) first. A bundle is deemed valid if it has:
- Valid transaction structure
- Correct
currentIndex,lastIndexand number of bundle transactions - The sum of all
valuefields is 0 - The bundle hash is correct
- Valid signature
iota.utils.isBundle(bundle)
bundle:Arraybundle to test
bool - true / false
Multi signature related functions.
VERY IMPORTANT NOTICE
Before using these functions, please make sure that you have thoroughly read our guidelines for multi-signature. It is of utmost importance that you follow these rules, else it can potentially lead to financial losses.
Generates the corresponding private key (depending on the security chosen) of a seed.
iota.multisig.getKey(seed, index, security)
seed:StringTryte encoded seedindex: 'Int' Index of the private key.security:IntSecurity level to be used for the private key
String - private key represented in trytes.
Generates the digest value of a key.
iota.multisig.getDigest(seed, index)
seed:StringTryte encoded seedindex: 'Int' Index of the private key.security:IntSecurity level to be used for the private key
String - digest represented in trytes.
This function is used to initiate the creation of a new multisig address. Once all digests were added with addDigest(), finalize() can be used to get the actual 81-tryte address value. validateAddress() can be used to actually validate the multi-signature.
var address = new iota.multisig.address(digests);
digestTrytes:String || ArrayOptional string or array of digest trytes as returned bygetDigest
Object - multisig address instance
Absorbs the digests of co-signers
address.addDigest(digest);
digest:String || ArrayString or array of digest trytes as returned bygetDigest
Object - multisig address instance
Finalizes the multisig address generation process and returns the correct 81-tryte address.
address.finalize()
String - 81-tryte multisig address
Validates a generated multi-sig address by getting the corresponding key digests of each of the co-signers. The order of the digests is of essence in getting correct results.
iota.multisig.validateAddress(multisigAddress, digests)
multisigAddress:Stringdigest trytes as returned bygetDigestdigests: 'Array' array of the key digest for each of the cosigners. The digests need to be provided in the correct signing order.
Bool - true / false
Initiates the creation of a new transfer by generating an empty bundle with the correct number of bundle entries to be later used for the signing process. It should be noted that currently, only a single input (via inputAddress) is possible. The remainderAddress also has to be provided and should be generated by the co-signers of the multi-signature before initiating the transfer.
The securitySum input is basically the sum of the security levels from all cosigners chosen during the private key generation (getKey / getDigest). e.g. when creating a new multisig, Bob has chosen security level 2, whereas Charles has chosen security level 3. Their securitySum is 5.
iota.multisig.initiateTransfer(securitySum, inputAddress, remainderAddress, transfers, callback)
securitySum:IntThe sum of the security levels chosen by all cosigners when generating the private keys.inputAddress:Stringinput address which has sufficient balance and is controlled by the co-signersremainderAddress:Stringin case there is a remainder balance, send the funds to this address. If you do not have a remainder balance, you can simply putnulltransfers:ArrayTransfers objectcallback:Function
Array - bundle
This function is called by each of the co-signers individually to add their signature to the bundle. Here too, order is important. This function returns the bundle, which should be shared with each of the participants of the multi-signature.
After having added all signatures, you can validate the signature with the utils.validateSignature() function.
iota.multisig.addSignature(bundleToSign, inputAddress, key, callback)
bundleToSign:Arraybundle to signinputAddress:Stringinput address as provided toinitiateTransfer.key:Stringprivate key trytes as returned bygetKeycallback:Function
Array - bundle
Validator functions. Return either true / false.
Checks if the provided input is a valid 81-tryte (non-checksum), or 90-tryte (with checksum) address.
iota.valid.isAddress(address)
address:StringA single address
Determines if the provided input is valid trytes. Valid trytes are: ABCDEFGHIJKLMNOPQRSTUVWXYZ9. If you specify the length parameter, you can also validate the input length.
iota.valid.isTrytes(trytes [, length])
trytes:Stringlength:int || stringoptional
Validates the value input, checks if it's integer.
iota.valid.isValue(value)
value:Integer
Checks if the input value is a number, can be a string, float or integer.
iota.valid.isNum(value)
value:Integer
Checks if correct hash consisting of 81-trytes.
iota.valid.isHash(hash)
hash:String
Checks if it's a correct array of transfer objects. A transfer object consists of the following values:
{
'address': // STRING (trytes encoded, 81 or 90 trytes)
'value': // INT
'message': // STRING (trytes encoded)
'tag': // STRING (trytes encoded, maximum 27 trytes)
}
iota.valid.isTransfersArray(transfersArray)
transfersArray:array
Array of valid 81 or 90-trytes hashes.
iota.valid.isArrayOfHashes(hashesArray)
hashesArray:Array
Checks if it's an array of correct 2673-trytes. These are trytes either returned by prepareTransfers, attachToTangle or similar call. A single transaction object is encoded 2673 trytes.
iota.valid.isArrayOfTrytes(trytesArray)
trytesArray:Array
Similar to isArrayOfTrytes, just that in addition this function also validates that the last 243 trytes are non-zero (meaning that they don't equal 9). The last 243 trytes consist of: trunkTransaction + branchTransaction + nonce. As such, this function determines whether the provided trytes have been attached to the tangle successfully. For example this validator can be used for trytes returned by attachToTangle.
iota.valid.isArrayOfAttachedTrytes(trytesArray)
trytesArray:Array
Checks if the provided bundle is an array of correct transaction objects. Basically validates if each entry in the array has all of the following keys:
var keys = [
'hash',
'signatureMessageFragment',
'address',
'value',
'tag',
'timestamp',
'currentIndex',
'lastIndex',
'bundle',
'trunkTransaction',
'branchTransaction',
'nonce'
]
iota.valid.isArrayOfTxObjects(bundle)
bundle:Array
Validates if it's an array of correct input objects. These inputs are provided to either prepareTransfers or sendTransfer. An input objects consists of the following:
{
'keyIndex': // INT
'address': // STRING
}
iota.valid.isInputs(inputsArray)
inputsArray:Array
Self explanatory.
iota.valid.isString(string)
Self explanatory.
iota.valid.isArray(array)
Self explanatory.
iota.valid.isObject(array)
Validates a given string to check if it's a valid IPv6, IPv4 or hostname format. The string must have a udp:// prefix, and it may or may not have a port. Here are some example inputs:
udp://[2001:db8:a0b:12f0::1]:14265
udp://[2001:db8:a0b:12f0::1]
udp://8.8.8.8:14265
udp://domain.com
udp://domain2.com:14265
iota.utils.isUri(node)
node:StringIPv6, IPv4 or Hostname with or without a port.
bool - true/false if valid node format.