epistemophiliac/fabric-samples
1
0
Fork 0
mirror of https://github.com/hyperledger/fabric-samples.git synced 2026-06-22 17:45:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Restructure the basic javascript application to use common code. (#281)

Browse source 
Use common code for reading a connection profile, enrolling the admin,
registering and enrolling a user, building a wallet, and
building a certificate authority client.

Signed-off-by: Bret Harrison <beharrison@nc.rr.com>
This commit is contained in:
harrisob 2020-08-06 16:07:54 -04:00 committed by GitHub
parent e90554f4f8
commit c0ffb1cffb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 259 additions and 271 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
asset-transfer-basic/application-javascript/.eslintrc.js
View file

@ -13,7 +13,7 @@ module.exports = {
}, },
extends: "eslint:recommended", extends: "eslint:recommended",
rules: { rules: {
indent: ['error', 4], indent: ['error', 'tab'],
'linebreak-style': ['error', 'unix'], 'linebreak-style': ['error', 'unix'],
quotes: ['error', 'single'], quotes: ['error', 'single'],
semi: ['error', 'always'], semi: ['error', 'always'],
@ -25,7 +25,6 @@ module.exports = {
strict: 'error', strict: 'error',
'no-var': 'error', 'no-var': 'error',
'dot-notation': 'error', 'dot-notation': 'error',
'no-tabs': 'error',
'no-trailing-spaces': 'error', 'no-trailing-spaces': 'error',
'no-use-before-define': 'error', 'no-use-before-define': 'error',
'no-useless-call': 'error', 'no-useless-call': 'error',

166
asset-transfer-basic/application-javascript/app.js
View file

@ -7,127 +7,149 @@
'use strict'; 'use strict';
const {Gateway, Wallets} = require('fabric-network'); const {Gateway, Wallets} = require('fabric-network');
const FabricCAServices = require('fabric-ca-client');
const path = require('path'); const path = require('path');
const fs = require('fs'); const {buildCAClient, registerUser, enrollAdmin} = require('../../test-application/javascript/CAUtil.js');
const registerUser = require('./registerUser'); const {buildCCP, buildWallet} = require('../../test-application/javascript/AppUtil.js');
const enrollAdmin = require('./enrollAdmin');
const myChannel = 'mychannel'; const channelName = 'mychannel';
const myChaincodeName = 'basic'; const chaincodeName = 'basic';
const walletPath = path.join(__dirname, 'wallet');
const userId = 'appUser';
function prettyJSONString(inputString) { function prettyJSONString(inputString) {
return JSON.stringify(JSON.parse(inputString), null, 2); return JSON.stringify(JSON.parse(inputString), null, 2);
} }
// pre-requisites: // pre-requisites:
// fabric-sample test-network setup with two peers and an ordering service, // - fabric-sample two organization test-network setup with two peers, ordering service, and 2 certificate authorities
// the companion chaincode is deployed, approved and committed on the channel mychannel // ===> from directory /fabric-samples/test-network
// network.sh run createChannel -ca
// - any of the asset-transfer-basic chaincodes deployed on the channel "mychannel" with the chaincodeName of "basic"
// This deploy command will package, install, approve, and commit the javascript chaincode, all the actions it takes
// to deploy a chaincode to a channel.
// ===> from directory /fabric-samples/test-network
// network.sh deployCC -ccn basic -ccl javascript
// - node install
// - npm installed code dependencies
// ===> from directory /fabric-samples/asset-transfer-basic/application-javascript
// npm install
// - to run this test application
// ===> from directory /fabric-samples/asset-transfer-basic/application-javascript
// node app.js
// # this may be run again again
/**
* A test application to show basic operations with any of the asset-transfer-basic chaincodes
* -- How to submit a transaction
* -- How to query and check the results
*
* To see the SDK workings, try setting the logging to show on the console before running
* export HFC_LOGGING='{"debug":"console"}'
*/
async function main() { async function main() {
try { try {
// load the network configuration // build an in memory object with the network configuration (also known as a connection profile)
const ccpPath = path.resolve(__dirname, '..', '..', 'test-network', 'organizations', 'peerOrganizations', 'org1.example.com', 'connection-org1.json'); const ccp = buildCCP();
const fileExists = fs.existsSync(ccpPath);
if (!fileExists) {
throw new Error(`no such file or directory: ${ccpPath}`);
}
const ccp = JSON.parse(fs.readFileSync(ccpPath, 'utf8'));
// Create a new file system based wallet for managing identities. // build an instance of the fabric ca services client based on
const walletPath = path.join(__dirname, 'wallet'); // the information in the network configuration
const wallet = await Wallets.newFileSystemWallet(walletPath); const caClient = buildCAClient(FabricCAServices, ccp);
console.log(`Wallet path: ${walletPath}`);
// setup the wallet to hold the credentials of the application user
const wallet = await buildWallet(Wallets, walletPath);
// Steps: // in a real application this would be done on an administrative flow, and only once
// Note: Steps 1 & 2 need to done only once in an app-server per blockchain network await enrollAdmin(caClient, wallet);
// 1. register & enroll admin user with CA, stores admin identity in local wallet
await enrollAdmin.EnrollAdminUser();
// 2. register & enroll application user with CA, which is used as client identify to make chaincode calls, stores app user identity in local wallet // in a real application this would be done only when a new user was required to be added
await registerUser.RegisterAppUser(); // and would be part of an administrative flow
await registerUser(caClient, wallet, userId, 'org1.department1');
// Check to see if app user exist in wallet. // Create a new gateway instance for interacting with the fabric network.
const identity = await wallet.get(registerUser.ApplicationUserId); // In a real application this would be done as the backend server session is setup for
if (!identity) { // a user that has been verified.
console.log(`An identity for the user does not exist in the wallet: ${registerUser.ApplicationUserId}`);
return;
}
//3. Prepare to call chaincode using fabric javascript node sdk
// Create a new gateway for connecting to our peer node.
const gateway = new Gateway(); const gateway = new Gateway();
try {
// setup the gateway instance
// The user will now be able to create connections to the fabric network and be able to
// submit transactions and query. All transactions submitted by this gateway will be
// signed by this user using the credentials stored in the wallet.
await gateway.connect(ccp, { await gateway.connect(ccp, {
wallet, wallet,
identity: registerUser.ApplicationUserId, identity: userId,
discovery: {enabled: true, asLocalhost: true} discovery: {enabled: true, asLocalhost: true} // using asLocalhost as this gateway is using a fabric network deployed locally
}); });
try {
// Get the network (channel) our contract is deployed to. // Build a network instance based on the channel where the smart contract is deployed
const network = await gateway.getNetwork(myChannel); const network = await gateway.getNetwork(channelName);
// Get the contract from the network. // Get the contract from the network.
const contract = network.getContract(myChaincodeName); const contract = network.getContract(chaincodeName);
//4. Init a set of asset data on the channel using chaincode 'InitLedger' // Initialize a set of asset data on the channel using the chaincode 'InitLedger' function.
console.log('Submit Transaction: InitLedger creates the initial set of assets on the ledger.'); // This type of transaction would only be run once by an application the first time it was started after it
// deployed the first time. Any updates to the chaincode deployed later would likely not need to run
// an "init" type function.
console.log('\n--> Submit Transaction: InitLedger, function creates the initial set of assets on the ledger');
await contract.submitTransaction('InitLedger'); await contract.submitTransaction('InitLedger');
console.log('*** Result: committed');
//5. *** Some example transactions are listed below *** // Let's try a query type operation (function).
// This will be sent to just one peer and the results will be shown.
// GetAllAssets returns all the current assets on the ledger console.log('\n--> Evaluate Transaction: GetAllAssets, function returns all the current assets on the ledger');
let result = await contract.evaluateTransaction('GetAllAssets'); let result = await contract.evaluateTransaction('GetAllAssets');
console.log(`Evaluate Transaction: GetAllAssets, result: ${prettyJSONString(result.toString())}`); console.log(`*** Result: ${prettyJSONString(result.toString())}`);
console.log('\n***********************'); // Now let's try to submit a transaction.
console.log('Submit Transaction: CreateAsset asset13'); // This will be sent to both peers and if both peers endorse the transaction, the endorsed proposal will be sent
//CreateAsset creates an asset with ID asset13, color yellow, owner Tom, size 5 and appraisedValue of 1300 // to the orderer to be committed by each of the peer's to the channel ledger.
console.log('\n--> Submit Transaction: CreateAsset, creates new asset with ID, color, owner, size, and appraisedValue arguments');
await contract.submitTransaction('CreateAsset', 'asset13', 'yellow', '5', 'Tom', '1300'); await contract.submitTransaction('CreateAsset', 'asset13', 'yellow', '5', 'Tom', '1300');
console.log('*** Result: committed');
console.log('Evaluate Transaction: ReadAsset asset13'); console.log('\n--> Evaluate Transaction: ReadAsset, function returns an asset with a given assetID');
// ReadAsset returns an asset with given assetID
result = await contract.evaluateTransaction('ReadAsset', 'asset13'); result = await contract.evaluateTransaction('ReadAsset', 'asset13');
console.log(` result: ${prettyJSONString(result.toString())}`); console.log(`*** Result: ${prettyJSONString(result.toString())}`);
console.log('\n***********************'); console.log('\n--> Evaluate Transaction: AssetExists, function returns "true" if an asset with given assetID exist');
console.log('Evaluate Transaction: AssetExists asset1');
// AssetExists returns 'true' if an asset with given assetID exist
result = await contract.evaluateTransaction('AssetExists', 'asset1'); result = await contract.evaluateTransaction('AssetExists', 'asset1');
console.log(` result: ${prettyJSONString(result.toString())}`); console.log(`*** Result: ${prettyJSONString(result.toString())}`);
console.log('Submit Transaction: UpdateAsset asset1, new AppraisedValue : 350'); console.log('\n--> Submit Transaction: UpdateAsset asset1, change the appraisedValue to 350');
// UpdateAsset updates an existing asset with new properties. Same args as CreateAsset
await contract.submitTransaction('UpdateAsset', 'asset1', 'blue', '5', 'Tomoko', '350'); await contract.submitTransaction('UpdateAsset', 'asset1', 'blue', '5', 'Tomoko', '350');
console.log('*** Result: committed');
console.log('Evaluate Transaction: ReadAsset asset1'); console.log('\n--> Evaluate Transaction: ReadAsset, function returns "asset1" attributes');
result = await contract.evaluateTransaction('ReadAsset', 'asset1'); result = await contract.evaluateTransaction('ReadAsset', 'asset1');
console.log(` result: ${prettyJSONString(result.toString())}`); console.log(`*** Result: ${prettyJSONString(result.toString())}`);
try { try {
console.log('\nSubmit Transaction: UpdateAsset asset70'); // How about we try a transactions where the executing chaincode throws an error
//Non existing asset asset70 should throw Error // Notice how the submitTransaction will throw an error containing the error thrown by the chaincode
console.log('\n--> Submit Transaction: UpdateAsset asset70, asset70 does not exist and should return an error');
await contract.submitTransaction('UpdateAsset', 'asset70', 'blue', '5', 'Tomoko', '300'); await contract.submitTransaction('UpdateAsset', 'asset70', 'blue', '5', 'Tomoko', '300');
console.log('******** FAILED to return an error');
} catch (error) { } catch (error) {
console.log(`Expected an error on UpdateAsset of non-existing Asset: ${error}`); console.log(`*** Successfully caught the error: \n ${error}`);
} }
console.log('\n***********************');
console.log('Submit Transaction: TransferAsset asset1 from owner Tomoko > owner Tom'); console.log('\n--> Submit Transaction: TransferAsset asset1, transfer to new owner of Tom');
// TransferAsset transfers an asset with given ID to new owner Tom
await contract.submitTransaction('TransferAsset', 'asset1', 'Tom'); await contract.submitTransaction('TransferAsset', 'asset1', 'Tom');
console.log('*** Result: committed');
console.log('Evaluate Transaction: ReadAsset asset1'); console.log('\n--> Evaluate Transaction: ReadAsset, function returns "asset1" attributes');
result = await contract.evaluateTransaction('ReadAsset', 'asset1'); result = await contract.evaluateTransaction('ReadAsset', 'asset1');
console.log(` result: ${prettyJSONString(result.toString())}`); console.log(`*** Result: ${prettyJSONString(result.toString())}`);
} finally { } finally {
// Disconnect from the gateway peer when all work for this client identity is complete // Disconnect from the gateway when the application is closing
// This will close all connections to the network
gateway.disconnect(); gateway.disconnect();
} }
} catch (error) { } catch (error) {
console.error(`Failed to evaluate transaction: ${error}`); console.error(`******** FAILED to run the application: ${error}`);
process.exit(1);
} }
} }
main(); main();

62
asset-transfer-basic/application-javascript/enrollAdmin.js
View file

@ -1,62 +0,0 @@
/*
* Copyright IBM Corp. All Rights Reserved.
*
* SPDX-License-Identifier: Apache-2.0
*/
'use strict';
const FabricCAServices = require('fabric-ca-client');
const { Wallets } = require('fabric-network');
const fs = require('fs');
const path = require('path');
const adminUserId = 'admin';
const adminUserPasswd = 'adminpw';
const walletPath = path.join(__dirname, 'wallet');
async function enrollAdminUser() {
try {
// load the network configuration
const ccpPath = path.resolve(__dirname, '..', '..', 'test-network', 'organizations', 'peerOrganizations', 'org1.example.com', 'connection-org1.json');
const fileExists = fs.existsSync(ccpPath);
if (!fileExists) {
throw new Error(`no such file or directory: ${ccpPath}`);
}
const ccp = JSON.parse(fs.readFileSync(ccpPath, 'utf8'));
// Create a new CA client for interacting with the CA.
const caInfo = ccp.certificateAuthorities['ca.org1.example.com'];
const caTLSCACerts = caInfo.tlsCACerts.pem;
const ca = new FabricCAServices(caInfo.url, { trustedRoots: caTLSCACerts, verify: false }, caInfo.caName);
// Create a new wallet : Note that wallet can be resfor managing identities.
const wallet = await Wallets.newFileSystemWallet(walletPath);
// Check to see if we've already enrolled the admin user.
const identity = await wallet.get(adminUserId);
if (identity) {
console.log('An identity for the admin user already exists in the wallet');
return;
}
// Enroll the admin user, and import the new identity into the wallet.
const enrollment = await ca.enroll({ enrollmentID: adminUserId, enrollmentSecret: adminUserPasswd });
const x509Identity = {
credentials: {
certificate: enrollment.certificate,
privateKey: enrollment.key.toBytes(),
},
mspId: 'Org1MSP',
type: 'X.509',
};
await wallet.put(adminUserId, x509Identity);
console.log('Successfully enrolled admin user and imported it into the wallet');
} catch (error) {
console.error(`Failed to enroll admin user : ${error}`);
process.exit(1);
}
}
exports.AdminUserId = adminUserId;
exports.EnrollAdminUser = enrollAdminUser;

29
asset-transfer-basic/application-javascript/package.json
View file

@ -6,40 +6,11 @@
"node": ">=12", "node": ">=12",
"npm": ">=5" "npm": ">=5"
}, },
"scripts": {
"lint": "eslint .",
"pretest": "npm run lint",
"test": "nyc mocha --recursive"
},
"engineStrict": true, "engineStrict": true,
"author": "Hyperledger", "author": "Hyperledger",
"license": "Apache-2.0", "license": "Apache-2.0",
"dependencies": { "dependencies": {
"fabric-ca-client": "2.2.0", "fabric-ca-client": "2.2.0",
"fabric-network": "2.2.0" "fabric-network": "2.2.0"
},
"devDependencies": {
"chai": "^4.2.0",
"eslint": "^5.9.0",
"mocha": "^5.2.0",
"nyc": "^14.1.1",
"sinon": "^7.1.1",
"sinon-chai": "^3.3.0"
},
"nyc": {
"exclude": [
"coverage/**",
"test/**"
],
"reporter": [
"text-summary",
"html"
],
"all": true,
"check-coverage": true,
"statements": 100,
"branches": 100,
"functions": 100,
"lines": 100
} }
} }

