You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Over the past year+ there have been numerous changes to the vat->kernel syscall interface and the kernel->vat delivery interface. The design documentation in the SwingSet/docs directory have not kept pace with these changes and need to be resynchronized with ground truth.
The text was updated successfully, but these errors were encountered:
What's one or two specific ways that the docs are out of date?
(for context: I'm trying to figure out if the docs in their present state have a reasonable specification of clists, since #3103 seems to expect that the reader knows how they work.)
docs/delivery.md is pretty good.. at a quick glance, the things that need updating are:
comms vat now has a full clist between it's "local" numberspace and the kernel-facing vrefs (previously these used the same identifier)
syscall.resolve now takes batches of resolutions, not a single one
we no longer differentiate promise resolution status into "fulfilled to object" / "fulfilled to data" / "rejected", instead we have one boolean flag for "resolved vs rejected", and capdata. The "fulfilled to object" is now just "resolved (not rejected)" along with capdata that references a single object.
the document could stand to talk about the VatDeliveryObject which is a data structure that encapsulates a delivery of some sort (deliver, notify, dropExports, etc), now that the vat's dispatchfunction is defined to take one, rather than the previous approach in which dispatch was an object and dispatch.deliver was one of its methods
What is the Problem Being Solved?
Over the past year+ there have been numerous changes to the vat->kernel syscall interface and the kernel->vat delivery interface. The design documentation in the
SwingSet/docs
directory have not kept pace with these changes and need to be resynchronized with ground truth.The text was updated successfully, but these errors were encountered: