search

Agoric / documentation

User documentation
https://agoric.com/documentation/
Apache License 2.0
15 stars 40 forks source link

Document _agstate folder #924

Closed LuqiPan closed 6 months ago

LuqiPan commented 7 months ago

_agstate and _agstate/agoric-servers folders are present in almost all dApps that I looked at, for example, https://github.com/Agoric/dapp-offer-up/tree/main/_agstate. However it's not clear to me, a developer new to Agoric platform, why _agstate is needed, especially considering it only contains a boilerplate package.json file.

This commit seems to suggest _agstate is here to make agoric install happy, but some explanation around why it's needed, what's its purpose, and when should a developer use it would be great!

dckc commented 6 months ago

It's a vestige of ag-solo / sim chain / beta architecture. @sufyaankhan has asked that we omit that stuff from the docs.

I presume it's OK to close this. Feel free to re-open it if that seems in order.

For reference, an earlier PR where I started flagging such stuff:

dckc commented 6 months ago

that reminds me: yarn create @agoric/dapp ... fails without an _agstate dir. That's the only reason dapp-offer-up has one. We should fix that:

LuqiPan commented 6 months ago

I think I tried to start up dapp-offer-up without the _agstate dir and I wasn't able to start the dapp, might be I did something dumb though.

dckc commented 6 months ago

Right; there are some vestigial things that break when _agstate is removed. https://github.com/Agoric/agoric-sdk/issues/8817 is about getting rid of those.