openchain-nodejs-ts-yxl 1.0.1

package/example/atp10TokenDemo.js

@@ -0,0 +1,319 @@
+'use strict';
+
+require('chai').should();
+const encryption = require('yxchain-encryption-nodejs');
+const OpenChainSDK = require('openchain-sdk-nodejs');
+// const OpenChainSDK = require('../index');
+
+const sdk = new OpenChainSDK({
+  host: 'localhost/node/api',
+});
+
+describe('The demo of atp10Token', function() {
+
+  // Issue Unlimited Atp10Token
+  it('IssueUnlimitedAtp10Token', async() => {
+    const issuerPrivateKey = 'issuer private key';
+    // The token name
+    const name = 'MYTESTTOKEN';
+    // The token code
+    const code = 'MYTESTTOKEN';
+    // The apt token icon
+    const icon = '';
+    // The apt token version
+    const version = '1.0';
+    // The token total supply number
+    const totalSupply = 0;
+    // The token decimals
+    const decimals = 8;
+    // The token now supply number, which includes the dicimals.
+    // If decimals is 8 and you want to issue 10 tokens now, the nowSupply must be 10 * 10 ^ 8, like below.
+    const nowSupply = sdk.utils.unitWithDecimals('10', decimals);
+    // Description
+    const description = 'test unlimited issuance of apt1.0 token';
+    // The operation notes
+    const metadata = 'test the unlimited issuance of apt1.0 token';
+    // the unit is MO
+    const gasPrice = '1000';
+    // feeLimit, the unit is MO
+    const feeLimit = '5003000000';
+    // Transaction initiation account's Nonce + 1
+    const nonce = '87';
+
+    // Get the account address
+    const issuerAddress = getAddressByPrivateKey(issuerPrivateKey);
+
+
+    // Build operation
+    const assetIssueOperation = sdk.operation.assetIssueOperation({
+      sourceAddress: issuerAddress,
+      code,
+      assetAmount: nowSupply,
+      metadata,
+    });
+
+    if (assetIssueOperation.errorCode !== 0) {
+      console.log(assetIssueOperation);
+      return assetIssueOperation;
+    }
+
+    const apt10Obj = {
+      name,
+      code,
+      description,
+      decimals,
+      totalSupply,
+      icon,
+    };
+    const key = `asset_property_${code}`;
+    const value = JSON.stringify(apt10Obj);
+    const accountSetMetadataOperation = sdk.operation.accountSetMetadataOperation({
+      key,
+      value,
+      version,
+    });
+
+    if (accountSetMetadataOperation.errorCode !== 0) {
+      console.log(accountSetMetadataOperation);
+      return accountSetMetadataOperation;
+    }
+
+    let args = {
+      privateKey: issuerPrivateKey,
+      sourceAddress: issuerAddress,
+      gasPrice,
+      feeLimit,
+      nonce,
+      operation: [ assetIssueOperation, accountSetMetadataOperation ],
+      metadata,
+    };
+    const result = await submitTransaction(args);
+    console.log(result);
+  });
+
+  // Issue limited Atp10Token
+  it('IssuelimitedAtp10Token', async() => {
+    const issuerPrivateKey = 'issuer private key';
+    // The token name
+    const name = 'MYTESTTOKEN';
+    // The token code
+    const code = 'MYTESTTOKEN';
+    // The apt token icon
+    const icon = '';
+    // The apt token version
+    const version = '1.0';
+    // The token decimals
+    const decimals = 1;
+    // The token total supply number
+    const totalSupply = 1000000000;
+    // The token now supply number
+    // If decimals is 1 and you want to issue 10 tokens now, the nowSupply must be 10 * 10 ^ 1, like below.
+    const nowSupply = sdk.utils.unitWithDecimals('10', decimals);
+    // Description
+    const description = 'test limited issuance of apt1.0 token';
+    // The operation notes
+    const metadata = 'test limited issuance of apt1.0 token';
+    // the unit is MO
+    const gasPrice = '1000';
+    // feeLimit, the unit is MO
+    const feeLimit = '5003000000';
+    // Transaction initiation account's Nonce + 1
+    const nonce = '88';
+
+    // Get the account address
+    const issuerAddress = getAddressByPrivateKey(issuerPrivateKey);
+
+
+    // Build operation
+    const assetIssueOperation = sdk.operation.assetIssueOperation({
+      sourceAddress: issuerAddress,
+      code,
+      assetAmount: nowSupply,
+      metadata,
+    });
+
+    if (assetIssueOperation.errorCode !== 0) {
+      console.log(assetIssueOperation);
+      return assetIssueOperation;
+    }
+
+    const apt10Obj = {
+      name,
+      code,
+      description,
+      decimals,
+      totalSupply,
+      icon,
+    };
+    const key = `asset_property_${code}`;
+    const value = JSON.stringify(apt10Obj);
+    const accountSetMetadataOperation = sdk.operation.accountSetMetadataOperation({
+      key,
+      value,
+      version,
+    });
+
+    if (accountSetMetadataOperation.errorCode !== 0) {
+      console.log(accountSetMetadataOperation);
+      return accountSetMetadataOperation;
+    }
+
+    let args = {
+      privateKey: issuerPrivateKey,
+      sourceAddress: issuerAddress,
+      gasPrice,
+      feeLimit,
+      nonce,
+      operation: [ assetIssueOperation, accountSetMetadataOperation ],
+      metadata,
+    };
+    const result = await submitTransaction(args);
+    console.log(result);
+  });
+
+
+  it('SendAtp10Token', async() => {
+    // The account private key to send atp1.0 token
+    const senderPrivateKey = 'Sender Private Key';
+    // The account to receive atp 1.0 token
+    const destAddress = 'adxSk4rkz84a4fh5xYxfSqmAsnhcWZzrTfG2t';
+    // The token code
+    const code = 'MYTESTTOKEN';
+    // The token amount to be sent
+    const amount = '1000000000';
+    // The operation notes
+    const metadata = 'test one off issue apt1.0 token';
+    // the unit is MO
+    const gasPrice = '1000';
+    // maximum cost, the unit is MO
+    const feeLimit = '1000000';
+    // Transaction initiation account's Nonce + 1
+    const nonce = '100';
+
+    // Get the account address
+    const senderAddress = getAddressByPrivateKey(senderPrivateKey);
+    // Check whether the destination account is activated
+    let status = await checkAccountStatus(destAddress);
+
+    if  (!status) {
+      let accountInfo = await accountActivate({
+        privateKey: senderPrivateKey,
+        sourceAddress: senderAddress,
+        destAddress: destAddress,
+        nonce: '22',
+      });
+    }
+
+    const operation = sdk.operation.assetSendOperation({
+      sourceAddress: senderAddress,
+      destAddress: destAddress,
+      code: code,
+      issuer: senderAddress,
+      assetAmount: amount,
+      metadata: metadata,
+    });
+
+    if (operation.errorCode === 0) {
+      let args = {
+        privateKey: senderPrivateKey,
+        sourceAddress: senderAddress,
+        gasPrice,
+        feeLimit,
+        nonce,
+        operation,
+      };
+      const result = await submitTransaction(args);
+      console.log(result);
+    }
+
+  });
+
+  // Check account status
+  async function checkAccountStatus(address) {
+    const data = await sdk.account.isActivated(address);
+    return data.result.isActivated;
+  }
+
+  // Activate account
+  async function accountActivate(args) {
+    let operation = sdk.operation.accountActivateOperation({
+      destAddress: args.destAddress,
+      initBalance: '1000000',
+    });
+
+    const result = await submitTransaction({
+      privateKey: args.privateKey,
+      sourceAddress: args.sourceAddress,
+      gasPrice: '1000',
+      feeLimit: '1000000',
+      nonce: args.nonce,
+      operation,
+    });
+
+    return result.errorCode === 0;
+  }
+
+  // Get address from private key
+  function getAddressByPrivateKey(privatekey) {
+    const KeyPair = encryption.keypair;
+    let publicKey = KeyPair.getEncPublicKey(privatekey);
+    return KeyPair.getAddress(publicKey);
+  }
+
+  // Submit
+  async function submitTransaction(args) {
+    let operations = [];
+
+    if (Array.isArray(args.operation)) {
+      args.operation.forEach(function(item) {
+        operations.push(item.result.operation);
+      })
+    } else {
+      operations.push(args.operation.result.operation);
+    }
+
+    // // 1. Build Operation
+    // const operationItem = args.operation.result.operation;
+
+    let opt = {
+      sourceAddress: args.sourceAddress,
+      gasPrice: args.gasPrice,
+      feeLimit: args.feeLimit,
+      nonce: args.nonce,
+      operations,
+    };
+
+    if (args.metadata) {
+      opt.metadata = JSON.stringify(args.metadata);
+    }
+
+    // 2. Build blob
+    let blobInfo = sdk.transaction.buildBlob(opt);
+
+    if (blobInfo.errorCode !== 0) {
+      console.log(blobInfo);
+      return;
+    }
+
+    let blob = blobInfo.result.transactionBlob;
+
+    // 3. Sign blob
+    let signatureInfo = sdk.transaction.sign({
+      privateKeys: [ args.privateKey ],
+      blob,
+    });
+
+    if (signatureInfo.errorCode !== 0) {
+      console.log(signatureInfo);
+      return;
+    }
+
+    let signature = signatureInfo.result.signatures;
+    // 4. Submit transaction
+    return await sdk.transaction.submit({
+      blob,
+      signature: signature,
+    });
+  }
+
+});