83
asset-transfer-basic/application-javascript/registerUser.js
View file

@ -1,83 +0,0 @@
/*
* Copyright IBM Corp. All Rights Reserved.
*
* SPDX-License-Identifier: Apache-2.0
*/
'use strict';
const { Wallets } = require('fabric-network');
const FabricCAServices = require('fabric-ca-client');
const fs = require('fs');
const path = require('path');
const enrollAdmin = require('./enrollAdmin');
const caChaincodeUserRole = 'client';
const applicationUserId = 'appUser';
const walletPath = path.join(__dirname, 'wallet');
async function registerAppUser() {
try {
// load the network configuration
const ccpPath = path.resolve(__dirname, '..', '..', 'test-network', 'organizations', 'peerOrganizations', 'org1.example.com', 'connection-org1.json');
const fileExists = fs.existsSync(ccpPath);
if (!fileExists) {
throw new Error(`no such file or directory: ${ccpPath}`);
}
const ccp = JSON.parse(fs.readFileSync(ccpPath, 'utf8'));
// Create a new CA client for interacting with the CA.
const caURL = ccp.certificateAuthorities['ca.org1.example.com'].url;
const ca = new FabricCAServices(caURL);
// Create a new file system based wallet for managing identities. ;
const wallet = await Wallets.newFileSystemWallet(walletPath);
// Check to see if we've already enrolled the user.
const userIdentity = await wallet.get(applicationUserId);
if (userIdentity) {
console.log(`An identity for the user ${applicationUserId} already exists in the wallet`);
return;
}
// Check to see if we've already enrolled the admin user.
const adminIdentity = await wallet.get(enrollAdmin.AdminUserId);
if (!adminIdentity) {
console.log('An identity for the admin user does not exist in the wallet');
console.log('Run the enrollAdmin.js application before retrying');
return;
}
// build a user object for authenticating with the CA
const provider = wallet.getProviderRegistry().getProvider(adminIdentity.type);
const adminUser = await provider.getUserContext(adminIdentity, enrollAdmin.AdminUserId);
// Register the user, enroll the user, and import the new identity into the wallet.
// if affiliation is specified by client, the affiliation value must be configured in CA
const secret = await ca.register({
affiliation: 'org1.department1',
enrollmentID: applicationUserId,
role: caChaincodeUserRole
}, adminUser);
const enrollment = await ca.enroll({
enrollmentID: applicationUserId,
enrollmentSecret: secret
});
const x509Identity = {
credentials: {
certificate: enrollment.certificate,
privateKey: enrollment.key.toBytes(),
},
mspId: 'Org1MSP',
type: 'X.509',
};
await wallet.put(applicationUserId, x509Identity);
console.log(`Successfully registered and enrolled user ${applicationUserId} and imported it into the wallet`);
} catch (error) {
console.error(`Failed to register user : ${error}`);
process.exit(1);
}
}
exports.ApplicationUserId = applicationUserId;
exports.RegisterAppUser = registerAppUser;

