Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: normalize chain info #10109

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Conversation

0xpatrickdev
Copy link
Member

closes: #9807

Description

Normalizes chain info for agoricNames:

  • counterParty -> counterparty
  • prefer camelCase to snake_case for JS conventions
  • prefer flattened counterparty fields (counterpartyConnectionId)

Security Considerations

n/a

Scaling Considerations

n/a

Documentation Considerations

n/a

Testing Considerations

Existing tests updated as this is just a rename.

Upgrade Considerations

Will require a proposal to update this data if this doesn't land in u17

- counterParty -> counterparty
- prefer camelCase to snake_case for JS conventions
- prefer flattened counterparty fields (counterpartyConnectionId)
Copy link

Deploying agoric-sdk with  Cloudflare Pages  Cloudflare Pages

Latest commit: 98e4e9b
Status: ✅  Deploy successful!
Preview URL: https://3ddb5c92.agoric-sdk.pages.dev
Branch Preview URL: https://9807-normalize-chain-info.agoric-sdk.pages.dev

View logs

@0xpatrickdev 0xpatrickdev added the force:integration Force integration tests to run on PR label Sep 18, 2024
Copy link
Member

@dckc dckc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For asset info, I think consistency with the chain registry is more important than JS norms.

denom_units: [
denomUnits: [
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was sourced from the chain registry. I don't think it's cost-effective to be different.

https://github.com/cosmos/chain-registry/blob/89fe1c12a085b7b128a181118c9600e781363168/cosmoshub/assetlist.json#L8

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

never mind.

looks like we're already tweaking such names.

      portId: channelFrom.port_id,

https://github.com/Agoric/agoric-sdk/blob/master/packages/orchestration/src/utils/registry.js#L68C1-L68C35

Copy link
Member

@dckc dckc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's definitely fix counterParty ASAP

mergify bot added a commit that referenced this pull request Sep 18, 2024
_incidental_

## Description
We don't have a good design yet for the schema of Orchestration chain info in agoricNames,
- #10109

It's not necessary for upgrade-17 so save it for another proposal.

### Security Considerations
none

### Scaling Considerations
none

### Documentation Considerations
SDK still registers the info so the development experience doesn't differ.

### Testing Considerations
Shouldn't break any existing tests.

### Upgrade Considerations
Not yet deployed. Should be part of u17-rc1.
@0xpatrickdev 0xpatrickdev marked this pull request as draft September 18, 2024 22:44
gibson042 pushed a commit that referenced this pull request Sep 19, 2024
_incidental_

## Description
We don't have a good design yet for the schema of Orchestration chain info in agoricNames,
- #10109

It's not necessary for upgrade-17 so save it for another proposal.

### Security Considerations
none

### Scaling Considerations
none

### Documentation Considerations
SDK still registers the info so the development experience doesn't differ.

### Testing Considerations
Shouldn't break any existing tests.

### Upgrade Considerations
Not yet deployed. Should be part of u17-rc1.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
force:integration Force integration tests to run on PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

normalize (cosmos) ChainInfo schema
2 participants