package/example/exchange.js

@@ -0,0 +1,184 @@
+'use strict';
+
+require('chai').should();
+const BigNumber = require('bignumber.js');
+const OpenChainSDK = require('openchain-sdk');
+
+const sdk = new OpenChainSDK({
+  host: 'localhost/node/api',
+});
+
+describe('The demo of openchain-sdk for exchange ', function() {
+
+  it('Create account', async() => {
+    const keypair = await sdk.account.create();
+    console.log(keypair);
+  });
+
+  it('Get account information', async() => {
+    const address = 'adxSqKcX8wGCMKhzNUBoDWfbeQaMhfnGdtyG2';
+    const info = await sdk.account.getInfo(address);
+    console.log(info);
+  });
+
+  it('Check address validity', async() => {
+    const address = 'adxSk4rkz84a4fh5xYxfSqmAsnhcWZzrTfG2t';
+    const data = await sdk.account.checkValid(address);
+    console.log(data);
+  });
+
+  it('Get account balance', async() => {
+    const address = 'adxSk4rkz84a4fh5xYxfSqmAsnhcWZzrTfG2t';
+    const data = await sdk.account.getBalance(address);
+    console.log(data);
+  });
+
+  it('Get account nonce', async() => {
+    const address = 'adxSk4rkz84a4fh5xYxfSqmAsnhcWZzrTfG2t';
+    const data = await sdk.account.getNonce(address);
+    console.log(data);
+  });
+
+  it('Get the latest block number', async() => {
+    const data = await sdk.block.getNumber();
+    console.log(data);
+  });
+
+  it('Check local node block synchronization status', async() => {
+    const data = await sdk.block.checkStatus();
+    console.log(data);
+  });
+
+  it('Get transactions for a blockNumber', async() => {
+    const blockNumber = '100';
+    const data = await sdk.block.getTransactions(blockNumber);
+    console.log(data);
+  });
+
+  it('Get block information', async() => {
+    const data = await sdk.block.getInfo('100');
+    console.log(data);
+  });
+
+  it('Get the latest block information', async() => {
+    const data = await sdk.block.getLatestInfo();
+    console.log(data);
+  });
+
+  it('Get the validators in the specified blockNumber', async() => {
+    const data = await sdk.block.getValidators('100');
+    console.log(data);
+  });
+
+  it('Get the latest validators', async() => {
+    const data = await sdk.block.getLatestValidators();
+    console.log(data);
+  });
+
+  it('Get block rewards and validator rewards in the specified blockNumber', async() => {
+    const data = await sdk.block.getReward('100');
+    console.log(data);
+  });
+
+  it('Get block rewards and validator rewards in the latest blockNumber', async() => {
+    const data = await sdk.block.getLatestReward();
+    console.log(data);
+  });
+
+  it('Get fees in the specified blockNumber', async() => {
+    const data = await sdk.block.getFees('100');
+    console.log(data);
+  });
+
+  it('Get fees in the latest blockNumber', async() => {
+    const data = await sdk.block.getLatestFees();
+    console.log(data);
+  });
+
+  // ====================================
+  // Send BU contains 4 steps:
+  // 1. build operation (buSendOperation)
+  // 2. build blob
+  // 3. sign blob with sender private key
+  // 4. submit transaction
+  // ====================================
+  it('Send BU', async() => {
+    const senderPrivateKey = 'sender private key';
+    const senderAddress = 'adxSk4rkz84a4fh5xYxfSqmAsnhcWZzrTfG2t';
+    const receiverAddress = 'adxSk4rkz84a4fh5xYxfSqmAsnhcWZzrTfG2t';
+
+    const accountInfo = await sdk.account.getNonce(senderAddress);
+
+    if (accountInfo.errorCode !== 0) {
+      console.log(accountInfo);
+      return;
+    }
+    let nonce = accountInfo.result.nonce;
+    // nonce + 1
+    nonce = new BigNumber(nonce).plus(1).toString(10);
+
+    // ====================================
+    // 1. build operation (buSendOperation)
+    // ====================================
+    const operationInfo = sdk.operation.buSendOperation({
+      sourceAddress: senderAddress,
+      destAddress: receiverAddress,
+      buAmount: '7000',
+      metadata: 'send bu demo',
+    });
+
+    if (operationInfo.errorCode !== 0) {
+      console.log(operationInfo);
+      return;
+    }
+
+    const operationItem = operationInfo.result.operation;
+
+    // ====================================
+    // 2. build blob
+    // ====================================
+    const blobInfo = sdk.transaction.buildBlob({
+      sourceAddress: senderAddress,
+      gasPrice: '1000',
+      feeLimit: '306000',
+      nonce,
+      operations: [ operationItem ],
+    });
+
+    if (blobInfo.errorCode !== 0) {
+      console.log(blobInfo);
+      return;
+    }
+
+    const blob = blobInfo.result.transactionBlob;
+
+    // ====================================
+    // 3. sign blob with sender private key
+    // ====================================
+    let signatureInfo = sdk.transaction.sign({
+      privateKeys: [ senderPrivateKey ],
+      blob,
+    });
+
+    if (signatureInfo.errorCode !== 0) {
+      console.log(signatureInfo);
+      return;
+    }
+
+    const signature = signatureInfo.result.signatures;
+
+    // ====================================
+    // 4. submit transaction
+    // ====================================
+    const transactionInfo = await sdk.transaction.submit({
+      blob,
+      signature: signature,
+    });
+
+    if (transactionInfo.errorCode !== 0) {
+      console.log(transactionInfo);
+    }
+    console.log(transactionInfo);
+  });
+
+});

