Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/main'
Browse files Browse the repository at this point in the history
  • Loading branch information
Pawel-Szydlo committed Nov 27, 2023
2 parents 909810e + f7984d9 commit 5c208c8
Show file tree
Hide file tree
Showing 55 changed files with 7,718 additions and 3,504 deletions.
31 changes: 31 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Build

on:
pull_request:

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
build:
name: Build
runs-on: ubuntu-latest

steps:
- name: Checkout Repo
uses: actions/checkout@v3

- uses: actions/setup-node@v3
with:
node-version-file: .node-version

- uses: pnpm/action-setup@v2
with:
version: 7

- name: Install global dependencies
run: pnpm install --frozen-lockfile

- name: Build global project
run: pnpm run build
15 changes: 6 additions & 9 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,27 +10,24 @@ concurrency: ${{ github.workflow }}-${{ github.ref }}
jobs:
build:
name: Build
permissions:
actions: write
pull-requests: write
contents: write
runs-on: ubuntu-latest

strategy:
matrix:
node-version: [16.x]

steps:
- name: Checkout Repo
uses: actions/checkout@v3

- name: Setup Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v3
- uses: actions/setup-node@v3
with:
node-version: ${{ matrix.node-version }}
node-version-file: .node-version

- uses: pnpm/action-setup@v2
name: Install pnpm
id: pnpm-install
with:
version: 7
run_install: false

- name: Install global dependencies
run: pnpm install --frozen-lockfile
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# jetbrain
.idea

# dependencies
node_modules
.pnp
Expand Down
1 change: 1 addition & 0 deletions .node-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v16.14.0
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
auto-install-peers=true
2 changes: 1 addition & 1 deletion CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1 +1 @@
* @0xmaayan
* @0xmaayan @gregnazario @banool
34 changes: 22 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,40 +13,50 @@ You are welcome to add different apps (react/vue/etc) in this workspace (make su

#### Packages Workspace

The packages workspace holds 2 packages
The packages workspace holds 2 main packages

1. `wallet-adapter-core` - the core adapter logic that responsible on the adapter functionality, state and the interaction between the dapp and wallet.
2. `wallet-adapter-react` - a light react provider that dapps can import and use the adapter.

You are welcome to add packages (vue-provider/UI frameworks/etc) in this workspace (make sure you are following turbo best pratices on how to do it)

### Develop Locally

You would need `[email protected]` in order to bootstrap and test a local copy of this repo.

1. Clone the repo with `git clone https://github.com/aptos-labs/aptos-wallet-adapter.git`
2. On the `root` folder, run `pnpm install` and `pnpm turbo run build`
3. On the `root` folder, run `pnpm turbo run dev` - that would spin up a local server (`localhost:3000`) with the `nextjs` demoapp

### Creating a pull request

You are welcome to create a pull reuqest against the `main` branch.

Before creating a PR, on the `root` folder
Before creating a PR

1. Make sure you are up to date with the `main` branch
2. Run `pnpm install`
3. Run `pnpm turbo run build`
1. Make sure your branch is up to date with the `main` branch
2. Make sure nothing breaks in the `nextjs` demo app
3. On the `root` folder, run `pnpm install`
4. On the `root` folder, run `pnpm turbo run build`

If everything passes, you should be able to create a PR.

#### Changesets

We use [changesets](https://github.com/changesets/changesets) to handle any changes in the `changelog`.
If a pull request created that need to bump a package version, please follow those steps to create a `changelog`
If a pull request created needs to bump a package version, please follow those steps to create a `changelog`

1. Run `pnpm run changeset` and follow the prompt instructions (we follow [SemVer](https://semver.org/))
1. On the `root` folder, run `pnpm run changeset` and follow the prompt instructions (we follow [SemVer](https://semver.org/))
2. Under `.changeset/` you will notice a new markdown file (its name is randomly generated), with the change-type and summary.
3. Push the file along with the rest of the changes

Once your PR will be merged, our Github action will create a new PR with that generated changelog for us to merge, once the generated PR is merged a new version will be published to npm.

### Develop Locally
### Deploy

You would need `[email protected]` in order to bootstrap and test a local copy of this repo.
If you made some changes to the `nextjs` demo app, you would want to deploy those changes once they are merged.

1. Clone the repo with `git clone https://github.com/aptos-labs/aptos-wallet-adapter.git`
2. Run `pnpm install` and `pnpm turbo run build`
3. Run `pnpm turbo run dev` - that would spin up a local server (`localhost:3000`) with the `nextjs` demoapp
To do that

1. On the `root` folder in the `main` branch, run `git pull` to make sure you have the latest `main`
2. On the `root` folder, run `deploy:example` - that would handle the nextjs app deployment.
23 changes: 17 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
> **_NOTE:_** Use the Wallet Adapter v2.0.0 and up with the Aptos TypeScript SDK V2
# Aptos Wallet Adapter

A monorepo modular wallet adapter developed and maintained by Aptos for wallet and dapp builders that includes:

#### Getting Started

- [Example app](https://github.com/aptos-labs/aptos-wallet-adapter/tree/main/apps/nextjs-example)
- [For Aptos Dapps](https://github.com/aptos-labs/aptos-wallet-adapter/tree/main/packages/wallet-adapter-react)
- [For Aptos Wallets](https://github.com/aptos-labs/wallet-adapter-plugin-template)
Expand All @@ -10,15 +14,22 @@ A monorepo modular wallet adapter developed and maintained by Aptos for wallet a

#### Supported wallet packages

Note: These are in alphabetical order, any new wallets must be in alphabetical order

- [Blocto](https://www.npmjs.com/package/@blocto/aptos-wallet-adapter-plugin)
- [FaceWallet](https://www.npmjs.com/package/@haechi-labs/face-aptos-adapter-plugin)
- [Fewcha](https://www.npmjs.com/package/fewcha-plugin-wallet-adapter)
- [Flipper](https://www.npmjs.com/package/@flipperplatform/wallet-adapter-plugin)
- [Martian](https://www.npmjs.com/package/@martianwallet/aptos-wallet-adapter)
- [MSafe](https://www.npmjs.com/package/@msafe/aptos-wallet-adapter)
- [Nightly](https://www.npmjs.com/package/@nightlylabs/aptos-wallet-adapter-plugin)
- [OpenBlock](https://www.npmjs.com/package/@openblockhq/aptos-wallet-adapter)
- [Petra](https://www.npmjs.com/package/petra-plugin-wallet-adapter)
- [Trust](https://www.npmjs.com/package/@trustwallet/aptos-wallet-adapter)
- [Pontem](https://www.npmjs.com/package/@pontem/wallet-adapter-plugin)
- [Martian](https://www.npmjs.com/package/@martianwallet/aptos-wallet-adapter)
- [Rise](https://www.npmjs.com/package/@rise-wallet/wallet-adapter)
- [Spika](https://www.npmjs.com/package/@spika/aptos-plugin)
- [Fewcha](https://www.npmjs.com/package/fewcha-plugin-wallet-adapter)
- [MSafe](https://www.npmjs.com/package/msafe-plugin-wallet-adapter)
- [Blocto](https://www.npmjs.com/package/@blocto/aptos-wallet-adapter-plugin)
- [TokenPocket](https://www.npmjs.com/package/@tp-lab/aptos-wallet-adapter)
- [Trust](https://www.npmjs.com/package/@trustwallet/aptos-wallet-adapter)
- [WELLDONE](https://www.npmjs.com/package/@welldone-studio/aptos-wallet-adapter)

#### Develop Locally

Expand Down
2 changes: 1 addition & 1 deletion apps/nextjs-example/.eslintrc.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module.exports = {
root: true,
extends: ["adapter"],
extends: ["@aptos-labs/eslint-config-adapter"],
};
Loading

0 comments on commit 5c208c8

Please sign in to comment.