mui-metablockchain-sdk v3.0.1

MUI Metablockchain SDK

JS SDK to interface with MetaMUI Metablockchain node.

Install

npm install mui-metablockchain-sdk

Usage

Network options

The best practice is to first create a websocket connection to the network you intend to connect with and then pass this object to all function calls. The available network options are local, dev, testnet, mainnet If no network is specified, the functions default to either dev or local. In future when multiple nodes are being hosted, the user will have to option to pass url of the node itself.

Example

• Create a DID and write on chain

const { connection, did, config } = require('mui-metablockchain-sdk');
const NETWORK = "dev";

async function create_new_did(){

const mnemonic = "//Bob";
const new_did = "sample";

// create the DID object
let did_obj = await did.generateDID(mnemonic, new_did, "");

//Use the validator account to sign did operation
const keyring = await config.initKeyring();
const sig_key_pair = await keyring.addFromUri('//Alice');

let provider = await connection.buildConnection(NETWORK);
let tx_hash = await did.storeDIDOnChain(did_obj, sig_key_pair, provider);

return tx_hash;
}

Test

npm test

Modules

• Connection
• Balance
• Collective
• DID
• token
• Transactions
• VC
• Utils
• Schema
• SSID VC

Connection Utilities

Functions

buildConnection(network, ignoreCache)

Return an APIPromise object

Kind: global function

Balance Utilities

Functions

getBalance(did, api) ⇒ String

Get account balance(Highest Form) based on the did supplied.

Kind: global function
Returns: String - Balance In Highest Form

Example

await getBalanceFromDID(did, api)

subscribeToBalanceChanges(identifier, callback, api)

Listen to balance changes for a DID and execute the callback.

Kind: global function

Collective Utilities

Functions

setMembers(newMembers, prime, oldCount, signingKeypair) ⇒ String

Set Members and prime of collective pallet

Kind: global function
Returns: String - Hash

propose(threshold, proposal, lengthCount, signingKeypair)

To create a proposal

Kind: global function

execute(proposal, lengthCount, signingKeypair)

To Execute a call

Kind: global function

vote(proposalHash, index, approve, signingKeypair)

Vote on a proposal

Kind: global function

close(proposalHash, index, proposalWeightBond, lengthCount, signingKeypair)

Close a proposal manually, executes call if yes votes is greater than or equal to threshold

Kind: global function

disapproveProposal(proposalHash, signingKeypair)

Disapprove proposal

Kind: global function

getMembers(api)

Get Members of Council

Kind: global function

getPrime(api)

Get Prime of Council

Kind: global function

getProposals(api)

Get All Proposals

Kind: global function

getProposalOf(proposalHash, api)

Get Proposal of given hash

Kind: global function

getVotes(proposalHash, api)

Get Votes of given proposal hash

Kind: global function

getProposalCount(api)

Get Total proposals count

Kind: global function

DID Utilties

Functions

generateMnemonic() ⇒ String

Generate Mnemonic

Kind: global function
Returns: String - Mnemonic

storeDIDOnChain(params, api) ⇒ String

Stores the generated DID object on the blockchain.

Kind: global function
Returns: String - The transaction ID for the storage operation.

updateDidKey(params, api) ⇒ Promise.<void>

Rotates the keys assigned to a DID. This operation should only be called by validator accounts, otherwise it will fail.

Kind: global function
Returns: Promise.<void> - A promise that resolves once the operation is completed.

addPublicKey(vcHex, signingKeypair, api) ⇒ Promise.<String>

Store the generated DID object in blockchain

Kind: global function
Returns: Promise.<String> - Promise that resolves to txnId for storage operation.

updateMetadata(identifier, metadata, signingKeypair, api) ⇒ Promise.<String>

Kind: global function
Returns: Promise.<String> - Promise that resolves to txnId for storage operation.

getDIDDetails(identifier) ⇒ JSON

Get did information from accountID

Kind: global function

didLookup(identifier) ⇒ JSON