40
test-application/javascript/AppUtil.js Normal file
View file

@ -0,0 +1,40 @@
/*
* Copyright IBM Corp. All Rights Reserved.
*
* SPDX-License-Identifier: Apache-2.0
*/
'use strict';
const fs = require('fs');
const path = require('path');
exports.buildCCP = () => {
// load the common connection configuration file
const ccpPath = path.resolve(__dirname, '..', '..', 'test-network', 'organizations', 'peerOrganizations', 'org1.example.com', 'connection-org1.json');
const fileExists = fs.existsSync(ccpPath);
if (!fileExists) {
throw new Error(`no such file or directory: ${ccpPath}`);
}
const contents = fs.readFileSync(ccpPath, 'utf8');
// build a JSON object from the file contents
const ccp = JSON.parse(contents);
console.log(`Loaded the network configuration located at ${ccpPath}`);
return ccp;
};
exports.buildWallet = async (Wallets, walletPath) => {
// Create a new wallet : Note that wallet is for managing identities.
let wallet;
if (walletPath) {
wallet = await Wallets.newFileSystemWallet(walletPath);
console.log(`Built a file system wallet at ${walletPath}`);
} else {
wallet = await Wallets.newInMemoryWallet();
console.log('Built an in memory wallet');
}
return wallet;
};