package/example/offlineSignatureDemo.js

@@ -0,0 +1,83 @@
+'use strict';
+
+require('chai').should();
+const OpenChainSDK = require('openchain-sdk');
+
+const sdk = new OpenChainSDK({
+  host: 'localhost/node/api',
+});
+
+describe('The demo of offline signature', function() {
+
+  // ====================================
+  // Take `buSendOperation` as an example
+  // Offline signature contains 2 steps:
+  // step1. Get blob
+  // step2. Sign blob with sender private key
+  // ====================================
+  it('The demo of offline signature', async() => {
+    const senderPrivateKey = 'sender private key';
+    const senderAddress = 'adxSk4rkz84a4fh5xYxfSqmAsnhcWZzrTfG2t';
+    const receiverAddress = 'adxSk4rkz84a4fh5xYxfSqmAsnhcWZzrTfG2t';
+    // The unit is MO
+    const gasPrice = '1000';
+    // The unit is MO
+    const feeLimit = '306000';
+    // The unit is MO
+    const buAmount = '7000';
+    // Transaction initiation account's Nonce + 1
+    const nonce = '10';
+    const metadata = 'send bu demo';
+
+    // build operation (buSendOperation)
+    const operationInfo = sdk.operation.buSendOperation({
+      sourceAddress: senderAddress,
+      destAddress: receiverAddress,
+      buAmount,
+      metadata,
+    });
+
+    if (operationInfo.errorCode !== 0) {
+      console.log(operationInfo);
+      return;
+    }
+
+    const operationItem = operationInfo.result.operation;
+
+    // ====================================
+    // step1. Get blob
+    // ====================================
+    const blobInfo = sdk.transaction.buildBlob({
+      sourceAddress: senderAddress,
+      gasPrice,
+      feeLimit,
+      nonce,
+      operations: [ operationItem ],
+    });
+
+    if (blobInfo.errorCode !== 0) {
+      console.log(blobInfo);
+      return;
+    }
+
+    const blob = blobInfo.result.transactionBlob;
+
+    // ====================================
+    // step2. Sign blob with sender private key
+    // ====================================
+    let signatureInfo = sdk.transaction.sign({
+      privateKeys: [ senderPrivateKey ],
+      blob,
+    });
+
+    if (signatureInfo.errorCode !== 0) {
+      console.log(signatureInfo);
+      return;
+    }
+
+    const signature = signatureInfo.result.signatures;
+
+    console.log(signature);
+  });
+
+});

