Skip to content

feat(satp-hermes): improve satp gateway configuration object #4013

@RafaelAPB

Description

@RafaelAPB

Is your feature request related to a problem? Please describe.
The SATP gateway config object needs better documentation and examples.

General improvements needed

The configuration needs to be revisited according to recent codebase changes due to inconsistencies accrued during the refactoring.
This ticket needs to address the following improvements:

GID configuration

  • The gid object in the configuration defines a pubKey field that serves as one of the identification points for counterparty gateways. This field should be refactored into an object IdentificationCredentials - should contain 1) supported signature algorithms (array), "RSA-3072", and "EDCSA- P-256", field called "SigningAlgorithm", 2) pubKey corresponding to the private key of the gateway (generated using algorithm in SigningAlgorithm.

Bridge configuration

An example of a current bridge configuration:

 "bridgeConfig": [
    {
        "networkIdentification": {
        "id": "BesuTestNetwork1",
        "ledgerType": "BESU_2X"
        },
        "signingCredential": {
        "ethAccount": "0xfe3b557e8fb62b89f4916b721be55ceb828dbd73",
        "secret": "0x8f2a55949038a9610f50fb23b5883af3b4ecb3c3bb792cbcefbd1542c692be63",
        "type": "PRIVATE_KEY_HEX"
        },
        "gas": "6721975",
        "gasConfig": {
        "gas": "6721975",
        "gasPrice": "20000000000"
        },
        "connectorOptions": {
        "rpcApiHttpHost": "http://besu-node-rpc-1.besu-1:8545",
        "rpcApiWsHost": "ws://besu-node-rpc-1.besu-1:8546"
        },
        "claimFormats": [
        1
        ]

Issues:

  1. ethAccount defines the owner of the SATP bridge. The name of the parameter should be clearer
  2. gas and gasConfig.gas are repeated: we should only have one instance of a gas limit (in the gasConfig object).
  3. gas should be rename "gasLimit"

Describe the solution you'd like
-A short report on what what was added/removed from the configuration (i.e., a changelog)
-An example directory with configuration examples (must be valid and work). Work started on this: #4012. Please extend this work.
-Extensive documentation of the SATP configuration object

Metadata

Metadata

Assignees

No one assigned

    Labels

    IETF-SATP-HermesRelated to the Secure Asset Transfer Protocol as defined by the Internet Engineering Task Force.P2Priority 2: HighSPIKEExploratory work to better scope additional effortdocumentationImprovements or additions to documentationenhancementNew feature or request

    Type

    Projects

    Status

    Ready

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions