Skip to content

docs: refresh getting-started onboarding cluster for current agoric-sdk #1307

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

Closed
igoricbot wants to merge 1 commit into from
Closed

docs: refresh getting-started onboarding cluster for current agoric-sdk #1307

Show file tree
Hide file tree
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
5 changes: 4 additions & 1 deletion _redirects
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,11 @@
/getting-started/start-a-project.html /guides/getting-started/
/getting-started/start-a-project/* /guides/getting-started/start-a-project/:splat
/guides/agoric-cli/commands /guides/agoric-cli/
/guides/agoric-cli/commands.html /guides/agoric-cli/
/guides/agoric-cli/commands.html /guides/agoric-cli/
/guides/agoric-cli/commands/* /guides/agoric-cli/:splat
/guides/getting-started/deploying /guides/getting-started/explainer-deploying-a-smart-contact
/guides/getting-started/deploying.html /guides/getting-started/explainer-deploying-a-smart-contact
/guides/getting-started/deploying/* /guides/getting-started/explainer-deploying-a-smart-contact:splat
/guides/js-programming/ses/lockdown https://github.com/endojs/endo/blob/HEAD/packages/ses/docs/lockdown.md
/guides/js-programming/ses/lockdown.html https://github.com/endojs/endo/blob/HEAD/packages/ses/docs/lockdown.md
/guides/js-programming/ses/ses-guide https://github.com/endojs/endo/blob/HEAD/packages/ses/docs/guide.md
Expand Down
100 changes: 0 additions & 100 deletions main/guides/getting-started/deploying.md
View file
Open in desktop

This file was deleted.

4 changes: 2 additions & 2 deletions main/guides/getting-started/explainer-deploying-a-smart-contact.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Deploying a Smart Contact
# Deploying a Smart Contract

In the `dapp-offer-up` tutorial you just went through you saw how quick and easy it was to deploy a contact on Agoric using the `yarn start:contract` command. Let's take a look at how this command works and what's going on behind the scenes.
In the `dapp-offer-up` tutorial you just went through you saw how quick and easy it was to deploy a contract on Agoric using the `yarn start:contract` command. Let's take a look at how this command works and what's going on behind the scenes.

## How it Works

Expand Down
8 changes: 4 additions & 4 deletions main/guides/getting-started/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ source $(brew --prefix nvm)/nvm.sh
Then, install Node.js.

```sh
nvm install v18.18.0
nvm install v22.11.0
```

Finally, verify the Node.js version.
Expand All @@ -102,17 +102,17 @@ node --version

### Installing Yarn

This will install yarn, and verify it is installed correctly. Install yarn by either running `npm install --global yarn`, or visit https://classic.yarnpkg.com/en/docs/install for more information. See below, `corepack enable` will add the Corepack shims to the install directories, and `yarn --version` will verify yarn is installed correctly.
This will install yarn, and verify it is installed correctly. `corepack enable` will add the Corepack shims to the install directories, and `yarn --version` will verify yarn is installed correctly.

```sh
corepack enable
yarn --version # for verification
```

This app uses Yarn 1, so running the above command will show a version in the format `1.x.x`. If you are using a different version of `yarn`, you can use `yarn set version <version>` to switch like in the example below.
The sample dapp pins Yarn Berry (`"packageManager": "yarn@4.7.0"` in its `package.json`), so once you're inside the `demo` directory (see [Creating Your Dapp From a Template](#creating-your-dapp-from-a-template) below), Corepack will pick up that version automatically. If it does not, you can set it explicitly:

```sh
yarn set version 1.22.5
yarn set version 4.7.0
```

### Installing Docker
Expand Down
4 changes: 2 additions & 2 deletions main/guides/getting-started/sell-concert-tickets-contract-explainer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ const inventory = {
maxTickets: 5n
},
backRow: {
tradePrice: AmountMath.make(istBrand, n),
maxTickets: n
tradePrice: AmountMath.make(istBrand, 1n),
maxTickets: 10n
}
};
```
Expand Down
2 changes: 1 addition & 1 deletion main/guides/getting-started/swaparoo-how-to-swap-assets-explainer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This smart contract is designed to allow two parties to swap assets between themselves, with a fee charged to one of the parties. The contract is started with a `feeAmount` and a `namesByAddressAdmin` object, which is used to retrieve a deposit facet for the second party.

**NOTE:** _`namesByAddressAdmin` is actually excess authority in this scenario. Normally read-only access can be attained via `namesByAddress`. The use of `namesByAddressAdmin` in this example is due to a bug, which will be addressed in an upcoming release._
**NOTE:** _`namesByAddressAdmin` is actually excess authority in this scenario. Normally read-only access can be attained via `namesByAddress`. The use of `namesByAddressAdmin` in this example is due to a bug that has not yet been fixed upstream; treat it as a known rough edge rather than something a template consumer needs to work around._

Let's take a look at how this contract works:

Expand Down
2 changes: 1 addition & 1 deletion main/guides/getting-started/ui-tutorial/agoric-provider.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This makes it easy to handle all the platform-specific implementation details, s
Install the following dependencies:

```
yarn add -D @agoric/react-components@0.2.0 cosmos-kit@2.8.5 @interchain-ui/react@1.22.11
yarn add -D @agoric/react-components@0.2.0 cosmos-kit@2.8.5 @interchain-ui/react@1.23.11
```

The `cosmos-kit` dependency is used to provide different wallets in the wallet connection modal.
Expand Down
16 changes: 8 additions & 8 deletions main/guides/js-programming/eventual-send.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,18 @@ In web browsers, a common pattern of remote communication is using the

In the Agoric platform, communicating with remote objects is similar,
using the `E()` wrapper. For example,
a [deploy script](../getting-started/deploying) may want to use the
[Zoe Service API](/reference/zoe-api/zoe) to install a contract on a blockchain.
But the deploy script cannot call `zoe.install(bundle)`, because it does not have local
access to the `zoe` object. However, the deploy
script is given a `zoe` _remote presence_. To call methods on the
actual Zoe object, the deploy script can do:
a [core-eval script](../getting-started/explainer-deploying-a-smart-contact) may want to use the
[Zoe Service API](/reference/zoe-api/zoe) to install a contract on the chain.
But the script cannot call `zoe.installBundleID(bundleId)` directly, because it does not have local
access to the `zoe` object. However, the script
is given a `zoe` _remote presence_ among its permitted powers. To call methods on the
actual Zoe object, the script can do:

```js
import { E } from '@endo/eventual-send';

E(zoe).install(bundle)
.then(installationHandle => { ... })
E(zoe).installBundleID(bundleId)
.then(installation => { ... })
.catch(err => { ... });
```

Expand Down