search

Agoric / agoric-sdk

monorepo for the Agoric Javascript smart contract platform
Apache License 2.0
326 stars 206 forks source link

Remove `orchestrator.makeLocalAccount` which is basically a shortcut for `orchestrator.getChain("agoric").makeAccount()` #10106

Open ivanlei opened 1 day ago

ivanlei commented 1 day ago

What is the Problem Being Solved?

orchestrator.makeLocalAccount is basically a shortcut for orchestrator.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.

dckc commented 1 day ago

We seem to have API reference docs that include this method: https://docs.agoric.com/guides/orchestration/getting-started/api.html#makelocalaccount

So please add a PR or issue or whatever to remove it there too. Maybe just get rid of that whole page in favor of the @agoric/orchestration package reference docs?