Playground Tutorial

• In this step by step tutorial we'll walk through setting up a business

network, defining our assets, participants and transactions, and testing
our network by creating some participants and an asset, and submitting
transactions to change the ownership of the asset from one to another.
• This tutorial is intended to act as an introduction to Hyperledger
Composer concepts using the online playground environment.(You can
also use your local system one.)
• Start your local Hyperledger playground by following the steps defined
in Lab 1. Or use the following url -
https://composer-playground.mybluemix.net/
To run it online.
• NOTE: If you are using playground locally and connecting to
a real Fabric please refer to the additional notes at the bottom of the
tutorial.
• Or you can delete the card available there and follow the same steps as
in case of online composer playground.
• Step One: Open the Hyperledger Composer
Playground
• Click on Lets Blockchain button.
• You should see the My Business
Networks screen. The My Business
Networks page shows you a summary of the
business networks you can connect to, and
the identities you can use to connect to them.
Don't worry about this too much for the time
being, as we're going to create our own
network.
• Step Two: Creating a new business network
• Next, we want to create a new business network from scratch. A
business network has a couple of defining properties; a name, and
an optional description. You can also choose to base a new
business network on an existing template, or import your own
template.
• Click Deploy a new business network under the Web Browser
heading to get started.
• The new business network needs a name, let's call it tutorial-
network.
• Optionally, you can enter a description for your business network.
• Next we must select a business network to base ours on, because
we want to build the network from scratch, click empty-business-
network.
• Now that our network is defined, click Deploy.
• Step Three: Connecting to the business network
• Now that we've created and deployed the business
network, you should see a new business network card
called admin for our business network tutorial-
network in your wallet. The wallet can contain business
network cards to connect to multiple deployed business
networks.
• When connecting to an external blockchain, business
network cards represent everything necessary to
connect to a business network. They include connection
details, authentication material, and metadata.
• To connect to our business network click Connect
now under our business network card.
• Step Four: Adding a model file
• As you can see, we're in the Define tab right now, this
tab is where you create and edit the files that make up a
business network definition, before deploying them and
testing them using the Test tab.
• As we selected an empty business network template, we
need to modify the template files provided. The first
step is to update the model file. Model files define the
assets, participants, transactions, and events in our
business network.
• Click the Model file to view it.
• Delete the lines of code in the model file and replace it
with this:
/**
* My commodity trading network
*/
namespace org.example.mynetwork
asset Commodity identified by tradingSymbol {
o String tradingSymbol
o String description
o String mainExchange
o Double quantity
--> Trader owner
}
participant Trader identified by tradeId {
o String tradeId
o String firstName
o String lastName
}
transaction Trade {
--> Commodity commodity
--> Trader newOwner
}
• This domain model defines a single asset type Commodity and single participant type Trader and a single
transaction type Trade that is used to modify the owner of a commodity.
• Step Five: Adding a transaction processor script file
• Now that the domain model has been defined, we
can define the transaction logic for the business
network. Composer expresses the logic for a
business network using JavaScript functions. These
functions are automatically executed when a
transaction is submitted for processing.
• Click the Add a file button.
• Click the Script file and click Add.
• Delete the lines of code in the script file and replace
it with the following code:
/**
* Track the trade of a commodity from one trader to another
* @param {org.example.mynetwork.Trade} trade - the trade to be
processed
* @transaction
*/
async function tradeCommodity(trade) {
trade.commodity.owner = trade.newOwner;
let assetRegistry = await
getAssetRegistry('org.example.mynetwork.Commodity');
await assetRegistry.update(trade.commodity);
}
• This function simply changes the owner property on a commodity based
on the newOwner property on an incoming Trade transaction. It then
persists the modified Commodity back into the asset registry, used to
store Commodity instances.
• Step Six: Access control
• Access control files define the access control
rules for business networks. Our network is
simple, so the default access control file
doesn't need editing. The basic file gives the
current participant networkAdmin full access
to business network and system-level
operations.
• While you can have multiple model or script
files, you can only have one access control file
in any business network.
• Step Seven: Deploying the updated business network
• Now that we have model, script, and access control files,
we need to deploy and test our business network.
• Click Deploy changes to upgrade the business network.
• Step Eight: Testing the business network definition
• Next, we need to test our business network by creating
some participants (in this case Traders), creating an asset
(a Commodity), and then using our Trade transaction to
change the ownership of the Commodity.
• Click the Test tab to get started.
• Step Nine: Creating participants
• The first thing we should add to our business network is two
participants.
• Ensure that you have the Trader tab selected on the left, and
click Create New Participant in the upper right.
• What you can see is the data structure of a Trader participant.
We want some easily recognizable data, so delete the code
that's there and paste the following:
{
"$class": "org.example.mynetwork.Trader",
"tradeId": "TRADER1",
"firstName": "Jenny",
"lastName": "Jones"
}
• Click Create New to create the participant.
• You should be able to see the new Trader participant
you've created. We need another Trader to test
our Trade transaction though, so create another Trader,
but this time, use the following data:
{
"$class": "org.example.mynetwork.Trader",
"tradeId": "TRADER2",
"firstName": "Amy",
"lastName": "Williams"
}
• Make sure that both participants exist in the Trader view
before moving on!
• Step Ten: Creating an asset
• Now that we have two Trader participants, we need something for them to
trade. Creating an asset is very similar to creating a participant.
The Commodity we're creating will have an owner property indicating that it
belongs to the Trader with the tradeId of TRADER1.
• Click the Commodity tab under Assets and click Create New Asset.
• Delete the asset data and replace it with the following:
{
"$class": "org.example.mynetwork.Commodity",
"tradingSymbol": "ABC",
"description": "Test commodity",
"mainExchange": "Euronext",
"quantity": 72.297,
"owner": "resource:org.example.mynetwork.Trader#TRADER1"
}
• After creating this asset, you should be able to see it in the Commodity tab.
• Step Eleven: Transferring the commodity between the
participants
• Now that we have two Traders and a Commodity to trade
between them, we can test our Trade transaction.
• Transactions are the basis of all change in a Hyperledger
Composer business network, if you want to experiment with
your own after this tutorial, try creating another business
network from the My Business Network screen and using a
more advanced business network template.
• To test the Trade transaction:
• Click the Submit Transaction button on the left.
• Ensure that the transaction type is Trade.
• Replace the transaction data with the following, or just
change the details:
{
"$class": "org.example.mynetwork.Trade",
"commodity": "resource:org.example.mynetwork.Commodity#ABC",
"newOwner": "resource:org.example.mynetwork.Trader#TRADER2"
}
• Click Submit.
• Check that our asset has changed ownership from TRADER1 to TRADER2, by
expanding the data section for the asset. You should see that the owner is
listed as resource:org.example.mynetwork.Trader#TRADER2.
• To view the full transaction history of our business network, click All
Transactions on the left. Here is a list of each transaction as they were
submitted. You can see that certain actions we performed using the UI, like
creating the Trader participants and the Commodity asset, are recorded as
transactions, even though they're not defined as transactions in our business
network model. These transactions are known as 'System Transactions' and
are common to all business networks, and defined in the Hyperledger
Composer Runtime.
• Logging out of the business network
• Now that transactions have successfully run,
we should log out of the business network,
ending up at the My Business Network screen
where we started.
• In the upper-right of the screen is a button
labelled admin. This lists your current identity,
to log out, click admin to open the dropdown
menu, and click My Business Networks.
Deploying a Business Network to a real Fabric

• Using Playground locally, you can use connections to "Web

Browser" which works in the browser local storage, or you can
use Connections to a real Fabric usually in a group called "hlfv1"
• If you are connecting to a real Fabric, then you will likely have
already created a Card for an identity with PeerAdmin and
ChannelAdmin roles - this is often called PeerAdmin. This is the
card that you use to Deploy and Update your network with
Composer.
• When you are deploying your network to a real Fabric there are
additional fields to complete before you can click
the Deploy button - you need to supply the details of
the Network Administrator.
• Scroll to the bottom of the Deploy Screen to
find CREDENTIALS FOR NETWORK
ADMINISTRATOR. For a simple Development
Fabric and many Test networks you can supply
an ID and Secret. Enrollment ID - admin
Enrollment Secret - adminpw
• When the ID and Secret are specified, you can
click the Deploy button and resume the tutorial
at Step Three.
• If you are working with a Custom or Production
Fabric - contact your Fabric Administrator for
details of the Network Administrator.
• Updating a Business Network when connected to a
real Fabric
• When you are using a real Fabric and click Deploy
Changes you will see an addition popup dialog
asking you to specify an Installation Card and an
Upgrade card from dropdown lists. Typically you
specify the same PeerAdmin card as used to deploy
the initial network. If you are uncertain, contact your
Fabric Administrator.
• Select the cards, and click the Upgrade button. Note
that on a real Fabric this can take a few minutes to
complete.
• Resume the Tutorial at Step Eight.