FioJS is a Utility SDK for packing, signing and encryption functionality for the FIO blockchain. It is used by the FIO TypeScript SDK
npm install @fioprotocol/fiojsFor information on FIO, visit the FIO website.
For information on the FIO Chain, API, and SDKs visit the FIO Protocol Developer Hub.
cd fiojs
npm install
tsc
npm test (if you would like to run the unit tests)
sudo npm install -g typescript
cd fiosdk_typescript
yarn
tsc
npm test
npm publish --access public
Further details:
http://npmjs.com/
https://docs.npmjs.com/creating-and-publishing-scoped-public-packages
const { Fio, Ecc } = require('fiojs');
Import if using NPM package manager
const { Fio, Ecc } = require('@fioprotocol/fiojs');
Errors Installing?
if you don’t have tsc, install it, by navigating to terminal:
npm install -g typescript
// Include textDecoder and textEncoder when using in Node, React Native, IE11 or Edge Browsers.
const { TextEncoder, TextDecoder } = require('util'); // node only; native TextEncoder/Decoder
const { TextEncoder, TextDecoder } = require('text-encoding'); // React Native, IE11, and Edge Browsers only
How to Test
The mock tests run under prepareTransaction
Client-side serialization and signing. It is recommended that the FIO TypeScript SDK is used for FIO API calls. But, instead, if you plan to use external RPC code. This is example RPC code, for use outside of the JS Library instance:
`
const info = await rpc.get_info();
const blockInfo = await rpc.get_block(info.last_irreversible_block_num);
const currentDate = new Date();
const timePlusTen = currentDate.getTime() + 10000;
const timeInISOString = (new Date(timePlusTen)).toISOString();
const expiration = timeInISOString.substr(0, timeInISOString.length - 1);// hash the public key of the payer/sender
const actorAccountHash = Fio.accountHash('FIO7bxrQUTbQ4mqcoefhWPz1aFieN4fA9RQAiozRz7FrUChHZ7Rb8');
expect(accountHash).toEqual('5kmx4qbqlpld');
// sending 1 FIO token using the trnsfiopubkey ACTION (1 FIO token = 1,000,000,000 SUFs)
const transaction = {
expiration,
ref_block_num: blockInfo.block_num & 0xffff,
ref_block_prefix: blockInfo.ref_block_prefix,
actions: [{
account: 'fio.token',
name: 'trnsfiopubky',
authorization: [{
actor: actorAccountHash,
permission: 'active',
}],
data: {
payee_public_key: 'FIO5VE6Dgy9FUmd1mFotXwF88HkQN1KysCWLPqpVnDMjRvGRi1YrM',
amount: '1000000000',
max_fee: 1000000000,
tpid: '',
actor: actorAccountHash
},
}]
};
const abiMap = new Map()
const tokenRawAbi = await rpc.get_raw_abi('fio.token')
abiMap.set('fio.token', tokenRawAbi)
const tx = await Fio.prepareTransaction({transaction, chainId, privateKeys, abiMap, textDecoder: new TextDecoder(), textEncoder: new TextEncoder()});
const pushResult = await fetch(httpEndpoint + '/v1/chain/push_transaction', {
body: JSON.stringify(tx),
method: 'POST',
});
const json = await pushResult.json()
if (json.processed && json.processed.except) {
throw new RpcError(json);
}
expect(Object.keys(json)).toContain('transaction_id');
accountHash
Hashes public key to an on-chain Fio account name.
const accountHash = Fio.accountHash('FIO7bxrQUTbQ4mqcoefhWPz1aFieN4fA9RQAiozRz7FrUChHZ7Rb8');
expect(accountHash).toEqual('5kmx4qbqlpld');
createSharedCipher
The shared cipher class contains a secret used to encrypt and decrypt messages. For example, Alice sends a new_funds_request to Bob. In the there is a content field. The content field is encrypted by Alice and decrypted by Bob.
`
newFundsContent = {
payee_public_address: 'purse@alice',
amount: '1.75',
chain_code: 'FIO',
token_code: 'FIO',
memo: null,
hash: null,
offline_url: null
}privateKeyAlice = '5J9bWm2ThenDm3tjvmUgHtWCVMUdjRR1pxnRtnJjvKA4b2ut5WK';
publicKeyAlice = 'FIO7zsqi7QUAjTAdyynd6DVe8uv4K8gCTRHnAoMN9w9CA1xLCTDVv';
privateKeyBob = '5JoQtsKQuH8hC9MyvfJAqo6qmKLm8ePYNucs7tPu2YxG12trzBt';
publicKeyBob = 'FIO5VE6Dgy9FUmd1mFotXwF88HkQN1KysCWLPqpVnDMjRvGRi1YrM';
cipherAlice = Fio.createSharedCipher({privateKey: privateKeyAlice, publicKey: publicKeyBob, textEncoder: new TextEncoder(), textDecoder: new TextDecoder()});
cipherAliceHex = cipherAlice.encrypt('new_funds_content', newFundsContent);
// Alice sends cipherAliceHex to Bob via new_funds_request
cipherBob = Fio.createSharedCipher({privateKey: privateKeyBob, publicKey: publicKeyAlice, textEncoder: new TextEncoder(), textDecoder: new TextDecoder()});
newFundsContentBob = cipherBob.decrypt('new_funds_content', cipherAliceHex);
expect(newFundsContentBob).toEqual(newFundsContent);
See for other message types like new_funds_content.Message Encryption
See docs/message_encryption.md`