Feat: Support Selectable Write Ledger #2339

shaangill025 · 2023-07-21T15:57:24Z

resolve multi-ledger write failure on register-nym #2168

esune

I like how the changes generalize how we handle the configured ledgers and open the door to -potentially - having more than one ledger set to write mode in the future.

I am wondering though if, given the current assumption that there will only ever be one write ledger active at any given time (and there is no way to specify which ledger to target when creating a transaction that needs to be written, as far as I know), we should keep some checks to prevent users from having more than one writeable ledger at the same time.

esune · 2023-07-21T18:48:30Z

aries_cloudagent/config/ledger.py

-        if is_write_ledger and write_ledger_set:
-            raise ConfigError("Only a single ledger can be is_write")
-        elif is_write_ledger:
+        if is_write_ledger:


Is this change going to cause issues with single-tenant agents being able to declare more than one write ledger in the config file? I believe currently the assumption is that there only ever is one "write" ledger at any given time.

The meaning of is_write has changed with this PR. For example:

- id: localVON is_production: false genesis_url: 'http://host.docker.internal:9000/genesis' - id: bcorvinTest is_production: true is_write: true genesis_url: 'http://test.bcovrin.vonx.io/genesis' - id: greenlightDev is_production: true is_write: true genesis_url: 'http://dev.greenlight.bcovrin.vonx.io/genesis'

is_write property means that the ledger is write configurable. With reference to the above config example, both bcorvinTest and greenlightDev ledgers are write configurable. By default, on startup bcorvinTest will be the write ledger as it is the topmost write configurable production ledger. Using PUT /ledger/{ledger_id}/set-write-ledger endpoint, either greenlightDev and bcorvinTest can be set as the write ledger.

aries_cloudagent/ledger/multiple_ledger/indy_manager.py

aries_cloudagent/ledger/multiple_ledger/indy_vdr_manager.py

esune · 2023-07-21T20:44:54Z

aries_cloudagent/ledger/routes.py

                "/ledger/multiple/get-write-ledger", get_write_ledger, allow_head=False
            ),
+            web.put("/ledger/multiple/{ledger_id}/set-write-ledger", set_write_ledger),
+            web.get(
+                "/ledger/multiple/get-write-ledgers",
+                get_write_ledgers,
+                allow_head=False,
+            ),
            web.get("/ledger/multiple/config", get_ledger_config, allow_head=False),
        ]
    )


Do we really need the /multiple/ path added? Whether the agent is connected to one ledger or more than one, I think the endpoints should still return information. The ledger_id can be used as path parameter where the operation requires one ledger instance to be identified.

/multiple/ has been removed. In case, multi-ledger config is not provided and single-ledger is applicable then the endpoint's response will return ledger_id as default. This is not applicable for GET /ledger/config, it will return a Multiple ledger support not enabled error.

Signed-off-by: Shaanjot Gill <[email protected]>

esune

Great work @shaangill025 , this looks good!
@andrewwhitehead , @dbluhm and @usingtechnology could you please take a look and confirm I did not miss somethign important?

aries_cloudagent/indy/sdk/profile.py

Signed-off-by: Shaanjot Gill <[email protected]>

usingtechnology

Spelling in documentation (bcorvinTest -> bcovrinTest) to update.

I have a bigger question... I don't see anything about multitenancy? Is that coming later? I would assume that each tenant could potentially write to a different ledger.

Multiledger.md

esune · 2023-07-28T17:43:38Z

I have a bigger question... I don't see anything about multitenancy? Is that coming later? I would assume that each tenant could potentially write to a different ledger.

I believe /ledger/{ledger_id}/set-write-ledger would be used by each tenant to set which ledger they want to write to.

shaangill025 · 2023-07-28T17:48:47Z

I have a bigger question... I don't see anything about multitenancy? Is that coming later? I would assume that each tenant could potentially write to a different ledger.

I believe /ledger/{ledger_id}/set-write-ledger would be used by each tenant to set which ledger they want to write to.

There will be a default write ledger set based on the multi-ledger config provided for all tenants. The tenants can then use the above endpoint to set different write ledger.

usingtechnology · 2023-07-28T17:51:29Z

Thanks @shaangill025 and @esune. Is that tenant selection permanent? Maybe I am missing something, but it appears that the selection isn't persisted.

Signed-off-by: Shaanjot Gill <[email protected]>

shaangill025 · 2023-07-28T17:57:49Z

Thanks @shaangill025 and @esune. Is that tenant selection permanent? Maybe I am missing something, but it appears that the selection isn't persisted.

It should be, it basically binds BaseLedger instance based upon selection to the Tenant profile.

Signed-off-by: Shaanjot Gill <[email protected]>

…t-python into multi_ledger_write

