Merge pull request #1159 from kaleido-io/v1.2.0-docs

v1.2.0 Docs

Author: nguyer

docs/Gemfile.lock

@@ -217,11 +217,15 @@ GEM
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     mercenary (0.3.6)
+    mini_portile2 (2.8.1)
     minima (2.5.1)
       jekyll (>= 3.5, < 5.0)
       jekyll-feed (~> 0.9)
       jekyll-seo-tag (~> 2.1)
     minitest (5.16.3)
+    nokogiri (1.13.8)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
     nokogiri (1.13.8-arm64-darwin)
       racc (~> 1.4)
     octokit (4.25.1)
@@ -268,6 +272,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-21
+  ruby
 
 DEPENDENCIES
   github-pages

docs/_i18n/en.yml

@@ -14,6 +14,7 @@ pages:
   avalanche: Avalanche Testnet
   binance_smart_chain: Binance Smartchain Testnet
   blockchain_protocols: Blockchain Protocols
+  blockchain_operation_status: Blockchain Operation Status
   broadcast_data: Broadcast data
   broadcast_data: Broadcast Data
   broadcast_shared_data: Broadcast / Shared Data

docs/architecture/blockchain_connector_framework.md

@@ -145,6 +145,10 @@ A reference implementation is provided that:
 
 The reference implementation is available [here](https://github.com/hyperledger/firefly-transaction-manager/blob/main/pkg/policyengines/simple/simple_policy_engine.go)
 
+FireFly 1.2 introduced a specification for policy engines to record more detailed information about transaction sub-status and lower-level actions it performs
+as part of progressing a transaction onto the chain. A policy engine might for example have a sub-status of `Received` and another sub-status of `Tracking`. For more information see [Blockchain Operation Status](../reference/blockchain_operation_status.html)
+
+
 ## Event Streams
 
 One of the largest pieces of heavy lifting code in the FFTM codebase, is the event stream

docs/faqs/index.md

@@ -10,17 +10,21 @@ has_children: false
 Find answers to the most commonly asked FireFly questions.
 
 ## How does FireFly enable multi-chain applications?
-It's best to think about FireFly as a rich orchestration layer that sits one layer above the blockchain.  FireFly helps to abstract away much of the complex blockchain functionality (such as data exchange, private messaging, common token functionality, etc) in a loosely coupled microservice architecture with highly pluggable components. This enables application developers to focus on building innovative Web3 applications.
+
+It's best to think about FireFly as a rich orchestration layer that sits one layer above the blockchain. FireFly helps to abstract away much of the complex blockchain functionality (such as data exchange, private messaging, common token functionality, etc) in a loosely coupled microservice architecture with highly pluggable components. This enables application developers to focus on building innovative Web3 applications.
 
 There aren't any out of the box bridges to connect two separate chains together, but with a collection of FireFly instances across a consortium, FireFly could help listen for events on Blockchain A and take an action on Blockchain B when certain conditions are met.
 
 ## 📜 How do I deploy smart contracts?
-In order to interact with a smart contract on a public or private Ethereum chain you need to first deploy it to the chain. Deployment means that you've sent a transaction with the compiled source code to the chain without a specified recipient and received a contract address that you and others on the network can use to interact with your contract.
 
-Refer to the [Smart Contract Tutorial](../tutorials/custom_contracts/) for instructions to deploy a smart contract to your private networking using FireFly.
+The recommended way to deploy smart contracts on Ethereum chains is by using FireFly's built in API. For a step by step example of how to do this you can refer to the [Smart Contract Tutorial](../tutorials/custom_contracts/ethereum.md#contract-deployment) for Ethereum based chains.
+
+For Fabric networks, please refer to the [Fabric chaincode lifecycle docs](https://hyperledger-fabric.readthedocs.io/en/latest/chaincode_lifecycle.html) for detailed instructions on how to deploy and manage Fabric chaincode.
 
 ## 🦊 Can I connect FireFly to MetaMask?
+
 Yes! Before you set up MetaMask you'll likely want to create some tokens that you can use to send between wallets on your FF network. Go to the tokens tab in your FireFly node's UI, create a token pool, and then mint some tokens. Once you've done this, follow the steps listed [here](https://hyperledger.github.io/firefly/tutorials/tokens/erc721.html#use-metamask) to set up MetaMask on your network.
 
 ## 🚀 Connect with us on Discord
-If your question isn't answered here or if you have immediate questions please don't hesitate to reach out to us on [Discord](https://discord.gg/hyperledger_) in the `firefly` channel:
+
+If your question isn't answered here or if you have immediate questions please don't hesitate to reach out to us on [Discord](https://discord.gg/hyperledger_) in the `firefly` channel:

docs/gettingstarted/setup_env.md

@@ -41,9 +41,14 @@ The FireFly stack will run in a `docker-compose` project. For systems that run D
 
 It's really easy to create a new FireFly stack. The `ff init` command can create a new stack for you, and will prompt you for a few details such as the name, and how many members you want in your stack.
 
-Run:
+To create an Ethereum based stack, run:
 ```
-ff init
+ff init ethereum
+```
+
+To create an Fabric based stack, run:
+```
+ff init fabric
 ```
 
 Choose a stack name. For this guide, I will choose the name `dev`, but you can pick whatever you want:
@@ -60,37 +65,46 @@ number of members: 3
 
 ### Stack initialization options
 
-There are quite a few options that you can choose from when creating a new stack. For now, we'll just stick with the defaults. To see the full list of options, just run `ff init --help`. 
+There are quite a few options that you can choose from when creating a new stack. For now, we'll just stick with the defaults. To see the full list of Ethereum options, just run `ff init ethereum --help` or to see the full list of Fabric options run `ff init fabric --help` 
 
 ```
-$ ff init --help
-Create a new FireFly local dev stack
+ff init ethereum --help
+Create a new FireFly local dev stack using an Ethereum blockchain
 
 Usage:
-  ff init [stack_name] [member_count] [flags]
+  ff init ethereum [stack_name] [member_count] [flags]
 
 Flags:
       --block-period int              Block period in seconds. Default is variable based on selected blockchain provider. (default -1)
-  -b, --blockchain-provider string    Blockchain provider to use. Options are: [geth besu fabric corda] (default "geth")
+  -c, --blockchain-connector string   Blockchain connector to use. Options are: [evmconnect ethconnect] (default "evmconnect")
+  -n, --blockchain-node string        Blockchain node type to use. Options are: [geth besu remote-rpc] (default "geth")
+      --chain-id int                  The chain ID - also used as the network ID (default 2021)
       --contract-address string       Do not automatically deploy a contract, instead use a pre-configured address
+  -h, --help                          help for ethereum
+      --remote-node-url string        For cases where the node is pre-existing and running remotely
+
+Global Flags:
+      --ansi string                   control when to print ANSI control characters ("never"|"always"|"auto") (default "auto")
+      --channel string                Select the FireFly release channel to use. Options are: [stable head alpha beta rc] (default "stable")
+      --connector-config string       The path to a yaml file containing extra config for the blockchain connector
       --core-config string            The path to a yaml file containing extra config for FireFly Core
-  -d, --database string               Database type to use. Options are: [postgres sqlite3] (default "sqlite3")
-      --ethconnect-config string      The path to a yaml file containing extra config for Ethconnect
+  -d, --database string               Database type to use. Options are: [sqlite3 postgres] (default "sqlite3")
   -e, --external int                  Manage a number of FireFly core processes outside of the docker-compose stack - useful for development and debugging
   -p, --firefly-base-port int         Mapped port base of FireFly core API (1 added for each member) (default 5000)
-  -h, --help                          help for init
+      --ipfs-mode string              Set the mode in which IFPS operates. Options are: [private public] (default "private")
   -m, --manifest string               Path to a manifest.json file containing the versions of each FireFly microservice to use. Overrides the --release flag.
+      --multiparty                    Enable or disable multiparty mode (default true)
+      --node-name stringArray         Node name
+      --org-name stringArray          Organization name
       --prometheus-enabled            Enables Prometheus metrics exposition and aggregation to a shared Prometheus server
       --prometheus-port int           Port for the shared Prometheus server (default 9090)
       --prompt-names                  Prompt for org and node names instead of using the defaults
-  -r, --release string                Select the FireFly release version to use (default "latest")
+  -r, --release string                Select the FireFly release version to use. Options are: [stable head alpha beta rc] (default "latest")
+      --request-timeout int           Custom request timeout (in seconds) - useful for registration to public chains
       --sandbox-enabled               Enables the FireFly Sandbox to be started with your FireFly stack (default true)
   -s, --services-base-port int        Mapped port base of services (100 added for each member) (default 5100)
-  -t, --token-providers stringArray   Token providers to use. Options are: [none erc1155 erc20_erc721] (default [erc1155])
-
-Global Flags:
-      --ansi string   control when to print ANSI control characters ("never"|"always"|"auto") (default "auto")
-  -v, --verbose       verbose log output
+  -t, --token-providers stringArray   Token providers to use. Options are: [none erc1155 erc20_erc721] (default [erc20_erc721])
+  -v, --verbose                       verbose log output
 ```
 
 ### Start your stack