Get did information from Did

Kind: global function

didLookupByApp(params, api) ⇒ JSON

Get did information from Did

Kind: global function

getBlockNumber(params, api) ⇒ Promise.<String>

Get the block number for a given DID

Kind: global function
Returns: Promise.<String> - - The block number associated with the given DID

resolveDIDToAccount(params, api) ⇒ String

Get the accountId for a given DID

Kind: global function
Returns: String - - The account ID associated with the given DID

resolveAccountIdToDid(accountId, api) ⇒ String | Boolean

Get the DID associated to given accountID

Kind: global function
Returns: String | Boolean - (false if not found)

getDidPalletVersion(api) ⇒ JSON | null

Get did information from accountID

Kind: global function
Returns: JSON | null - - The pallet version data or null if an error occurs

getPublicKeyByAppId(params, api) ⇒ JSON

Get public key details for a given DID identifier and optional application ID

Kind: global function
Returns: JSON - - The public key details in JSON format
Throws:

• Error - Throws an error if unable to fetch public key details

isDidValidator(identifier, api) ⇒ Boolean

Check if the user is an approved validator

Kind: global function

getDidKeyHistory(params, api) ⇒ Array

Fetch the history of rotated keys for the specified DID

Kind: global function
Returns: Array - - The key history data
Throws:

• Error - Throws an error if unable to fetch key history

generateDID(mnemonic, identifier, metadata) ⇒ Object

Generate did object to be stored in blockchain.

Kind: global function
Returns: Object - Object containing did structure

generateAddKeyVC(params, owner, sigKeypair) ⇒ String

Create VC

Kind: global function
Returns: String - VC Hex String

sanitiseDid(did) ⇒ String

Checks if the given did is in hex format or not & converts it into valid hex format.

Note: This util function is needed since dependant module wont convert the utf did to hex anymore

Kind: global function
Returns: String - Hex did

findRegionFromDid(did)

This function will find the region from the DID

Kind: global function

convertFixedSizeHex(data, size) ⇒ String

Convert to hex but return fixed size always, mimics substrate storage

Kind: global function

Token Utilities

Functions

issueToken(vcId, totalIssuanceAmt, senderAccountKeyPair, api) ⇒ hexString

Issue new token from given vc Id. Amount is in lowest form here but everywhere else it's in highest form

Kind: global function

transferToken(recipentDid, currencyCode, tokenAmount, senderAccountKeyPair, api) ⇒ hexString

Transfer token with given token_id to the recipent_did

Kind: global function

transferTokenWithMemo(recipentDid, currencyCode, tokenAmount, memo, senderAccountKeyPair, api) ⇒ hexString

Transfer token with given token_id to the recipent_did with an additional memo

Kind: global function

transferAll(recipentDid, currencyCode, senderAccountKeyPair, api) ⇒ hexString

Transfer all token with given vc_id to the recipent_did

Kind: global function

slashToken(vcId, senderAccountKeyPair, api) ⇒ hexString

Slash token from given currency

Kind: global function

mintToken(vcId, senderAccountKeyPair, api) ⇒ hexString

Mint token to given currency

Kind: global function

getTokenBalance(did, currencyCode, api) ⇒ String

Get the token balance for a given token for given did

Kind: global function
Returns: String - Balance In Highest Form

subscribeToGetTokenBalance(did, currencyCode, callback, api) ⇒ Object

Subscribe to get the detailed token balance for a given token for given did

Kind: global function
Returns: Object - In Highest Form

getDetailedTokenBalance(did, currencyCode, api) ⇒ Object

Get the detailed token balance for a given token for given did

Kind: global function
Returns: Object - In Highest Form

subscribeToGetDetailedTokenBalance(did, currencyCode, callback, api) ⇒ Object

Subscribe to get the detailed token balance for a given token for given did

Kind: global function
Returns: Object - In Highest Form

getTokenList(api) ⇒ Array

Get the list of all active tokens in metablockchain network

