The following example shows how to create and account with keyring.
-// Import Keyring class and utility function
-const Keyring = require('@polkadot/keyring').default;
-const stringToU8a = require('@polkadot/util/string/toU8a').default;
-
-async function main () {
- // Create account seed for Alice
- const ALICE_SEED = 'Alice'.padEnd(32, ' ');
-
- // Create an instance of the Keyring
- const keyring = new Keyring();
-
- // Create pair and add Alice to keyring pair dictionary (with account seed)
- const pairAlice = keyring.addFromSeed(stringToU8a(ALICE_SEED));
-
- console.log(`Created keyring pair for Alice with address: ` +
- `${keyring.getPair(pairAlice.address()).address()}`);
-}
-
-main().catch(console.error).finally(_ => process.exit());
-The following example shows how to load all accounts from the keyring as pairs and convert them into JSON format.
-// Import Keyring class and utility function
-const Keyring = require('@polkadot/keyring').default;
-const stringToU8a = require('@polkadot/util/string/toU8a').default;
-
-async function main () {
- // Create account seed for Alice and Bob
- const ALICE_SEED = 'Alice'.padEnd(32, ' ');
- const BOB_SEED = 'Bob'.padEnd(32, ' ');
-
- // Create an instance of the Keyring
- const keyring = new Keyring();
-
- // Create their pairs with account seeds. Add to keyring pair dictionary
- keyring.addFromSeed(stringToU8a(ALICE_SEED));
- keyring.addFromSeed(stringToU8a(BOB_SEED));
-
- // Note that we did not use `addFromAddress` since it does not add the
- // secret key to memory so we cannot later retrieve it with `getPairs`
-
- // Retrieve all keyring pairs from the keyring pair dictionary
- keyring
- .getPairs()
- .forEach((pair, index) => {
- const address = pair.address();
-
- console.log(`\nAccount with index #${index} has json: `,
- JSON.stringify(keyring.toJson(address), null, 2));
- });
-}
-
-main().catch(console.error).finally(_ => process.exit());
-Here you will find a list of examples that takes you through the basics of connecting to a local node, retrieving data from the Node and chain and execute transactions on the chain.
-From within each folder run the following to install required dependencies and to execute the example:
-yarn;
-yarn start
-The following example shows how to encrypt and decrypt a message with NaCl (pronouced "salt"), which is a Networking and Cryptography library used in util-crypto.
-const { naclEncrypt, naclDecrypt } = require('@polkadot/util-crypto');
-
-async function main () {
- const secret = new Uint8Array(32);
- const messagePreEncryption = new Uint8Array([1, 2, 3, 4, 5, 4, 3, 2, 1]);
- const noncePreEncryption = new Uint8Array(24);
-
- // Encrypt the message
- const { encrypted, nonce } = naclEncrypt(messagePreEncryption, secret, noncePreEncryption);
-
- // Show contents of the encrypted message
- console.log(`Encrypted message: ${JSON.stringify(encrypted, null, 2)}`);
-
- // Decrypt the message
- const messageDecrypted = naclDecrypt(encrypted, nonce, secret);
- // Convert each Uint8Array to a string for comparison
- const isMatch = messagePreEncryption.toString === messageDecrypted.toString;
-
- // Verify that the decrypted message matches the original message
- console.log(`Does the decrypted message match the original message? ${isMatch}`);
-}
-
-main().catch(console.error).finally(_ => process.exit());
-The following example shows how to sign and verify a message with NaCl (pronouced "salt"), which is a Networking and Cryptography library used in util-crypto.
-const { stringToU8a, u8aToHex } = require('@polkadot/util');
-const { naclEncrypt, naclKeypairFromSeed, naclSign, naclVerify, randomAsU8a } = require('@polkadot/util-crypto');
-
-async function main () {
- // Create account seed for Alice as fallback if generated mnemonic not valid
- const seedAlice = 'Alice'.padEnd(32, ' ');
-
- // Generate new public/secret keypair for Alice from the supplied seed
- const { secretKey, publicKey } = naclKeypairFromSeed(stringToU8a(seedAlice));
-
- // Encrypt message. Create Uint8Array's filled with random bytes of specified length
- const secret = randomAsU8a(32);
- const messagePreEncryption = stringToU8a('please send me DOTs');
- const noncePreEncryption = randomAsU8a(24);
-
- const { encrypted, nonce } = naclEncrypt(messagePreEncryption, secret, noncePreEncryption);
-
- // Sign the message with a valid signature
- const messageSignature = naclSign(encrypted, secretKey);
-
- console.log(`Message signature: ${u8aToHex(messageSignature)}`);
-
- // Validate that the message was correctly signed
- const isValidSignature = naclVerify(encrypted, messageSignature, publicKey);
-
- console.log(`Was the message correctly signed? ${isValidSignature}`);
-}
-
-main().catch(console.error).finally(_ => process.exit());
-The following example shows how to create and generate mnemonics using BIP39.
-const { mnemonicGenerate, mnemonicToSeed, mnemonicValidate, naclKeypairFromSeed } = require('@polkadot/util-crypto');
-
-async function main () {
- // Create mnemonic string for Alice using BIP39
- const mnemonicAlice = mnemonicGenerate();
-
- console.log(`Generated mnemonic: ${mnemonicAlice}`);
-
- // Validate the mnemic string that was generated
- const isValidMnemonic = mnemonicValidate(mnemonicAlice);
-
- console.log(`isValidMnemonic: ${isValidMnemonic}`);
-
- // Create valid seed from mnemonic as u8a and convert it to a string
- // FIXME - Replace with mnemonicToSeed once exposed
- const seedAlice = mnemonicToSeed(mnemonicAlice);
-
- // Generate new public/secret keypair for Alice from the supplied seed
- const { secretKey, publicKey } = naclKeypairFromSeed(seedAlice);
-
- // Encrypt, Sign and Validate the message. See Example 'Sign & Verify Message'
-}
-
-main().catch(console.error).finally(_ => process.exit());
-Here you will find a list of examples that takes you through the basics of encrypting and decrypting messages using NaCl, signing a message with a seed and verifying it using NaCl, and generating and validating mnemonics for account seeds.
-From within each folder run the following to install required dependencies and to execute the example:
-yarn;
-yarn start
-Various useful utility functions that are used across all projects in the @polkadot namespace. It provides utility functions with additional safety checks, allowing not only for consistent coding, but also reducing the general boilerplate.
-It is split up into a number of internal packages, namely utilities -
-Various useful trie and database interfaces -
-This guide describes Polkadot Javascript Common.
-You can read more about the Polkadot Network at https://polkadot.network/
-You can find the Polkadot repositories at:
-This documentation is generated from https://github.com/polkadot-js/api
-Contribution to Polkadot JS Common are more than welcome. You can report issues and log feature requests.
- - -Key management of user accounts including generation and retrieval of keyring pairs from a variety of input combinations.
-Installation -
-yarn add @polkadot/keyring
-Classes and Functions can be imported as follows:
-import Keyring from '@polkadot/keyring';
-import pair from '@polkadot/keyring/pair';
-import testKeyring from '@polkadot/keyring/testing';
-Below is a list of currently exposed methods published at the Polkadot-JS Common Documentation Portal.
-A re-implementation of a Patricia Trie. Unlike other implementations, this allows for the specification of a hash function as well as encoder/decoder and operates in a sync fashion by default.
-This is a JavaScript port of the Python Ethereum Trie with additions to support transactions (checkpoints) and multiple codecs, by default only the Substrate codec.
-Installation -
-yarn add @polkadot/trie-db
-Classes can be imported as follows:
-import Trie from '@polkadot/trie-db'; // Default export
-Below is a list of currently exposed methods published at the Polkadot-JS Common Documentation Portal.
- - - -Calculate ordered and unordered Trie hashes from inputs.
-Installation -
-yarn add @polkadot/trie-hash
-Functions can be imported as follows:
-import { trieRoot } from '@polkadot/trie-hash';
-Below is a list of currently exposed methods published at the Polkadot-JS Common Documentation Portal.
-Various useful cyrpto utility functions that are used across all projects in the @polkadot namespace. It provides utility functions with additional safety checks, allowing not only for consistent coding, but also reducing the general boilerplate.
-Installation -
-yarn add @polkadot/util-crypto
-Functions can be imported as follows:
-import { mnemonicGenerate } from '@polkadot/util-crypto';
-Below is a list of currently exposed methods published at the Polkadot-JS Common Documentation Portal.
-Various useful utility functions that are used across all projects in the @polkadot namespace. It provides utility functions with additional safety checks, allowing not only for consistent coding, but also reducing the general boilerplate.
-Installation -
-yarn add @polkadot/util
-Functions can be imported directly from the package, e.g.
-import { isHex } from '@polkadot/util';
-Below is a list of currently exposed methods published at the Polkadot-JS Common Documentation Portal.
-Utility methods for this package are split into groups, some of which are included in the list below:
- -Below is information about some of the available methods:
-ExtError is thrown.log, .error, .warn and .debug (controlled with environment DEBUG=typeA,typeB) methods.error is set, the Promise is rejected, else the Promise resolves with the result value.