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

new contracts package, including internal's test utils and Zoe's contractSupport #7392

Open
turadg opened this issue Apr 12, 2023 · 3 comments · May be fixed by #7399
Open

new contracts package, including internal's test utils and Zoe's contractSupport #7392

turadg opened this issue Apr 12, 2023 · 3 comments · May be fixed by #7399
Assignees
Labels
code-style defensive correctness patterns; readability thru consistency devex developer experience enhancement New feature or request vaults_triage DO NOT USE Zoe Contract Contracts within Zoe Zoe package: Zoe

Comments

@turadg
Copy link
Member

turadg commented Apr 12, 2023

What is the Problem Being Solved?

There's a growing number of deep imports of @agoric/zoe/src/contractSupport/index.js. We try to avoid deep imports and these ones are so longer they affect readability and line wrapping.

Description of the Design

Move that directory into a new package so they're package-level imports.

Package name: @agoric/contracts. Of course contracts exist in other packages but this is implied to be "SDK for contracts" and the package description will specify: "utilities and sample contracts to support contract development".

Thus the scope will include putting example contracts in the same package: #1656

Security Considerations

Scaling Considerations

Test Plan

@turadg turadg added enhancement New feature or request Zoe package: Zoe Zoe Contract Contracts within Zoe code-style defensive correctness patterns; readability thru consistency devex developer experience labels Apr 12, 2023
@erights
Copy link
Member

erights commented Apr 12, 2023

Please not @agoric/support if it remains specific to contracts. How about @agoric/contract-support?

Or, how about @agoric/support and it is not specific to contracts? I suppose it already kinda isn't.

@Chris-Hibbert
Copy link
Contributor

Or move the contracts, too, and call it @agoric/contracts? The contracts need to be moved out of Zoe anyway.

@turadg turadg linked a pull request Apr 12, 2023 that will close this issue
2 tasks
@ivanlei ivanlei added the vaults_triage DO NOT USE label Apr 27, 2023
@turadg
Copy link
Member Author

turadg commented Sep 20, 2023

Bumping this up because the versioning of the helpers within the Zoe vat package caused some problems.

For now the client can copy the desired version of contractSupport function instead of importing it. But in the future the client supports should be versioned independently of the backend.

@turadg turadg assigned turadg and unassigned iomekam Dec 8, 2023
@turadg turadg changed the title move Zoe contractSupport into its own package new contracts package, including internal's test utils and Zoe's contractSupport Feb 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code-style defensive correctness patterns; readability thru consistency devex developer experience enhancement New feature or request vaults_triage DO NOT USE Zoe Contract Contracts within Zoe Zoe package: Zoe
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants