Merge branch 'main' into fix_cve

EnriqueL8 · web-flow · commit 46bcc9e11a3d · 2025-02-12T15:32:12.000Z
diff --git a/.github/workflows/docker_main.yml b/.github/workflows/docker_main.yml
@@ -8,12 +8,13 @@ on:
       - '.github/**' # exclude .github directory
       - '**.md' # exclude all markdown files
 
+permissions:
+  contents: read
+  packages: write
+
 jobs:
   docker:
     runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      packages: write
     steps:
       - uses: actions/checkout@v3
         with:
diff --git a/.github/workflows/docker_release.yml b/.github/workflows/docker_release.yml
@@ -4,13 +4,14 @@ on:
   release:
     types: [released, prereleased]
 
+permissions:
+  contents: read
+  packages: write
+
 jobs:
    
   docker:
     runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      packages: write
     steps:
       - uses: actions/checkout@v4
         with:
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -7,6 +7,10 @@ on:
   pull_request:
   release:
     types: [released]
+
+permissions:
+  contents: write
+
 jobs:
   build:
     runs-on: ubuntu-latest
diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml
@@ -2,7 +2,7 @@ name: Go
 
 on:
   push:
-    branches: [main]
+    branches: [main] 
     paths:
       - '**'  # include all files
       - '!.github/**' # exclude .github directory
@@ -18,6 +18,10 @@ on:
 
   workflow_dispatch:
 
+permissions:
+  contents: read
+  packages: write
+
 jobs:
   build:
     env:
diff --git a/.github/workflows/integration.yml b/.github/workflows/integration.yml
@@ -7,6 +7,9 @@ on:
     - cron: "0 0 * * *"
   workflow_dispatch:
 
+permissions:
+  contents: read
+
 jobs:
   e2e-test:
     runs-on: firefly-ubuntu-latest
diff --git a/.github/workflows/solidity.yml b/.github/workflows/solidity.yml
@@ -4,6 +4,10 @@ on:
   pull_request:
     branches: [main]
 
+permissions:
+  contents: read
+  packages: read
+
 jobs:
   solidity-test:
     runs-on: ubuntu-latest