package/example/submitTransactionDemo.js

@@ -0,0 +1,92 @@
+'use strict';
+
+require('chai').should();
+const BigNumber = require('bignumber.js');
+const OpenChainSDK = require('openchain-sdk');
+
+const sdk = new OpenChainSDK({
+  host: 'localhost/node/api',
+});
+
+describe('The demo of submit transaction ', function() {
+
+  it('The demo of submit transaction', async() => {
+    const senderPrivateKey = 'sender private key';
+    const senderAddress = 'adxSk4rkz84a4fh5xYxfSqmAsnhcWZzrTfG2t';
+    const receiverAddress = 'adxSk4rkz84a4fh5xYxfSqmAsnhcWZzrTfG2t';
+
+    const accountInfo = await sdk.account.getNonce(senderAddress);
+
+    if (accountInfo.errorCode !== 0) {
+      console.log(accountInfo);
+      return;
+    }
+    let nonce = accountInfo.result.nonce;
+    // nonce + 1
+    nonce = new BigNumber(nonce).plus(1).toString(10);
+
+    // ====================================
+    // 1. build operation (buSendOperation)
+    // ====================================
+    const operationInfo = sdk.operation.buSendOperation({
+      sourceAddress: senderAddress,
+      destAddress: receiverAddress,
+      buAmount: '7000',
+      metadata: 'send bu demo',
+    });
+
+    if (operationInfo.errorCode !== 0) {
+      console.log(operationInfo);
+      return;
+    }
+
+    const operationItem = operationInfo.result.operation;
+
+    // ====================================
+    // 2. build blob
+    // ====================================
+    const blobInfo = sdk.transaction.buildBlob({
+      sourceAddress: senderAddress,
+      gasPrice: '1000',
+      feeLimit: '306000',
+      nonce,
+      operations: [ operationItem ],
+    });
+
+    if (blobInfo.errorCode !== 0) {
+      console.log(blobInfo);
+      return;
+    }
+
+    const blob = blobInfo.result.transactionBlob;
+
+    // ====================================
+    // 3. sign blob with sender private key
+    // ====================================
+    let signatureInfo = sdk.transaction.sign({
+      privateKeys: [ senderPrivateKey ],
+      blob,
+    });
+
+    if (signatureInfo.errorCode !== 0) {
+      console.log(signatureInfo);
+      return;
+    }
+
+    const signature = signatureInfo.result.signatures;
+
+    // ====================================
+    // 4. submit transaction
+    // ====================================
+    const transactionInfo = await sdk.transaction.submit({
+      blob,
+      signature: signature,
+    });
+
+    if (transactionInfo.errorCode !== 0) {
+      console.log(transactionInfo);
+    }
+    console.log(transactionInfo);
+  });
+
+});