clean up dependencies of sdk.go (#635)

Signed-off-by: Angelo De Caro <[email protected]>

Author: adecaro

docs/deployment/deployment.md

@@ -0,0 +1,59 @@
+# Deployment
+
+The Fabric Token SDK and the Fabric Smart Client form an Application Layer stack to build token-based distributed applications.
+
+The stack can run as: 
+- A standalone network node
+- Embedded in an already existing Application
+
+![img.png](../imgs/deployment.png)
+
+Either way, the token-sdk and smart client stacks must be initialized. 
+Here are the steps you need to keep in mind:
+1. Create a smart client node; 
+2. Install the application SDKs you need;
+3. Start the node;
+
+```go
+/*
+Copyright IBM Corp. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package main
+
+import (
+	fscnode "github.com/hyperledger-labs/fabric-smart-client/node"
+	fsdk "github.com/hyperledger-labs/fabric-smart-client/platform/fabric/sdk"
+	tsdk "github.com/hyperledger-labs/fabric-token-sdk/token/sdk" 
+	
+	// The Token SDK must be further customized with `blank imports`. 
+	// Here are the required imports:
+	// - Token Drivers: Import all the token drivers your application must support
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/core/zkatdlog/nogh/driver"
+	// - DB Drivers: Import all the db drivers your application must support
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/db/sql/driver/unity"
+	// - Network Drivers: Import all the network drivers your application must support
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/network/fabric"
+	// The DB driver `unity` uses an SQL database, therefore we need to import the one we want to use.
+	// In this case, it is sqlite
+	_ "modernc.org/sqlite"
+)
+
+func main() {
+	// 1. Create a smart client node;
+	n := fscnode.New()
+	// 2. Install the application SDKs you need;
+	// In this case, we install the Fabric SDK (from the smart client), and the Token SDK (from the token sdk)
+	n.InstallSDK(fsdk.NewSDK(n))
+	n.InstallSDK(tsdk.NewSDK(n))
+	// 3. Start the node;
+	// If the boostrap is successful then this callback function is invoked. 
+	n.Execute(func() error {
+		// At this point, it is possible to access any service, provided by the installed SDKs, 
+		// for further initializations.
+		return nil
+	})
+}
+```

docs/design.md

@@ -22,4 +22,5 @@
 **Additional Information:**
 
 * The SDK leverages the Fabric Smart Client stack for complex workflows, secure storage, and event listening.
-* Configuration examples can be found in the [`Example Core File Section`](./core-token.md) documentation.
+* Configuration examples can be found in the [`Example Core File Section`](./core-token.md) documentation.
+* Deployment guideline can be found in the [`Deployment`](./deployment/deployment.md) documentation.

docs/imgs/deployment.png

@@ -3,33 +3,73 @@
 The Fabric Token SDK utilizes a robust data management system to ensure the secure and reliable tracking of all token-related activities.
 This system leverages several databases, each with a specific purpose:
 
-* **Transaction Database (ttxdb)**:
+* **Transaction Database (`ttxdb`)**:
   This critical database serves as the central repository for all transaction records.
   It captures every token issuance, transfer, or redemption, providing a complete historical record of token activity within the network.
-  The ttxdb service is locate under [`token/services/ttxdb`](./../../token/services/ttxdb).
+  The `ttxdb` service is locate under [`token/services/ttxdb`](./../../token/services/ttxdb).
 
-* **Token Database (tokendb)**:
-  The tokendb acts as the registry for all tokens within the system.
+* **Token Database (`tokendb`)**:
+  The `tokendb` acts as the registry for all tokens within the system.
   It stores detailed information about each token, including its unique identifier, denomination type (think currency or unique identifier), current ownership, and total quantity in circulation.
-  By referencing the tokendb, developers and network participants can obtain a clear picture of the token landscape.
-  The tokendb is used by the `Token Selector`, to select the tokens to use in each transaction, and by the `Token Vault Service` to provide its services.
-  The tokendb service is locate under [`token/services/tokendb`](./../../token/services/tokendb).
+  By referencing the `tokendb`, developers and network participants can obtain a clear picture of the token landscape.
+  The `tokendb` is used by the `Token Selector`, to select the tokens to use in each transaction, and by the `Token Vault Service` to provide its services.
+  The `tokendb` service is locate under [`token/services/tokendb`](./../../token/services/tokendb).
 
-* **Audit Database (auditdb)** (if applicable):
-  For applications requiring enhanced auditability, the auditdb provides an additional layer of transparency.
+* **Audit Database (`auditdb`)** (if applicable):
+  For applications requiring enhanced auditability, the `auditdb` provides an additional layer of transparency.
   It meticulously stores audit records for transactions that have undergone the auditing process.
   This functionality is particularly valuable for scenarios where regulatory compliance or tamper-proof records are essential. 
-  The auditdb service is locate under [`token/services/auditdb`](./../../token/services/auditdb).
+  The `auditdb` service is locate under [`token/services/auditdb`](./../../token/services/auditdb).
 
-* **Identity Database (identitydb)**:
-  The identitydb plays a crucial role in managing user identities and wallets within the network.
-  It securely stores walet configurations, identity-related audit information, and so on, enabling secure interactions with the token system.
-  The identitydb service is locate under [`token/services/identitydb`](./../../token/services/identitydb).
+* **Identity Database (`identitydb`)**:
+  The `identitydb` plays a crucial role in managing user identities and wallets within the network.
+  It securely stores wallet configurations, identity-related audit information, and so on, enabling secure interactions with the token system.
+  The `identitydb` service is locate under [`token/services/identitydb`](./../../token/services/identitydb).
 
-The Fabric Token SDK offers flexibility in deploying these databases. Developers can choose to:
+## Configuration
+
+The Token SDK offers flexibility in deploying these databases. Developers can choose to:
 
 * **Instantiate in Isolation:** Each database can operate independently, utilizing a distinct backend system for optimal performance and manageability.
+Here is an example of configuration 
+```yaml
+token:
+  tms:
+    mytms: # unique name of this token management system
+      network: default # the name of the network this TMS refers to (Fabric, Orion, etc)
+      channel: testchannel # the name of the network's channel this TMS refers to, if applicable
+      namespace: tns # the name of the channel's namespace this TMS refers to, if applicable
+      # db specific driver
+      tokendb:
+        persistence:
+          type: sql
+          opts:
+            createSchema: true 
+            driver: sqlite    
+            maxOpenConns: 10
+            dataSource: /some/path/tokendb
+```
 
 * **Shared Backend:** Alternatively, a single backend system can be shared by all databases, offering a more streamlined approach for deployments with simpler requirements.
+```yaml
+token:
+  tms:
+    mytms: # unique name of this token management system
+      network: default # the name of the network this TMS refers to (Fabric, Orion, etc)
+      channel: testchannel # the name of the network's channel this TMS refers to, if applicable
+      namespace: tns # the name of the channel's namespace this TMS refers to, if applicable
+
+      # shared db configuration. The `unity` driver is used as provider.  
+      db:
+        persistence:
+          # configuration for the unity db driver. It uses sql as backend
+          type: unity
+          opts:
+            createSchema: true
+            driver: sqlite
+            maxOpenConns: 10
+            dataSource: /some/path/unitydb
+```
 
 The specific driver used by the application will ultimately determine the available deployment options.
+Don't forget to import the driver that you are ultimately using with a blank import in your executable.  

docs/services/storage.md

@@ -0,0 +1,29 @@
+/*
+Copyright IBM Corp. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package fall
+
+import (
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/core/fabtoken/driver"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/core/zkatdlog/nogh/driver"
+	sdk "github.com/hyperledger-labs/fabric-token-sdk/token/sdk"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/auditdb/db/sql"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/db/sql/driver/unity"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/identitydb/db/sql"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/network/fabric"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/tokendb/db/sql"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/tokenlockdb/db/sql"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/ttxdb/db/sql"
+	_ "modernc.org/sqlite"
+)
+
+type SDK struct {
+	*sdk.SDK
+}
+
+func NewSDK(registry sdk.Registry) *SDK {
+	return &SDK{SDK: sdk.NewSDK(registry)}
+}

integration/token/common/sdk/fall/sdk.go

@@ -0,0 +1,28 @@
+/*
+Copyright IBM Corp. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package fdlog
+
+import (
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/core/zkatdlog/nogh/driver"
+	sdk "github.com/hyperledger-labs/fabric-token-sdk/token/sdk"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/auditdb/db/sql"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/db/sql/driver/unity"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/identitydb/db/sql"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/network/fabric"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/tokendb/db/sql"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/tokenlockdb/db/sql"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/ttxdb/db/sql"
+	_ "modernc.org/sqlite"
+)
+
+type SDK struct {
+	*sdk.SDK
+}
+
+func NewSDK(registry sdk.Registry) *SDK {
+	return &SDK{SDK: sdk.NewSDK(registry)}
+}

integration/token/common/sdk/fdlog/sdk.go

@@ -0,0 +1,28 @@
+/*
+Copyright IBM Corp. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package ffabtoken
+
+import (
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/core/fabtoken/driver"
+	sdk "github.com/hyperledger-labs/fabric-token-sdk/token/sdk"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/auditdb/db/sql"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/db/sql/driver/unity"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/identitydb/db/sql"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/network/fabric"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/tokendb/db/sql"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/tokenlockdb/db/sql"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/ttxdb/db/sql"
+	_ "modernc.org/sqlite"
+)
+
+type SDK struct {
+	*sdk.SDK
+}
+
+func NewSDK(registry sdk.Registry) *SDK {
+	return &SDK{SDK: sdk.NewSDK(registry)}
+}

integration/token/common/sdk/ffabtoken/sdk.go

@@ -0,0 +1,29 @@
+/*
+Copyright IBM Corp. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package fodlog
+
+import (
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/core/zkatdlog/nogh/driver"
+	sdk "github.com/hyperledger-labs/fabric-token-sdk/token/sdk"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/auditdb/db/sql"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/db/sql/driver/unity"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/identitydb/db/sql"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/network/fabric"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/network/orion"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/tokendb/db/sql"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/tokenlockdb/db/sql"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/ttxdb/db/sql"
+	_ "modernc.org/sqlite"
+)
+
+type SDK struct {
+	*sdk.SDK
+}
+
+func NewSDK(registry sdk.Registry) *SDK {
+	return &SDK{SDK: sdk.NewSDK(registry)}
+}

integration/token/common/sdk/fodlog/sdk.go

@@ -0,0 +1,29 @@
+/*
+Copyright IBM Corp. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package fofabtoken
+
+import (
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/core/fabtoken/driver"
+	sdk "github.com/hyperledger-labs/fabric-token-sdk/token/sdk"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/auditdb/db/sql"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/db/sql/driver/unity"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/identitydb/db/sql"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/network/fabric"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/network/orion"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/tokendb/db/sql"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/tokenlockdb/db/sql"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/ttxdb/db/sql"
+	_ "modernc.org/sqlite"
+)
+
+type SDK struct {
+	*sdk.SDK
+}
+
+func NewSDK(registry sdk.Registry) *SDK {
+	return &SDK{SDK: sdk.NewSDK(registry)}
+}

integration/token/common/sdk/fofabtoken/sdk.go

@@ -0,0 +1,28 @@
+/*
+Copyright IBM Corp. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package odlog
+
+import (
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/core/zkatdlog/nogh/driver"
+	sdk "github.com/hyperledger-labs/fabric-token-sdk/token/sdk"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/auditdb/db/sql"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/db/sql/driver/unity"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/identitydb/db/sql"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/network/orion"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/tokendb/db/sql"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/tokenlockdb/db/sql"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/ttxdb/db/sql"
+	_ "modernc.org/sqlite"
+)
+
+type SDK struct {
+	*sdk.SDK
+}
+
+func NewSDK(registry sdk.Registry) *SDK {
+	return &SDK{SDK: sdk.NewSDK(registry)}
+}

integration/token/common/sdk/odlog/sdk.go

@@ -0,0 +1,28 @@
+/*
+Copyright IBM Corp. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package ofabtoken
+
+import (
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/core/fabtoken/driver"
+	sdk "github.com/hyperledger-labs/fabric-token-sdk/token/sdk"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/auditdb/db/sql"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/db/sql/driver/unity"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/identitydb/db/sql"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/network/orion"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/tokendb/db/sql"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/tokenlockdb/db/sql"
+	_ "github.com/hyperledger-labs/fabric-token-sdk/token/services/ttxdb/db/sql"
+	_ "modernc.org/sqlite"
+)
+
+type SDK struct {
+	*sdk.SDK
+}
+
+func NewSDK(registry sdk.Registry) *SDK {
+	return &SDK{SDK: sdk.NewSDK(registry)}
+}

integration/token/common/sdk/ofabtoken/sdk.go

@@ -7,11 +7,24 @@ SPDX-License-Identifier: Apache-2.0
 package common
 
 import (
+	"github.com/hyperledger-labs/fabric-smart-client/pkg/api"
 	"github.com/hyperledger-labs/fabric-token-sdk/integration/nwo/token/generators/dlog"
 	"github.com/hyperledger-labs/fabric-token-sdk/integration/nwo/token/topology"
 	. "github.com/onsi/gomega"
 )
 
+type Opts struct {
+	Backend         string
+	TokenSDKDriver  string
+	AuditorAsIssuer bool
+	Aries           bool
+	FSCLogSpec      string
+	NoAuditor       bool
+	HSM             bool
+	SDKs            []api.SDK
+	WebEnabled      bool
+}
+
 func SetDefaultParams(tokenSDKDriver string, tms *topology.TMS, aries bool) {
 	switch tokenSDKDriver {
 	case "dlog":