Fix: Solve issue #331 by adding FirstEvent support in FireFly config #332

MKVEERENDRA · 2024-11-17T11:56:10Z

This PR addresses issue #331, which was about adding support for the FirstEvent parameter in the FireFly configuration files.

Changes Made:
Added a new FirstEvent field support in the FireFly configuration (firefly_core_*.yml) files to allow specifying the starting event for blockchain-based processes.
Integrated this new parameter into the FireFly configuration logic during the stack initialization process.
Updated the stack setup and blockchain deployment flow to support FirstEvent, ensuring it can be configured when setting up FireFly for the first time.
The FirstEvent field is now configurable in the FireFlyConfig and is passed to the blockchain and smart contract initialization process.
Context and Fix:
The addition of the FirstEvent parameter gives users flexibility in defining which blockchain event the FireFly stack should use when starting up. This was missing in the previous configuration, causing issues for users who needed specific event handling.
This update ensures that FirstEvent is properly handled, stored in the configuration, and used during smart contract and blockchain node setup.
How to Test:
Start the FireFly stack with the new configuration changes.
Verify that the FirstEvent field is correctly passed to the blockchain during FireFly stack initialization.
Ensure that the expected event triggers the FireFly workflow appropriately, depending on the FirstEvent configuration value.
Issue Comment (on issue #331):
I have solved issue #331 by adding support for the FirstEvent parameter in the FireFly configuration. This allows users to specify which event should be used during FireFly stack initialization, enabling more flexible event handling for blockchain-based processes.

The fix is now available in the pull request https://github.com/MKVEERENDRA/firefly-cli1, and it has been tested to ensure the correct configuration of the FirstEvent value during the FireFly setup.

MKVEERENDRA · 2024-11-17T11:56:56Z

I Fixed it

…Fly config Signed-off-by: MKVEERENDRA <[email protected]>

EnriqueL8 · 2024-11-19T13:54:55Z

cmd/start.go

@@ -104,5 +104,6 @@ This command will start a stack and run it in the background.

 func init() {
 	startCmd.Flags().BoolVarP(&startOptions.NoRollback, "no-rollback", "b", false, "Do not automatically rollback changes if first time setup fails")
+	startCmd.Flags().StringVarP(&startOptions.FirstEvent, "first-event", "f", "0", "Specify the starting block for event processing (default: 0)")


A few things:

Move this to the init command

Would suggest renaming to --from-block and I wouldn't put a shortcut for this one of -f

I would make this super obvious that is only applies to multiparty as a contract listener gets created for that contract... It might be better as well to not create the contract listener at all

Suggested change

startCmd.Flags().StringVarP(&startOptions.FirstEvent, "first-event", "f", "0", "Specify the starting block for event processing (default: 0)")

startCmd.Flags().StringVarP(&startOptions.FirstEvent, "--from-block", "f", "0", "Specify the starting block for event processing (default: 0)")

EnriqueL8 · 2024-11-19T13:57:05Z

internal/stacks/stack_manager.go

-		if err := s.patchFireFlyCoreConfigs(configDir, member, newConfig); err != nil {
-			return messages, err
-		}
+    if s.Stack.MultipartyEnabled {


Indentation looks odd

and not sure why code was removed to write to the state file her

EnriqueL8 · 2024-11-19T13:58:17Z

internal/stacks/stack_manager.go

-	for _, member := range s.Stack.Members {
-		orgConfig := s.blockchainProvider.GetOrgConfig(s.Stack, member)
-		newConfig.Namespaces.Predefined[0].DefaultKey = orgConfig.Key
-		if s.Stack.MultipartyEnabled {


we still need this MultipartyEnabled wrapping this section

EnriqueL8 · 2024-11-19T13:58:31Z

internal/stacks/stack_manager.go

-
-	for _, member := range s.Stack.Members {
-		orgConfig := s.blockchainProvider.GetOrgConfig(s.Stack, member)
-		newConfig.Namespaces.Predefined[0].DefaultKey = orgConfig.Key


need this key as well

internal/stacks/stack_manager.go

Signed-off-by: MKVEERENDRA <[email protected]>

MKVEERENDRA · 2024-11-22T13:38:15Z

I did what you said can you pls check out the commit

EnriqueL8

Quite a few comments, and see many problems with the structure of the code and the types. Please do add some tests and try this out. Keep the comments that were previously put in by other contributors when the logic has not changed.

EnriqueL8 · 2024-11-27T10:00:22Z

README.md

+When initializing a new stack, you can configure various options including:
+
+```
+--from-block      For multiparty networks only: specify the starting block for event processing. 


Should only work with remote-node-url as with the local chain that the CLI creates we want to start from 0

as it should point to when the contract was deployed - I'm more tempted for this to be --contract-block as you pass in the MultiParty Contract address through --contract

EnriqueL8 · 2024-11-27T10:23:32Z

README.md

+# Initialize with default settings (starts from block 0)
+ff init mystack
+
+# Initialize starting from the latest block
+ff init mystack --from-block newest
+
+# Initialize starting from a specific block number
+ff init mystack --from-block 1234567


I would make these examples to be with --emote-node-url set

EnriqueL8 · 2024-11-27T10:23:56Z

cmd/start.go

@@ -102,6 +102,9 @@ This command will start a stack and run it in the background.
 	},
 }

+
+// ... existing code ...


remove this

EnriqueL8 · 2024-11-27T10:24:36Z

internal/stacks/stack_manager.go

@@ -611,44 +610,44 @@ func (s *StackManager) createMember(id string, index int, options *types.InitOpt

 func (s *StackManager) StartStack(options *types.StartOptions) (messages []string, err error) {
 	fmt.Printf("starting FireFly stack '%s'... ", s.Stack.Name)
-	// Check to make sure all of our ports are available
+
+	// Check port availability


why the comment change?

EnriqueL8 · 2024-11-27T10:26:14Z

internal/stacks/stack_manager.go

@@ -864,7 +863,7 @@ func checkPortAvailable(port int) (bool, error) {
 }

 //nolint:gocyclo // TODO: Breaking this function apart would be great for code tidiness, but it's not an urgent priority
-func (s *StackManager) runFirstTimeSetup(options *types.StartOptions) (messages []string, err error) {
+func (s *StackManager) runFirstTimeSetup(options *types.InitOptions) (messages []string, err error) {


This should still be the StartOptions

EnriqueL8 · 2024-11-27T10:26:38Z

internal/stacks/stack_manager.go

-			// TODO: This code assumes that there is only one plugin instance per type. When we add support for
-			// multiple namespaces, this code will likely have to change a lot
 			s.Log.Info("deploying FireFly smart contracts")
 			contractDeploymentResult, err = s.blockchainProvider.DeployFireFlyContract()
 			if err != nil {
 				return messages, err
 			}
-			if contractDeploymentResult != nil {
-				if contractDeploymentResult.Message != "" {
-					messages = append(messages, contractDeploymentResult.Message)
-				}
-				s.Stack.State.DeployedContracts = append(s.Stack.State.DeployedContracts, contractDeploymentResult.DeployedContract)
-			}
-		}
-	}

-	for _, member := range s.Stack.Members {
-		orgConfig := s.blockchainProvider.GetOrgConfig(s.Stack, member)
-		newConfig.Namespaces.Predefined[0].DefaultKey = orgConfig.Key


As I mentioned in my previous review, keep this code as it was

EnriqueL8 · 2024-11-27T10:32:23Z

internal/stacks/stack_manager.go

+		setupMessages, err := s.runFirstTimeSetup(&types.InitOptions{
+			FromBlock: options.FromBlock,
+		})


FromBlock doesn't exist in InitOptions, it should be StartOptions. Getting errors in the IDE

Fix: Solve issue hyperledger#331 by adding FirstEvent support in Fire…

151290f

…Fly config Signed-off-by: MKVEERENDRA <[email protected]>

MKVEERENDRA force-pushed the fix-issue-331 branch from 99368a5 to 151290f Compare November 18, 2024 12:50

EnriqueL8 requested changes Nov 19, 2024

View reviewed changes

MKVEERENDRA and others added 2 commits November 21, 2024 17:00

Fix: Update configuration to use --from-block in init command

5f68d1b

Signed-off-by: MKVEERENDRA <[email protected]>

Update stack_manager.go

8bb34e1

Signed-off-by: MKVEERENDRA <[email protected]>

MKVEERENDRA requested a review from EnriqueL8 November 27, 2024 00:34

EnriqueL8 requested changes Nov 27, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix: Solve issue #331 by adding FirstEvent support in FireFly config #332

Fix: Solve issue #331 by adding FirstEvent support in FireFly config #332

MKVEERENDRA commented Nov 17, 2024

MKVEERENDRA commented Nov 17, 2024

EnriqueL8 Nov 19, 2024

EnriqueL8 Nov 19, 2024

EnriqueL8 Nov 19, 2024

EnriqueL8 Nov 19, 2024

EnriqueL8 Nov 19, 2024

MKVEERENDRA commented Nov 22, 2024

EnriqueL8 left a comment

EnriqueL8 Nov 27, 2024

EnriqueL8 Nov 27, 2024

EnriqueL8 Nov 27, 2024

EnriqueL8 Nov 27, 2024

EnriqueL8 Nov 27, 2024

EnriqueL8 Nov 27, 2024

EnriqueL8 Nov 27, 2024

EnriqueL8 Nov 27, 2024

	startCmd.Flags().StringVarP(&startOptions.FirstEvent, "first-event", "f", "0", "Specify the starting block for event processing (default: 0)")
	startCmd.Flags().StringVarP(&startOptions.FirstEvent, "--from-block", "f", "0", "Specify the starting block for event processing (default: 0)")

Fix: Solve issue #331 by adding FirstEvent support in FireFly config #332

Are you sure you want to change the base?

Fix: Solve issue #331 by adding FirstEvent support in FireFly config #332

Conversation

MKVEERENDRA commented Nov 17, 2024

MKVEERENDRA commented Nov 17, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MKVEERENDRA commented Nov 22, 2024

EnriqueL8 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment