IOST

This is the main class that create transactions to send to IOST blockchain and IOST smart contracts.

constructor

constructor method is a special method for creating and initializing IOST class.

Parameters

Name	Type	Description
config	Object	config object for IOST class, config details as as follows: gasRatio: transaction gas price gasLimit: transaction gas limit expiration: time in seconds that transaction will be expired

Returns

IOST object instance.

Example

// init iost sdk
const iost = new IOST.IOST({ // will use default setting if not set
    gasRatio: 1,
    gasLimit: 100000,
    expiration: 90,
});

callABI

call contract abi function

Parameters

Name	Type	Description
contract	String	contract id or contract domain
abi	String	contract abi function name
args	Array	function args array

Returns

Transaction Object.

Example

const tx = iost.callABI(
	"token.iost",
	"transfer",
	["iost", "fromAccount", "toAccount", "10.000", "memo"]
);

newAccount

create new IOST blockchain account

Parameters

Name	Type	Description
name	String	new account name
creator	String	creator account name
ownerkey	String	creator account ownerKey
activekey	String	creator account activeKey
initialRAM	Number	new account initialRAM, paid by creator
initialGasPledge	Number	new account initialGasPledge, paid by creator

Returns

Transaction Object.

Example

// first create KeyPair for new account
const newKP = KeyPair.newKeyPair();
// then create new Account transaction
const newAccountTx = iost.newAccount(
    "test1",
    "admin",
    newKP.id,
    newKP.id,
    1024,
    10
);

transfer

transfer tokens to designated account, wrapper for callABI

Parameters

Name	Type	Description
token	String	token name
from	String	transfer-from account
to	String	transfer-to account
amount	String	transfer amount
memo	Number	memo of this transfer

Returns

Transaction Object.

Example

const tx = iost.transfer("iost", "fromAccount", "toAccount", "10.000", "memo");

Way to send tx

Here is the way sending tx in iost, it's compatible using third-party wallet.

iost.setAccount(account);
iost.setRPC(rpc);
iost.signAndSend(tx)
    .on("pending", console.log)
    .on("success", console.log)
    .on("failed", console.log);

Third-party wallets are recommended to hook IOST, and take over signAndSend() function, thus develops can work both wallet exist or not.

if wallet exists, signAndSend() works in wallet and callback when success or failed, and if not, iost use account to sign tx and using rpc to send it.

signAndSend

sign a tx and send it.

Parameters

Name	Type	Description
tx	IOST.Tx	tx to be send

Returns

a Callback object

Example

iost.signAndSend(tx)
    .on("pending", console.log)
    .on("success", console.log)
    .on("failed", console.log);

Callback.on(event, callback)

set handle to event

Parameters

Name	Type	Description
event	String	event name, include "pending", "success", "failed"
callback	function	callback function

Returns

itself.

Example

iost.signAndSend(tx)
    .on("pending", console.log)
    .on("success", console.log)
    .on("failed", console.log);

setAccount

set default account to iost

Parameters

Name	Type	Description
account	IOST.Account	account using by this iost instance

Returns

null

Example

iost.setAccount(account);

currentAccount

get current account in this iost

Parameters

null

Returns

an IOST.Account.

Example

const account = iost.currentAccount();

setRPC

transfer tokens to designated account, wrapper for callABI

Parameters

Name	Type	Description
rpc	IOST.RPC	rpc using by this IOST instance

Returns

null.

Example

iost.setRPC(rpc);

currentRPC

get current rpc

Parameters

null

Returns

an IOST.RPC instance.

Example

const rpc = iost.currentRPC();