Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Agoric/agoric-sdk
monorepo for the Agoric Javascript smart contract platform
https://github.com/Agoric/agoric-sdk
Last synced: 4 days ago
JSON representation
monorepo for the Agoric Javascript smart contract platform
- Host: GitHub
- URL: https://github.com/Agoric/agoric-sdk
- Owner: Agoric
- License: apache-2.0
- Created: 2019-11-01T15:30:18.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T10:30:08.000Z (10 days ago)
- Last Synced: 2024-10-29T10:57:58.905Z (10 days ago)
- Language: JavaScript
- Homepage:
- Size: 121 MB
- Stars: 327
- Watchers: 28
- Forks: 206
- Open Issues: 1,569
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-cosmos - Agoric SDK - Agoric JavaScript Smart Contract Platform. (Virtual Machines / Terminal Block Explorers)
- best-of-crypto - GitHub - 33% open · ⏱️ 05.06.2024): (Others)
README
# Agoric Platform SDK
[](./LICENSE)
[](https://wiki.mutable.ai/Agoric/agoric-sdk)
This repository contains most of the packages that make up the upper
layers of the Agoric platform, with
[the endo repository](https://github.com/endojs/endo)
providing the lower layers.
If you want to build on top of this platform, you don't need these
repositories: instead you should
[follow our instructions for getting started](https://docs.agoric.com/guides/getting-started/)
with the Agoric SDK.
But if you are improving the platform itself, these are the repositories
to use.
## Prerequisites
Prerequisites are enforced in various places that should be kept synchronized with this section (e.g., [repoconfig.sh](./repoconfig.sh) defines `golang_version_check` and `nodejs_version_check` shell functions).
* Git
* Go ^1.20.2
* Node.js ^18.12 or ^20.9
* we generally support the latest LTS release: use [nvm](https://github.com/nvm-sh/nvm) to keep your local system up-to-date
* Yarn (`npm install -g yarn`)
* gcc >=10, clang >=10, or another compiler with `__has_builtin()`
Any version of Yarn will do: the `.yarnrc` file should ensure that all
commands use the specific checked-in version of Yarn (stored in
`.yarn/releases/`), which we can update later with PRs in conjunction with
any necessary compatibility fixes to our `package.json` files.
### Building on Apple Silicon and Newer Architectures
Some dependencies may not be prebuilt for Apple Silicon and other newer
architectures, so it may be necessary to build these dependencies from source
and install that package’s native dependencies with your package manager (e.g. Homebrew).
Currently these dependencies are:
* [Canvas](https://github.com/Automattic/node-canvas#compiling)
Additionally, if your package manager utilizes a non-standard include path, you may
also need to export the following environment variable before running the commands
in the Build section.
```sh
export CPLUS_INCLUDE_PATH=/opt/homebrew/include
```
Finally, you will need the native build toolchain installed to build these items from source.
```sh
xcode-select --install
```
## Build
From a new checkout of this repository, run:
```sh
yarn install
yarn build
```
When the `yarn install` is done, the top-level `node_modules/` will contain
all the shared dependencies, and each subproject's `node_modules/` should
contain only the dependencies that are unique to that subproject (e.g. when
the version installed at the top level does not meet the subproject's
constraints). Our goal is to remove all the unique-to-a-subproject deps.
When one subproject depends upon another, `node_modules/` will contain a
symlink to the subproject (e.g. `ERTP` depends upon `marshal`, so
`node_modules/@endo/marshal` is a symlink to `packages/marshal`).
Run `yarn workspaces info` to get a report on which subprojects (aka
"workspaces") depend upon which others. The `mismatchedWorkspaceDependencies`
section tells us when symlinks could not be used (generally because e.g.
`ERTP` wants `[email protected]`, but `packages/marshal/package.json` says it's
actually `0.2.0`). We want to get rid of all mismatched dependencies.
The `yarn build` step generates kernel bundles.
## Test
To run all unit tests (in all packages):
* `yarn test` (from the top-level)
To run the unit tests of just a single package (e.g. `eventual-send`):
* `cd packages/eventual-send`
* `yarn test`
## Run the larger demo
Visit [https://docs.agoric.com](https://docs.agoric.com/guides/getting-started/) for getting started instructions.
TL;DR:
* `yarn link-cli ~/bin/agoric`
* `cd ~`
* `agoric init foo`
* `cd foo`
* `agoric install`
* `agoric start`
Then browse to http://localhost:8000
## Edit Loop
* modify something in e.g. `zoe/`
* run `yarn build` (at the top level or in `zoe/`)
* re-run tests or `agoric start --reset`
* repeat
Doing a `yarn build` in `zoe` creates the "contract facet bundle", a single file
that rolls up all the Zoe contract vat sources. This bundle file is needed by all zoe contracts before they can invoke `zoe~.install(...)`. If you don't run `yarn build`, then changes to the Zoe contract facet will be ignored.
## Development Standards
* All work should happen on branches. Single-commit branches can land on
trunk without a separate merge, but multi-commit branches should have a
separate merge commit. The merge commit subject should mention which
packages were modified (e.g. `(SwingSet,cosmic-swingset) merge
123-fix-persistence`)
* Keep the history tidy. Avoid overlapping branches. Rebase when necessary.
* All work should have an Issue. All branches names should include the issue
number as a prefix (e.g. `123-description`). Use "Labels" on the Issues to
mark which packages are affected.
* Add user-visible changes to a new file in the `changelogs/` directory,
named after the Issue number. See the README in those directories for
instructions.
* Unless the issue spans multiple packages, each branch should only modify
a single package.
* Releases should be made as according to [MAINTAINERS.md](MAINTAINERS.md).