artifactgen, additional documentation and samples (#432)

Signed-off-by: Angelo De Caro <adc@zurich.ibm.com>

Author: adecaro

README.md

@@ -62,6 +62,12 @@ FABRIC_VERSION=2.4.6 make download-fabric
 
 If you want to provide your own versions of the fabric binaries then just set `FAB_BINS` to the directory where all the fabric binaries are stored.
 
+# Utilities
+
+- [`tokengen`](./cmd/tokengen/README.md) is an utility for generating Fabric Token-SDK material.
+  It is provided as a means of preconfiguring public parameters, token chaincode, and so.
+  It would normally not be used in the operation of a production network.
+
 # Additional Resources
 
 - (March 17, 2022) [`Hyperledger in-Depth: Tokens in Hyperledger Fabric: What’s possible today and what’s coming`](https://www.hyperledger.org/learn/webinars/hyperledger-in-depth-tokens-in-hyperledger-fabric-whats-possible-today-and-whats-coming):

cmd/tokengen/README.md

@@ -16,6 +16,11 @@ The `tokengen` command has five subcommands, as follows:
 
 ## tokengen artifacts
 
+This command is used to centrally generate key material and configuration files.
+It takes in input a `topology` file, in `yaml` format, that describes the topologies of the networks involved.
+An example can be found [`here`](./samples/topology/fungible.yaml). 
+Topology files can be edited directly or they can be generated programmatically as shown [`here`](./samples/topology/fungible.go). 
+
 ```
 Read topology from file and generates artifacts.
 

cmd/tokengen/samples/topology/fungible.go

@@ -0,0 +1,121 @@
+/*
+Copyright IBM Corp. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package main
+
+import (
+	"github.com/hyperledger-labs/fabric-smart-client/integration/nwo/api"
+	"github.com/hyperledger-labs/fabric-smart-client/integration/nwo/fabric"
+	"github.com/hyperledger-labs/fabric-smart-client/integration/nwo/fsc"
+	fabricSDK "github.com/hyperledger-labs/fabric-smart-client/platform/fabric/sdk"
+	"github.com/hyperledger-labs/fabric-token-sdk/integration/nwo/artifactgen"
+	"github.com/hyperledger-labs/fabric-token-sdk/integration/nwo/token"
+	fabric2 "github.com/hyperledger-labs/fabric-token-sdk/integration/nwo/token/fabric"
+	"github.com/hyperledger-labs/fabric-token-sdk/samples/fungible/views"
+	tokenSDK "github.com/hyperledger-labs/fabric-token-sdk/token/sdk"
+)
+
+func Topology(tokenSDKDriver string) []api.Topology {
+	// Fabric
+	fabricTopology := fabric.NewDefaultTopology()
+	fabricTopology.EnableIdemix()
+	fabricTopology.AddOrganizationsByName("Org1", "Org2")
+	fabricTopology.SetNamespaceApproverOrgs("Org1")
+	fabricTopology.EnableGRPCLogging()
+	fabricTopology.EnableLogPeersToFile()
+	fabricTopology.EnableLogOrderersToFile()
+	fabricTopology.SetLogging("info", "")
+
+	// FSC
+	fscTopology := fsc.NewTopology()
+	fscTopology.SetLogging("info", "")
+	fscTopology.EnableLogToFile()
+	fscTopology.EnablePrometheusMetrics()
+
+	// issuer
+	issuer := fscTopology.AddNodeByName("issuer").AddOptions(
+		fabric.WithOrganization("Org1"),
+		fabric.WithAnonymousIdentity(),
+		token.WithDefaultIssuerIdentity(),
+		token.WithIssuerIdentity("issuer.id1"),
+	)
+	issuer.RegisterViewFactory("issue", &views.IssueCashViewFactory{})
+	issuer.RegisterViewFactory("issued", &views.ListIssuedTokensViewFactory{})
+
+	// auditor
+	auditor := fscTopology.AddNodeByName("auditor").AddOptions(
+		fabric.WithOrganization("Org1"),
+		fabric.WithAnonymousIdentity(),
+		token.WithAuditorIdentity(),
+	)
+	auditor.RegisterViewFactory("register", &views.RegisterAuditorViewFactory{})
+
+	// alice
+	alice := fscTopology.AddNodeByName("alice").AddOptions(
+		fabric.WithOrganization("Org2"),
+		fabric.WithAnonymousIdentity(),
+		token.WithDefaultOwnerIdentity(tokenSDKDriver),
+		token.WithOwnerIdentity(tokenSDKDriver, "alice.id1"),
+	)
+	alice.RegisterResponder(&views.AcceptCashView{}, &views.IssueCashView{})
+	alice.RegisterResponder(&views.AcceptCashView{}, &views.TransferView{})
+	alice.RegisterViewFactory("transfer", &views.TransferViewFactory{})
+	alice.RegisterViewFactory("redeem", &views.RedeemViewFactory{})
+	alice.RegisterViewFactory("swap", &views.SwapInitiatorViewFactory{})
+	alice.RegisterViewFactory("unspent", &views.ListUnspentTokensViewFactory{})
+
+	// bob
+	bob := fscTopology.AddNodeByName("bob").AddOptions(
+		fabric.WithOrganization("Org2"),
+		fabric.WithAnonymousIdentity(),
+		token.WithDefaultOwnerIdentity(tokenSDKDriver),
+		token.WithOwnerIdentity(tokenSDKDriver, "bob.id1"),
+	)
+	bob.RegisterResponder(&views.AcceptCashView{}, &views.IssueCashView{})
+	bob.RegisterResponder(&views.AcceptCashView{}, &views.TransferView{})
+	bob.RegisterResponder(&views.SwapResponderView{}, &views.SwapInitiatorView{})
+	bob.RegisterViewFactory("transfer", &views.TransferViewFactory{})
+	bob.RegisterViewFactory("redeem", &views.RedeemViewFactory{})
+	bob.RegisterViewFactory("swap", &views.SwapInitiatorViewFactory{})
+	bob.RegisterViewFactory("unspent", &views.ListUnspentTokensViewFactory{})
+
+	// charlie
+	charlie := fscTopology.AddNodeByName("charlie").AddOptions(
+		fabric.WithOrganization("Org2"),
+		fabric.WithAnonymousIdentity(),
+		token.WithDefaultOwnerIdentity(tokenSDKDriver),
+		token.WithOwnerIdentity(tokenSDKDriver, "charlie.id1"),
+	)
+	charlie.RegisterResponder(&views.AcceptCashView{}, &views.IssueCashView{})
+	charlie.RegisterResponder(&views.AcceptCashView{}, &views.TransferView{})
+	charlie.RegisterResponder(&views.SwapResponderView{}, &views.SwapInitiatorView{})
+	charlie.RegisterViewFactory("transfer", &views.TransferViewFactory{})
+	charlie.RegisterViewFactory("redeem", &views.RedeemViewFactory{})
+	charlie.RegisterViewFactory("swap", &views.SwapInitiatorViewFactory{})
+	charlie.RegisterViewFactory("unspent", &views.ListUnspentTokensViewFactory{})
+
+	tokenTopology := token.NewTopology()
+	tokenTopology.SetSDK(fscTopology, &tokenSDK.SDK{})
+	tms := tokenTopology.AddTMS(fscTopology.ListNodes(), fabricTopology, fabricTopology.Channels[0].Name, tokenSDKDriver)
+	fabric2.SetOrgs(tms, "Org1")
+	tms.SetTokenGenPublicParams("100", "2")
+	tms.AddAuditor(auditor)
+
+	// Add Fabric SDK to FSC Nodes
+	fscTopology.AddSDK(&fabricSDK.SDK{})
+
+	return []api.Topology{
+		fabricTopology,
+		tokenTopology,
+		fscTopology,
+	}
+}
+
+func main() {
+	if err := artifactgen.WriteTopologies("fungible.yaml", Topology("dlog"), 0766); err != nil {
+		panic(err)
+	}
+}