vstorage resource analysis

[anilhelvaci]

What is the Problem Being Solved?

We need to think on what's the best way store required data on vstorage in the most efficient way

Description of the Design

TBD

Security Considerations

Make sure we're not consuming unnecessary space and not make it harder to update/write new data

Scaling Considerations

Test Plan

Upgrade Considerations

[Jorge-Lopes]

Vstorage Research

Storage viewer tool

• https://p2p-org.github.io/p2p-agoric-vstorage-viewer/
• network RPCs
  • mainnet: https://github.com/cosmos/chain-registry/blob/master/agoric/chain.json
  • devnets; instagoric

Agoric

• How does vstorage / chainStorage work? How much can we store there? Agoric/agoric-sdk#7395
  • Office hours session (18’’)
  • https://drive.google.com/drive/folders/1CiuuwLK2JpHYVU5OUtGVskD-xXg7uNSj
  • Notes from recording:
    • Swingset has a bunch of stuff that is written into IAVL tree
    • Vstorage came from split vstorage out of swingset
    • Vstorage is general purpose hierarchical key store
    • vstorage go module (bellow) is connected to the javascript world over a bridge. (no more details provided)
• Agoric vstorage implementation
  • https://github.com/Agoric/agoric-sdk/blob/6e90d9640a7129584540b2028198e92a7b6e32c4/golang/cosmos/x/vstorage/README.md
  • https://github.com/Agoric/agoric-sdk/blob/6e90d9640a7129584540b2028198e92a7b6e32c4/golang/cosmos/x/vstorage/types/path_keys.go
  • feat(keeper): storage path key encoding Agoric/agoric-sdk#5406
• vat storage rental economics
  • spacebank: vat storage rental economics Agoric/agoric-sdk#2631

Methods exposed by the storage node

Object [Alleged: mockChainStorage] {
  __getInterfaceGuard__: [Function: value],
  __getMethodNames__: [Function: value],
  getPath: [Function: value],
  getStoreKey: [Function: value],
  makeChildNode: [Function: value],
  setValue: [Function: value],
  getBody: [Function: getBody],
  keys: [Function: keys]
}

Note: this seems like the best description of vstorage on agoric code

• https://github.com/Agoric/agoric-sdk/blob/master/packages/internal/src/lib-chainStorage.js#L30-L44

/**
 * This represents a node in an IAVL tree.
 *
 * The active implementation is x/vstorage, an Agoric extension of the Cosmos SDK.
 *
 * Vstorage is a hierarchical externally-reachable storage structure that
 * identifies children by restricted ASCII name and is associated with arbitrary
 * string-valued data for each node, defaulting to the empty string.
 *
 * @typedef {object} StorageNode
 * @property {(data: string) => Promise<void>} setValue publishes some data
 * @property {() => string} getPath the chain storage path at which the node was constructed
 * @property {() => Promise<VStorageKey>} getStoreKey DEPRECATED use getPath
 * @property {(subPath: string, options?: {sequence?: boolean}) => StorageNode} makeChildNode
 */

Interesting related topics:

• block-aware API for deleting StorageNodes Agoric/agoric-sdk#7405
• API for writing MapStore to recorders Agoric/agoric-sdk#8355
• performance
  • https://github.com/Agoric/agoric-sdk/wiki/Limit-work-by-message-size

Cosmos

• Data structure used:
  • IAVL (immutable Adelson-Velsky and Landis)
  • https://github.com/cosmos/iavl
  • https://github.com/cosmos/iavl/blob/master/docs/overview.md
  • https://medium.com/the-interchain-foundation/iavl-v1-0-optimizing-storage-in-the-cosmos-sdk-41e871e4ec1c
• Cosmos Store:
  • https://docs.cosmos.network/v0.50/build/spec/store
• An change from IAVL to SMT was proposed for the state commitments (Drat phase)
  • https://docs.cosmos.network/v0.46/architecture/adr-040-storage-and-smt-state-commitments.html
  • https://www.youtube.com/watch?v=U4szzDxisII