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.

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

Adding Instructions to build agd #1206

Merged
merged 4 commits into from
Sep 16, 2024
Merged

Conversation

amessbee
Copy link
Contributor

The change goes in chain-integration.md page where it was designated to be before this change.

closes: #1203

Copy link

cloudflare-workers-and-pages bot commented Sep 12, 2024

Deploying documentation with  Cloudflare Pages  Cloudflare Pages

Latest commit: 65a4468
Status: ✅  Deploy successful!
Preview URL: https://321a12b2.documentation-7tp.pages.dev
Branch Preview URL: https://ms-add-building-agd-instruct.documentation-7tp.pages.dev

View logs

Copy link
Member

@dckc dckc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's proposed here is pretty clearly an improvement, but I recommend waiting for other reviewers before merging.

cd agoric-sdk
SKIP_DOWNLOAD=false ./bin/agd build
export PATH=$PWD/bin:$PATH
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This page talks about how we're just another cosmos chain, which suggests that agd would be a single-file binary. But it's not. I suggest including something like this blurb from recent release notes:

Unlike typical cosmos-sdk chains where the daemon is a single executable file, Agoric's use of cosmos-sdk depends on many components of agoric-sdk at runtime. Copying agd to /usr/local/bin or the like is unlikely to produce a working installation. For more detail, see: #7825.

@dckc
Copy link
Member

dckc commented Sep 12, 2024

never mind the recommendation to wait for more reviews; I see @mhofman endorsed this approach in #1203 (comment)

Copy link
Member

@mhofman mhofman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm gonna ponder the community-dev branch question.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While I'm here, looks like there are other changes needed in this file, possibly for another PR:

The chain is currently based on cosmos-sdk 0.46. But as Dan mentions, the general cosmos docs are only partially relevant given the amount of customization we have made.

The API endpoint should likely be updated to https://main.api.agoric.net

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed but I propose to go for another PR. @dckc and I had a discussion about updating this page before, and Dan created an issue too. I can update that issue with more details or create a new one and come back to it in a week or so?

The `agd` command line tool can be built as described in the Agoric [getting-started documentation](https://docs.agoric.com/guides/getting-started#build-the-cosmic-swingset-package). The linked step builds `agd`. To confirm that `agd` is in your `$PATH`, execute
The `agd` command line tool can be built by running the commands as below:
```sh
git clone https://github.com/Agoric/agoric-sdk
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am wondering if we should have a specific tag/branch to checkout for now, possibly agoric-upgrade-16 until we figure out an evergreen community-dev branch? Alternatively I could force-push community-dev now, since that is supposed to be updated in for upgrade-17 (it's now in the runbook).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, let's go for community-dev branch if we plan to maintain its status as evergreen in future.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated community-dev and we plan on keeping it up to date, so let's check out that branch instead of master

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have updated the docs to point to community-dev instead of master.

Copy link

github-actions bot commented Sep 13, 2024

Cloudflare deployment logs are available here

@amessbee amessbee requested a review from mhofman September 16, 2024 11:21
@amessbee amessbee merged commit 502bde7 into main Sep 16, 2024
4 of 6 checks passed
@amessbee amessbee deleted the ms/add-building-agd-instructions branch September 16, 2024 13:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Building agd Section is Unproductive/Useless
4 participants