101
test-application/javascript/CAUtil.js Normal file
View file

@ -0,0 +1,101 @@
/*
* Copyright IBM Corp. All Rights Reserved.
*
* SPDX-License-Identifier: Apache-2.0
*/
'use strict';
const fs = require('fs');
const path = require('path');
const adminUserId = 'admin';
const adminUserPasswd = 'adminpw';
/**
*
* @param {*} FabricCAServices
* @param {*} ccp
*/
exports.buildCAClient = (FabricCAServices, ccp) => {
// Create a new CA client for interacting with the CA.
const caInfo = ccp.certificateAuthorities['ca.org1.example.com'];
const caTLSCACerts = caInfo.tlsCACerts.pem;
const caClient = new FabricCAServices(caInfo.url, { trustedRoots: caTLSCACerts, verify: false }, caInfo.caName);
console.log(`Built a CA Client named ${caInfo.caName}`);
return caClient;
};
exports.enrollAdmin = async (caClient, wallet) => {
try {
// Check to see if we've already enrolled the admin user.
const identity = await wallet.get(adminUserId);
if (identity) {
console.log('An identity for the admin user already exists in the wallet');
return;
}
// Enroll the admin user, and import the new identity into the wallet.
const enrollment = await caClient.enroll({ enrollmentID: adminUserId, enrollmentSecret: adminUserPasswd });
const x509Identity = {
credentials: {
certificate: enrollment.certificate,
privateKey: enrollment.key.toBytes(),
},
mspId: 'Org1MSP',
type: 'X.509',
};
await wallet.put(adminUserId, x509Identity);
console.log('Successfully enrolled admin user and imported it into the wallet');
} catch (error) {
console.error(`Failed to enroll admin user : ${error}`);
}
};
exports.registerUser = async (caClient, wallet, userId, affiliation) => {
try {
// Check to see if we've already enrolled the user
const userIdentity = await wallet.get(userId);
if (userIdentity) {
console.log(`An identity for the user ${userId} already exists in the wallet`);
return;
}
// Must use an admin to register a new user
const adminIdentity = await wallet.get(adminUserId);
if (!adminIdentity) {
console.log('An identity for the admin user does not exist in the wallet');
console.log('Enroll the admin user before retrying');
return;
}
// build a user object for authenticating with the CA
const provider = wallet.getProviderRegistry().getProvider(adminIdentity.type);
const adminUser = await provider.getUserContext(adminIdentity, adminUserId);
// Register the user, enroll the user, and import the new identity into the wallet.
// if affiliation is specified by client, the affiliation value must be configured in CA
const secret = await caClient.register({
affiliation: affiliation,
enrollmentID: userId,
role: 'client'
}, adminUser);
const enrollment = await caClient.enroll({
enrollmentID: userId,
enrollmentSecret: secret
});
const x509Identity = {
credentials: {
certificate: enrollment.certificate,
privateKey: enrollment.key.toBytes(),
},
mspId: 'Org1MSP',
type: 'X.509',
};
await wallet.put(userId, x509Identity);
console.log(`Successfully registered and enrolled user ${userId} and imported it into the wallet`);
} catch (error) {
console.error(`Failed to register user : ${error}`);
}
};