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

refactor clientSupport to not depend on agoric-cli package #7824

Merged
merged 8 commits into from
Jun 22, 2023

Conversation

turadg
Copy link
Member

@turadg turadg commented May 22, 2023

refs: #4645

Description

^^

Security Considerations

Scaling Considerations

Documentation Considerations

Testing Considerations

@turadg turadg requested a review from dckc May 22, 2023 20:51
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.

The change looks plausible in most ways, but I see what looks like a couple breaking changes that aren't sufficiently documented.

I'm reluctant to approve anything at this point without an explicit compatibility note (as the template suggests under Documentation Considerations).

* @param {(msg: string) => Error} makeError error constructor
* @returns {(a: string) => Amount<'nat'>}
*/
export const makeParseAmount =
Copy link
Member

Choose a reason for hiding this comment

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

removing this export is a breaking change to the @agoric package, right?

Copy link
Member Author

Choose a reason for hiding this comment

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

No, the Agoric CLI is a UI tool and no exports are supported.

Copy link
Member

Choose a reason for hiding this comment

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

A couple things could make that more clear:

  • something in the README.md
  • in package.json, something like "exports": []

The the README has a bunch of stuff about running an IBC relayer that seems out of place in contexts such as https://www.npmjs.com/package/agoric

packages/inter-protocol/src/clientSupport.js Show resolved Hide resolved
@turadg turadg force-pushed the ta/refactor-clientSupport branch from d7a6de8 to 4e63f72 Compare May 29, 2023 19:16
@turadg turadg requested a review from dckc May 29, 2023 19:24
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.

I'd prefer that the agoric package were explicit about not exporting anything

packages/inter-protocol/src/clientSupport.js Outdated Show resolved Hide resolved
* @param {(msg: string) => Error} makeError error constructor
* @returns {(a: string) => Amount<'nat'>}
*/
export const makeParseAmount =
Copy link
Member

Choose a reason for hiding this comment

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

A couple things could make that more clear:

  • something in the README.md
  • in package.json, something like "exports": []

The the README has a bunch of stuff about running an IBC relayer that seems out of place in contexts such as https://www.npmjs.com/package/agoric

@turadg turadg force-pushed the ta/refactor-clientSupport branch 5 times, most recently from 11ab3cb to 9246f8e Compare June 19, 2023 15:45
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.

looks good.

@turadg turadg force-pushed the ta/refactor-clientSupport branch from 9246f8e to cf76198 Compare June 22, 2023 19:18
"./lib/helpers.js": "./lib/helpers.js",
"./src/helpers.js": "./src/helpers.js"
Copy link
Member

Choose a reason for hiding this comment

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

The lib variant no longer exists. It's only referenced by the loadgen for compat with older SDK revisions.

Suggested change
"./lib/helpers.js": "./lib/helpers.js",
"./src/helpers.js": "./src/helpers.js"
"./src/helpers.js": "./src/helpers.js"

@turadg turadg force-pushed the ta/refactor-clientSupport branch from cf76198 to d089675 Compare June 22, 2023 20:19
@turadg turadg enabled auto-merge June 22, 2023 20:19
@turadg turadg added this pull request to the merge queue Jun 22, 2023
Merged via the queue into master with commit 7632299 Jun 22, 2023
@turadg turadg deleted the ta/refactor-clientSupport branch June 22, 2023 21:06
mhofman pushed a commit that referenced this pull request Aug 7, 2023
refactor clientSupport to not depend on agoric-cli package
mhofman pushed a commit that referenced this pull request Dec 6, 2023
refactor clientSupport to not depend on agoric-cli package
@toliaqat
Copy link
Contributor

toliaqat commented Dec 7, 2023

fixes #8281

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants