Adding a Box Describing VStorage as readonly Contract State Query #1256
Conversation
Deploying documentation with
|
| Latest commit: |
7f50eb6
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://05251ca3.documentation-7tp.pages.dev |
| Branch Preview URL: | https://ms-vstorage-as-readonly-api.documentation-7tp.pages.dev |
|
Cloudflare deployment logs are available here |
| the Agoric chain does not offer such direct readonly APIs for querying contract state. Instead, the Agoric | ||
| platform achieves this functionality through a powerful feature called VStorage. |
There was a problem hiding this comment.
editorial: starting with "Agoric does not offer X" feels weird.
and "a powerful feature" seems like bravado that I wouldn't expect in docs.
Maybe move the ethereum stuff to the end of this box? "This contract state query mechanism provides much of the funcionality of ethereum readonly or view query APIs." I dunno.
There was a problem hiding this comment.
@dckc I agree but I am a bit at loss regarding how to start this box - would appreciate any idea s.
There was a problem hiding this comment.
maybe:
To expose contract state for query, where smart contracts on Ethereum and other chains use readonly or view query methods, Agoric smart contracts write to storage nodes so that clients can query them.
| API on other blockchains. It is completely cost-free, meaning developers and users can fetch data | ||
| from VStorage without incurring any fees. |
There was a problem hiding this comment.
While we don't have a vstorage-specific cost-recovery mechanism in place, there is a cost to the validators and such to store the data. For mainnet 2, we manually verify that the cost of storage used by contracts is paid for somehow. For example, in Inter Protocol, there's a charge to open a vault and to keep it open.
As to fetching the data, operating an RPC server also has a cost. It's typically not born directly by developers or users, but there's no particular guarantee of availability. Rate limiting is typically used to keep the cost manageable, for example.
It's worth saying that fetching data does not incur the cost of a blockchain transaction. But "completely cost-free" over-states the case.
|
|
||
| For instace, if a smart contract manages educational records, it can publish any relevant information | ||
| to VStorage through a `chainStorage` API, and anyone can query this data to verify the authenticity of | ||
| the records. This approach is illustrated in the [dapp-ed-cert. |
There was a problem hiding this comment.
dapp-ed-cert link seems incomplete.
There was a problem hiding this comment.
It would be nice to have a small snippet of code inline here.
There was a problem hiding this comment.
Regarding the snippet, I am not sure at this point. ATM dapp-ed-cert using E(), as in:
const edCertNode = E(certificateDataRoot).makeChildNode(edCert.certificateId);
await E(edCertNode).setValue(JSON.stringify(edCert));I would rather add the snippet later after I have fixed it.
| Agoric’s approach replaces direct readonly APIs with a public and cost-free vstorage mechanism, | ||
| enabling developers to create dynamic and responsive dApps while keeping the blockchain interactions | ||
| efficient and economical. |
There was a problem hiding this comment.
"economical" is good, but again, "cost-free" is too far.
amessbee
force-pushed
the
ms/vstorage-as-readonly-API
branch
from
44d68ae to
1479a31
Compare
amessbee
force-pushed
the
ms/vstorage-as-readonly-API
branch
from
1479a31 to
7f50eb6
Compare
Building Client Dapps page is updated to contain a box with a summary of the discussion related to public readonly contract state query.