shaangill025 · 2023-07-31T20:20:36Z

@usingtechnology Tenant write ledger selection persistence should be working now.

sonarqubecloud · 2023-08-02T16:33:54Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

shaangill025 requested a review from esune July 21, 2023 15:57

esune reviewed Jul 21, 2023

View reviewed changes

shaangill025 force-pushed the multi_ledger_write branch from ecb8be6 to 3e15149 Compare July 24, 2023 21:27

dbluhm added this to the Version 0.10.0 milestone Jul 25, 2023

shaangill025 marked this pull request as ready for review July 25, 2023 20:30

esune mentioned this pull request Jul 25, 2023

multi-ledger write failure on register-nym #2168

Closed

shaangill025 added 4 commits July 27, 2023 06:55

initial impl for selectable write ledger

d83bae3

Signed-off-by: Shaanjot Gill <[email protected]>

additional changes

6367169

Signed-off-by: Shaanjot Gill <[email protected]>

doc + endpoint update

f7966e5

Signed-off-by: Shaanjot Gill <[email protected]>

endorser info in multi ledger config + tests

f9bb910

Signed-off-by: Shaanjot Gill <[email protected]>

shaangill025 force-pushed the multi_ledger_write branch from 8c86657 to f9bb910 Compare July 27, 2023 14:05

doc update

8d3daa7

Signed-off-by: Shaanjot Gill <[email protected]>

esune previously approved these changes Jul 27, 2023

View reviewed changes

dbluhm previously approved these changes Jul 28, 2023

View reviewed changes

aries_cloudagent/indy/sdk/profile.py Outdated Show resolved Hide resolved

extract common profile code into ml utility

bcb1e4d

Signed-off-by: Shaanjot Gill <[email protected]>

shaangill025 dismissed stale reviews from dbluhm and esune via bcb1e4d July 28, 2023 16:03

dbluhm previously approved these changes Jul 28, 2023

View reviewed changes

usingtechnology previously approved these changes Jul 28, 2023

View reviewed changes

Multiledger.md Outdated Show resolved Hide resolved

Multiledger.md Outdated Show resolved Hide resolved

bcovrin typo fix

4f1637b

Signed-off-by: Shaanjot Gill <[email protected]>

shaangill025 dismissed stale reviews from usingtechnology and dbluhm via 4f1637b July 28, 2023 17:53

shaangill025 added 2 commits July 31, 2023 13:16

write ldger persistence in multitenant mode

7580a35

Signed-off-by: Shaanjot Gill <[email protected]>

Merge branch 'main' of https://github.com/hyperledger/aries-cloudagen…

4805259

…t-python into multi_ledger_write

Merge branch 'main' into multi_ledger_write

071a969

dbluhm approved these changes Aug 2, 2023

View reviewed changes

dbluhm enabled auto-merge August 2, 2023 16:34

dbluhm merged commit a71c12b into openwallet-foundation:main Aug 2, 2023

usingtechnology mentioned this pull request Aug 2, 2023

Multitenant check endorser_info before saving #2395

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat: Support Selectable Write Ledger #2339

Feat: Support Selectable Write Ledger #2339

shaangill025 commented Jul 21, 2023 •

edited

Loading

esune left a comment

esune Jul 21, 2023

shaangill025 Jul 24, 2023

esune Jul 21, 2023

shaangill025 Jul 24, 2023

esune left a comment

usingtechnology left a comment

esune commented Jul 28, 2023

shaangill025 commented Jul 28, 2023

usingtechnology commented Jul 28, 2023

shaangill025 commented Jul 28, 2023 •

edited

Loading

shaangill025 commented Jul 31, 2023

sonarqubecloud bot commented Aug 2, 2023

Feat: Support Selectable Write Ledger #2339

Feat: Support Selectable Write Ledger #2339

Conversation

shaangill025 commented Jul 21, 2023 • edited Loading

esune left a comment

Choose a reason for hiding this comment

esune Jul 21, 2023

Choose a reason for hiding this comment

shaangill025 Jul 24, 2023

Choose a reason for hiding this comment

esune Jul 21, 2023

Choose a reason for hiding this comment

shaangill025 Jul 24, 2023

Choose a reason for hiding this comment

esune left a comment

Choose a reason for hiding this comment

usingtechnology left a comment

Choose a reason for hiding this comment

esune commented Jul 28, 2023

shaangill025 commented Jul 28, 2023

usingtechnology commented Jul 28, 2023

shaangill025 commented Jul 28, 2023 • edited Loading

shaangill025 commented Jul 31, 2023

sonarqubecloud bot commented Aug 2, 2023

shaangill025 commented Jul 21, 2023 •

edited

Loading

shaangill025 commented Jul 28, 2023 •

edited

Loading