-
Notifications
You must be signed in to change notification settings - Fork 206
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
Remove orchestrator.makeLocalAccount
which is basically a shortcut for orchestrator.getChain("agoric").makeAccount()
#10106
Comments
We seem to have API reference docs that include this method: So please add a PR or issue or whatever to remove it there too. |
Also, the latter is to be used in place of the former, the jsdoc needs updating because it says "remote chain": /**
* Creates a new account on the remote chain.
* @returns an object that controls a new remote account on Chain
*/
makeAccount: () => Promise<OrchestrationAccount<CI>>; |
closes: #10106 ## Description There doesn't seem to be a motivating use case for exposing a maker for a low-level `LocalChainAccount` in the `Orchestrator`, so lets remove it to avoid misdirection. Instead, consumers can call `orch.getChain('agoric').then(c => c.makeAccount())` to get a `LocalOrchestrationAccount`. ### Security Considerations n/a ### Scaling Considerations n/a ### Documentation Considerations docs.agoric.com already reflects this: Agoric/documentation#1208 (comment) ### Testing Considerations Removing code, so existing tests suffice ### Upgrade Considerations Library code that will go out in a NPM Orch Release
What is the Problem Being Solved?
orchestrator.makeLocalAccount
is basically a shortcut fororchestrator.getChain("agoric").makeAccount()
. While potentially helpful, this helper/shortcut can confuse a developer by creating multiple ways to accomplish the same task.Description of the Design
I intend to remove the public facet method and use compilation/testing to verify that all vestiges, callers, and related examples are gone.
Security Considerations
None. This is removing code that doesn't uphold any interesting security property. All the same functionality is still available to contract devs - just through a slightly modified bit of code.
Scaling Considerations
None.
Test Plan
Red code. If all tests continue to pass we're solid.
Upgrade Considerations
None. This isn't upgrading/changing something live on chain.
The text was updated successfully, but these errors were encountered: