Repository files navigation

Sequence: a modular web3 stack and smart wallet for Ethereum chains

npm install 0xsequence ethers

or

pnpm install 0xsequence ethers

or

yarn add 0xsequence ethers

• 0xsequence
• @0xsequence/abi
• @0xsequence/api
• @0xsequence/auth
• @0xsequence/core
• @0xsequence/deployer
• @0xsequence/guard
• @0xsequence/multicall
• @0xsequence/network
• @0xsequence/provider
• @0xsequence/relayer
• @0xsequence/replacer
• @0xsequence/sessions
• @0xsequence/signhub
• @0xsequence/utils
• @0xsequence/wallet

Below are notes and instructions on how to get your development environment up and running,and enjoyable.

1. Install dependenciesRun,pnpm install

2. Workflow -- we use the amazingpreconstructpackage to handle our monorepo build system.

3. Local dev -- when you're working on the code in this repository, you can safely runpnpm dev at the root-level, which will link all packages/** together, so that when alocal dependency from packages/** is used by another, it will automatically be linkedwithout having to run a build command. Just remember: runpnpm dev anytime you developingin this repo. Note, that when you runpnpm build it will clear the dev environment, soyou will need to runpnpm dev again after a build. However,pnpm build should only beused when making a release.

4. Testing -- to test the system, you can runpnpm test at the top-level or at an individualpackage-level.

5. Type-checking -- to typecheck the system you can runpnpm typecheck at any level.

6. Building -- tocompile the project to dist files for a release, runpnpm build atthe root-level. Note building packages repeatedly during development is unnecessary withpreconstruct. During local development runpnpm dev and when building to make a release,runpnpm build.

7. Versioning -- this repository uses the handychangesetspackage for package versioning across the monorepo, as well as changelogs. SeeReleasing section below.

0xsequence uses changesets to do versioning. This makes releasing really easy and changelogs are automatically generated.

1. Runpnpm to make sure everything is up to date
2. Code.. do your magic
3. Runpnpm changeset to generate a new .changeset/ entry explaining the code changes
4. Version bump all packages regardless of them having changes or not
5. Runpnpm i to update the pnpm-lock.yaml.
6. Commit and submit your changes as a PR for review
7. Once merged and you're ready to make a release, continue to the next step. If you're notready to make a release, then go back to step 2.
8. Runpnpm build && pnpm test to double check all tests pass
9. Runpnpm version-packages to bump versions of the packages
10. Runpnpm install so we update our pnpm-lock.yaml file with our newly created version
11. Commit files after versioning. This is the commit that will be published and tagged:git push --no-verify
12. Runpnpm release. If the 2FA code timesout while publishing, run the command againwith a new code, only the packages that were not published will be published.
13. Finally, push your git tags, via:git push --tags --no-verify

Snapshot releases are versioned as 0.0.0-YYYYmmddHHMMSS and are intended for testing builds only.

1. pnpm snapshot (select all packages even if unchanged, the message is not important)
2. Do not commit any changes to package.json's or CHANGELOG.md's that happened during 1.

1. Browser tests can be run withpnpm test or, separatelypnpm test:server andpnpm test:run
2. To run a specific test, runpnpm test:only <test-file-basename>, ie.pnpm test:only window-transport

• If you're using node v18+ and you hit the errorError: error:0308010C:digital envelope routines::unsupported,make sure to first set,export NODE_OPTIONS=--openssl-legacy-provider

Apache-2.0

Copyright (c) 2017-present Horizon Blockchain Games Inc. /https://horizon.io