Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(deploy-script-support): Document "options" in the README #10769

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(deploy-script-support): Document "options" in the README #10769

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions packages/deploy-script-support/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,10 @@ or an object whose keys identify child properties and whose corresponding values
are theirselves (recursive) permits. See `BootstrapManifiest` in
[lib-boot.js](../vats/src/core/lib-boot.js).

The object returned from a "getManifestCall" invocation may also include
"installations" to register in `agoricNames`, as is done here with name "game1"
using the reference passed in via the invocation argument:
The manifest object returned from a "getManifestCall" invocation may also
include "installations" to register in `agoricNames` and/or "options" to be
provided as the "options" property of the second argument for each call of the
manifest's functions:
```js
/** @type {import('@agoric/vats/src/core/lib-boot').BootstrapManifest} */
const gameManifest = harden({
Expand All @@ -87,9 +88,12 @@ const gameManifest = harden({
export const getManifestForGame1 = ({ restoreRef }, { game1Ref }) => {
return harden({
manifest: gameManifest,
// a reference to the game1 bundle will be published in agoricNames as "game1"
installations: {
game1: restoreRef(game1Ref),
},
// the second argument of `startGameContract` will be `{ options: ["foo"] }`
options: ["foo"],
});
};
```
Expand Down
Loading