diff --git a/README.md b/README.md
@@ -5,14 +5,14 @@
 [![FireFy Documentation](https://img.shields.io/static/v1?label=FireFly&message=documentation&color=informational)](https://hyperledger.github.io/firefly//)
 ![build](https://github.com/hyperledger/firefly/actions/workflows/docker_main.yml/badge.svg?branch=main)
 [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/7826/badge)](https://www.bestpractices.dev/projects/7826)
+[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/hyperledger/firefly/badge)](https://scorecard.dev/viewer/?uri=github.com/hyperledger/firefly)
 
 ![Hyperledger FireFly](./images/hyperledger_firefly_logo.png)
 
 Hyperledger FireFly is the first open source Supernode: a complete stack for enterprises to build and scale secure Web3 applications.
 
 The FireFly API for digital assets, data flows, and blockchain transactions makes it radically faster to build production-ready apps on popular chains and protocols.
 
-
 [ENGLISH](./README.md) | [简体中文](./README_zh_CN.md)
 
 ## Start using Hyperledger FireFly
@@ -61,35 +61,35 @@ Other repositories you might be interested in containing those microservice comp
 
 ### Blockchain connectivity
 
-- Transaction Manager - https://github.com/hyperledger/firefly-transaction-manager
-- RLP & ABI encoding, KeystoreV3 utilities and secp256k1 signer runtime -  https://github.com/hyperledger/firefly-signer
-- FFCAPI reference connector for EVM Chains - https://github.com/hyperledger/firefly-evmconnect
+- Transaction Manager - <https://github.com/hyperledger/firefly-transaction-manager>
+- RLP & ABI encoding, KeystoreV3 utilities and secp256k1 signer runtime -  <https://github.com/hyperledger/firefly-signer>
+- FFCAPI reference connector for EVM Chains - <https://github.com/hyperledger/firefly-evmconnect>
   - Public EVM compatible chains: Learn more in the [documentation](https://hyperledger.github.io/firefly)
-- Permissioned Ethereum connector - https://github.com/hyperledger/firefly-ethconnect
+- Permissioned Ethereum connector - <https://github.com/hyperledger/firefly-ethconnect>
   - Private/permissioned: Hyperledger Besu / Quorum
-- Hyperledger Fabric connector - https://github.com/hyperledger/firefly-fabconnect
-- Tezos connector - https://github.com/hyperledger/firefly-tezosconnect
-- Corda connector starter: https://github.com/hyperledger/firefly-cordaconnect
+- Hyperledger Fabric connector - <https://github.com/hyperledger/firefly-fabconnect>
+- Tezos connector - <https://github.com/hyperledger/firefly-tezosconnect>
+- Corda connector starter: <https://github.com/hyperledger/firefly-cordaconnect>
   - CorDapp specific customization is required
 
 ### Token standards
 
-- Tokens ERC20/ERC721 - https://github.com/hyperledger/firefly-tokens-erc20-erc721
-- Tokens ERC1155 - https://github.com/hyperledger/firefly-tokens-erc1155
+- Tokens ERC20/ERC721 - <https://github.com/hyperledger/firefly-tokens-erc20-erc721>
+- Tokens ERC1155 - <https://github.com/hyperledger/firefly-tokens-erc1155>
 
 ### Private data bus connectivity
 
-- HTTPS Data Exchange - https://github.com/hyperledger/firefly-dataexchange-https
+- HTTPS Data Exchange - <https://github.com/hyperledger/firefly-dataexchange-https>
 
 ### Developer ecosystem
 
-- Command Line Interface (CLI) - https://github.com/hyperledger/firefly-cli
-- Explorer UI - https://github.com/hyperledger/firefly-ui
-- Node.js SDK - https://github.com/hyperledger/firefly-sdk-nodejs
-- Sandbox / Exerciser - https://github.com/hyperledger/firefly-sandbox
-- Samples - https://github.com/hyperledger/firefly-samples
-- FireFly Performance CLI: https://github.com/hyperledger/firefly-perf-cli
-- Helm Charts for Deploying to Kubernetes: https://github.com/hyperledger/firefly-helm-charts
+- Command Line Interface (CLI) - <https://github.com/hyperledger/firefly-cli>
+- Explorer UI - <https://github.com/hyperledger/firefly-ui>
+- Node.js SDK - <https://github.com/hyperledger/firefly-sdk-nodejs>
+- Sandbox / Exerciser - <https://github.com/hyperledger/firefly-sandbox>
+- Samples - <https://github.com/hyperledger/firefly-samples>
+- FireFly Performance CLI: <https://github.com/hyperledger/firefly-perf-cli>
+- Helm Charts for Deploying to Kubernetes: <https://github.com/hyperledger/firefly-helm-charts>
 
 ## FireFly Core code hierarchy
 
diff --git a/README_zh_CN.md b/README_zh_CN.md
@@ -5,6 +5,7 @@
 [![FireFy Documentation](https://img.shields.io/static/v1?label=FireFly&message=documentation&color=informational)](https://hyperledger.github.io/firefly//)
 ![build](https://github.com/hyperledger/firefly/actions/workflows/docker_main.yml/badge.svg?branch=main)
 [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/7826/badge)](https://www.bestpractices.dev/projects/7826)
+[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/hyperledger/firefly/badge)](https://scorecard.dev/viewer/?uri=github.com/hyperledger/firefly)
 
 ![Hyperledger FireFly](./images/hyperledger_firefly_logo.png)
 
diff --git a/doc-site/docs/reference/firefly_interface_format.md b/doc-site/docs/reference/firefly_interface_format.md
@@ -98,7 +98,7 @@ For example, the Ethereum plugin always needs to know what Solidity type the fie
 
 ## Automated generation of FireFly Interfaces
 
-A convenience endpoint exists on the API to facilitate converting from native blockchain interface formats such as an Ethereum ABI to the FireFly Interface format. For details, please see the <a href="/swagger/#/Default%20Namespace/postGenerateContractInterface" data-proofer-ignore>API documentation for the contract interface generation endpoint</a>.
+A convenience endpoint exists on the API to facilitate converting from native blockchain interface formats such as an Ethereum ABI to the FireFly Interface format. For details, please see the <a href="../../swagger/#/Default%20Namespace/postGenerateContractInterface" data-proofer-ignore>API documentation for the contract interface generation endpoint</a>.
 
 For an example of using this endpoint with a specific Ethereum contract, please see the [Tutorial to Work with custom smart contracts](../tutorials/custom_contracts/index.md).
 
diff --git a/doc-site/docs/tutorials/broadcast_data.md b/doc-site/docs/tutorials/broadcast_data.md
@@ -20,7 +20,7 @@ title: Broadcast data
 ## Additional info
 
 - Key Concepts: [Broadcast / shared data](../overview/multiparty/broadcast.md)
-- Swagger Reference: <a href="/swagger/#/Default%20Namespace/postNewMessageBroadcast" data-proofer-ignore>POST /api/v1/namespaces/{ns}/messages/broadcast</a>
+- Swagger Reference: <a href="../../swagger/#/Default%20Namespace/postNewMessageBroadcast" data-proofer-ignore>POST /api/v1/namespaces/{ns}/messages/broadcast</a>
 
 ## Example 1: Inline string data
 
diff --git a/doc-site/docs/tutorials/create_custom_identity.md b/doc-site/docs/tutorials/create_custom_identity.md
@@ -11,7 +11,7 @@ Out of the box, a FireFly Supernode contains both an `org` and a `node` identity
 ## Additional info
 
 - Reference: [Identities](../reference/identities.md)
-- Swagger: <a href="/swagger/#/Default%20Namespace/postNewIdentity" data-proofer-ignore>POST /api/v1/identities</a>
+- Swagger: <a href="../../swagger/#/Default%20Namespace/postNewIdentity" data-proofer-ignore>POST /api/v1/identities</a>
 
 ## Previous steps: Start your environment
 
diff --git a/doc-site/docs/tutorials/define_datatype.md b/doc-site/docs/tutorials/define_datatype.md
@@ -20,7 +20,7 @@ of datatypes, as is used to broadcast the data itself.
 ## Additional info
 
 - Key Concepts: [Broadcast / shared data](../overview/multiparty/broadcast.md)
-- Swagger: <a href="/swagger/#/Default%20Namespace/postNewDatatype" data-proofer-ignore>POST /api/v1/namespaces/{ns}/datatypes</a>
+- Swagger: <a href="../../swagger/#/Default%20Namespace/postNewDatatype" data-proofer-ignore>POST /api/v1/namespaces/{ns}/datatypes</a>
 
 ### Example 1: Broadcast new datatype
 
diff --git a/doc-site/docs/tutorials/private_send.md b/doc-site/docs/tutorials/private_send.md
@@ -37,7 +37,7 @@ title: Privately send data
 ## Additional info
 
 - Key Concepts: [Private data exchange](../overview/multiparty/data_exchange.md)
-- Swagger: <a href="/swagger/#/Default%20Namespace/postNewMessagePrivate" data-proofer-ignore>POST /api/v1/namespaces/{ns}/messages/private</a>
+- Swagger: <a href="../../swagger/#/Default%20Namespace/postNewMessagePrivate" data-proofer-ignore>POST /api/v1/namespaces/{ns}/messages/private</a>
 
 ## Example 1: Pinned private send of in-line string data
 
diff --git a/doc-site/docs/tutorials/query_messages.md b/doc-site/docs/tutorials/query_messages.md
@@ -17,7 +17,7 @@ This builds on the APIs to query and filter messages, described below
 ## Additional info
 
 - Reference: [API Query Syntax](../reference/api_query_syntax.md)
-- Swagger: <a href="/swagger/#/Default%20Namespace/getMsgs" data-proofer-ignore>GET /api/v1/namespaces/{ns}/messages</a>
+- Swagger: <a href="../../swagger/#/Default%20Namespace/getMsgs" data-proofer-ignore>GET /api/v1/namespaces/{ns}/messages</a>
 
 ### Example 1: Query confirmed messages
 
diff --git a/internal/database/sqlcommon/provider_sqlitego_test.go b/internal/database/sqlcommon/provider_sqlitego_test.go
@@ -46,7 +46,7 @@ type sqliteGoTestProvider struct {
 	capabilities *database.Capabilities
 }
 
-// newTestProvider creates a real in-memory database provider for e2e testing
+// newSQLiteTestProvider creates a real in-memory database provider for e2e testing
 func newSQLiteTestProvider(t *testing.T) (*sqliteGoTestProvider, func()) {
 	conf := config.RootSection("unittest.db")
 	conf.AddKnownKey("url", "test")
diff --git a/internal/identity/identitymanager.go b/internal/identity/identitymanager.go
@@ -201,7 +201,7 @@ func (im *identityManager) ResolveInputVerifierRef(ctx context.Context, inputKey
 	}, nil
 }
 
-// ResolveInputIdentity takes in blockchain signing input information from an API call (which may
+// ResolveInputSigningIdentity takes in blockchain signing input information from an API call (which may
 // include author or key or both), and updates it with fully resolved and normalized values
 func (im *identityManager) ResolveInputSigningIdentity(ctx context.Context, signerRef *core.SignerRef) (err error) {
 	log.L(ctx).Debugf("Resolving identity input: key='%s' author='%s'", signerRef.Key, signerRef.Author)
diff --git a/internal/txcommon/txcommon.go b/internal/txcommon/txcommon.go
@@ -146,7 +146,7 @@ func (t *transactionHelper) SubmitNewTransaction(ctx context.Context, txType cor
 	return tx.ID, nil
 }
 
-// SubmitTransactionBatch is called to do a batch insertion of a set of transactions, and returns an array of the transaction
+// SubmitNewTransactionBatch is called to do a batch insertion of a set of transactions, and returns an array of the transaction
 // result. Each is either a transaction, or an idempotency failure. The overall action fails for DB errors other than idempotency.
 func (t *transactionHelper) SubmitNewTransactionBatch(ctx context.Context, namespace string, batch []*BatchedTransactionInsert) error {
 