Kind: global function
Returns: Array - { id: '1', name: 'XYZ' }, { id: '2', name: 'ABC' }

getTokenData(currencyCode, api) ⇒ Object

Get the token by currency id in metablockchain network

Kind: global function

getTokenTotalSupply(currencyCode, api) ⇒ String

Get the total issuance amount for given currency id

Kind: global function
Returns: String - TotalSupply In Highest Form

getLocks(currencyCode, api) ⇒ Object

Get the lock for given currency id

Kind: global function

getTokenIssuer(currencyCode, api) ⇒ String

Get the issuer for given token code

Kind: global function

withdrawTreasuryReserve(destination, from, amount, senderAccountKeyPair, api) ⇒ String

Function to withdraw the treasury reserve amount locked at the time of token creation. Only a validator can call this operation succesfully.

Kind: global function
Returns: String - transaction_hex_id

transferTokenWithVC(vcId, receiverDID, senderAccountKeyPair, api) ⇒ hexString

Transfer token of given currency to given Did from Currency owner account

Kind: global function

setBalance(dest, currencyCode, amount, senderAccountKeyPair, api) ⇒ hexString

Set balance of did with given token_id Can be called only token owner

Kind: global function

sanitiseCCode(currency_code) ⇒ String

Checks if the given currency_code is in hex format or not & converts it into valid hex format.

Note: This util function is needed since dependant module wont convert the utf did to hex anymore

Kind: global function
Returns: String - Hex currency_code

getFormattedTokenAmount(currency_code, tokenAmount, provider) ⇒ Number

Formats the given amount into lowest form based on the decimals supported by given token.

Kind: global function
Returns: Number - tokenAmount in lowest form else error

removeToken(currencyCode, vcId, clearAccounts, signingKeypair, identity) ⇒ String

Remove token

Kind: global function
Returns: String - Hash

Transaction Utilities

Functions

sendTransaction(senderAccountKeyPair, receiverDID, amount, api, nonce) ⇒ Uint8Array

The function will perform a metamui transfer operation from the account of senderAccount to the receiverDID. Note : balanceCheck has not been included in the checks since sender not having balance is handled in extrinsic, check test/transaction.js

Kind: global function

transfer(senderAccountKeyPair, receiverDID, amount, memo, api, nonce) ⇒ Uint8Array

This function is similar to sendTransaction except that it provides the user to add the memo to transfer functionality.

Kind: global function

Verifiable Credential (VC) Utilities

Functions

createTokenVC(TokenVC) ⇒ String

Encodes Token VC and pads with appropriate bytes

Kind: global function
Returns: String - Token VC Hex String

createMintSlashVC(vcProperty) ⇒ String

Encodes Token VC and pads with appropriate bytes

Kind: global function
Returns: String - Token VC Hex String

createTokenTransferVC(vcProperty) ⇒ String

Encodes Token VC and pads with appropriate bytes

Kind: global function
Returns: String - Token VC Hex String

createGenericVC(vcProperty) ⇒ String

Encodes Generic VC and pads with appropriate bytes

Kind: global function
Returns: String - Token VC Hex String

generateVC(vcProperty, owner, issuers, vcType, sigKeypair) ⇒ String

Create VC

Kind: global function
Returns: String - VC Hex String

approveVC(vcID, signingKeyPair, api) ⇒ String

Approve VC

Kind: global function
Returns: String - Transaction hash or Error

storeVC(vcHex, senderAccountKeyPair, api) ⇒ hexString

Store vc hex

Kind: global function

updateStatus(vcId, vcStatus, senderAccountKeyPair, api) ⇒ hexString

Update Status

Kind: global function

getVCs(vcId, api) ⇒ String

Get VCs by VC id

Kind: global function
Returns: String - (false if not found)

getVCIdsByDID(did, api) ⇒ String

Get VC Ids by did

Kind: global function
Returns: String - (false if not found)

getDIDByVCId(vcId, api) ⇒ String

Get DID by VC Id

Kind: global function
Returns: String - (false if not found)

getVCHistoryByVCId(vcId, api) ⇒ String

Get VC history by VC Id

Kind: global function
Returns: String - (false if not found)

getVCApprovers(vcId, api) ⇒ Array.<Did>

Get approved issuers of the VC

Kind: global function
Returns: Array.<Did> - approved issuer list

getGenericVCDataByCId(vcId, api) ⇒ JSON

Get Generic vc data

Kind: global function
Returns: JSON - Generic VC data

getGenericVCData(vcId, api) ⇒ JSON

Get Generic vc data

Kind: global function
Returns: JSON - Generic VC data

verifyGenericVC(vcId, data, api) ⇒ Boolean

Verify Generic Vc data

Kind: global function
Returns: Boolean - true if verified

createVC(properties_json, schema_hash) ⇒ JSON

The function returns the VC in the expected format, the verifier and signature fields are left blank to be filled by signing function

Kind: global function

signVC(vcJson, verifierDid, signingKeyPair) ⇒ JSON

Sign a VC using the given verifier_pvkey

Kind: global function

verifyVC(vcJson) ⇒ Boolean

Verify if the signature/verifier DID is valid and matches the given data in vc_json

Kind: global function
Returns: Boolean - true if valid VC

Other Utilities

Functions

bytesToHex(inputBytes)

Kind: global function

hexToBytes(inputString)

Kind: global function

base58ToBytes(bs58string)

Kind: global function

stringToBytes(inputString)

Kind: global function

hexToString(hexString)

Kind: global function

vcHexToVcId(hexString)

Kind: global function

encodeData(data, typeKey) ⇒ String

Encodes object/ string of given type to hex

Kind: global function
Returns: String - Encoded Hex

decodeHex(hexValue, typeKey) ⇒ Object | String

Decodes hex of given type to it's corresponding object/value

Kind: global function
Returns: Object | String - Decoded Object/String

isUpperAndValid(str) ⇒

Checks if str is upper and only contains characters

Kind: global function
Returns: bool

tidy(s) ⇒ Object | String

regex to remove unwanted hex bytes

Kind: global function
Returns: Object | String - Decoded tidy Object/String

getVCS(hexValue, typeKey) ⇒ Object | String

function that decodes hex of createTokenVC

Kind: global function
Returns: Object | String - Decoded Object/String

decodeVC(hexValue, typeKey) ⇒ Object | String

function that decodes hex of createVC where type is TokenVC to it's corresponding object/value

Kind: global function
Returns: Object | String - Decoded Object/String

sortObjectByKeys(unorderedObj) ⇒ Object

Sort object by keys

Kind: global function
Returns: Object - ordered object by key

generateObjectHash(unordered) ⇒ Object

generate blake hash of js object

Kind: global function
Returns: Object - ordered object by key

Schema

Functions

createNewSchema(schema_properties) ⇒ JSON

Create a new schema with the properties provided in the schema_properties json The stringified schema and its hash will be returned as required by the extrinsic.

Kind: global function

storeSchemaOnChain(schema, signingKeypair)

Write a new schema to the chain using the account provided This extrinsic can only be called by the accounts in the validator_set pallet

Kind: global function

doesSchemaExist(schemaHash) ⇒ Boolean

The function will returns the Boolean value based on valid/invalid schemaHash.

Kind: global function
Returns: Boolean - Will return true, if valid schemaHash

SSID VC

Functions

createSsidVC(properties_json) ⇒ JSON

The function returns the VC in the expected format, the signature field is left blank to be filled by signing function

Kind: global function

signSsidVC(vcJson, signerKeyPair) ⇒ JSON

Sign a VC using the given verifier_pvkey

Kind: global function

verifySsidVC(vcJson) ⇒ Boolean

Verify if the signature is valid and matches the given public_key in ssid_vc

Kind: global function
Returns: Boolean - true if valid SSID_VC