Skip to content

Commit

Permalink
Fix: upgrade to 20.x on CI + update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
philogicae committed Sep 26, 2024
1 parent 7e54d1f commit 59efe8d
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 14 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ jobs:
- name: Setup node
uses: actions/setup-node@v3
with:
node-version: 18.x
node-version: 20.x
cache: npm

- name: Install dependencies
run: npm install

- name: Run build
run: npm run build
run: npm run build
2 changes: 1 addition & 1 deletion .github/workflows/doc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
- name: Setup node
uses: actions/setup-node@v3
with:
node-version: 18.x
node-version: 20.x
cache: npm

- name: Install dependencies
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/lint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
- name: Setup node
uses: actions/setup-node@v3
with:
node-version: 18.x
node-version: 20.x
cache: npm

- name: Install dependencies
Expand All @@ -30,4 +30,4 @@ jobs:
run: npm run build

- name: Run lint
run: npm run lint
run: npm run lint
2 changes: 1 addition & 1 deletion .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [18, 20]
node-version: [20, 22]

steps:
- name: Checkout repository
Expand Down
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,24 @@ Written in Typescript it is meant as a drop in replacement for the [aleph-js lib
npm install aleph-sdk-ts
```

- An API reference [on the repository github pages](https://aleph-im.github.io/aleph-sdk-ts/index.html)
- For guides and use-cases check the [Aleph TS SDK Gitbook](https://aleph-im.gitbook.io/ts-sdk/)
- Some examples are available in the `/examples` directory.
- An API reference [on the repository github pages](https://aleph-im.github.io/aleph-sdk-ts/index.html)
- For guides and use-cases check the [Aleph TS SDK Gitbook](https://aleph-im.gitbook.io/ts-sdk/)
- Some examples are available in the `/examples` directory.

## Supported chains

This is the list of currently supported Account types. For each of them you can:

- Retrieve an account from a private key or mnemonic (or generate one on the fly).
- Sign and send messages on the Aleph Network
- Some allow you to retrieve an account from a **browser based** wallet (ex: Metamask), or from a **Ledger** wallet.
- Retrieve an account from a private key or mnemonic (or generate one on the fly).
- Sign and send messages on the Aleph Network
- Some allow you to retrieve an account from a **browser based** wallet (ex: Metamask), or from a **Ledger** wallet.

[Previous versions](https://npmjs.com/package/aleph-sdk-ts) of the Typescript SDK allowed you to **encrypt** messages.
This has been

| Chain | Encryption | Browser Wallet | Ledger |
|----------------------|------------|--------------------| ------------------ |
| -------------------- | ---------- | ------------------ | ------------------ |
| Avalanche | :x: | :heavy_check_mark: | :x: |
| Base | :x: | :heavy_check_mark: | :x: |
| Cosmos | :x: | :heavy_check_mark: | :x: |
| Ethereum | :x: | :heavy_check_mark: | :heavy_check_mark: |
| NULS2 | :x: | :x: | :x: |
Expand Down Expand Up @@ -64,6 +64,7 @@ This SDK is tested and works, with the following Node.js versions:
| v16.x | :heavy_check_mark: **Full working support** |
| v18.x | :heavy_multiplication_x: Some feature may not work (see notes) |
| v20.x | :heavy_check_mark: **Full working support** |
| v22.x | :heavy_check_mark: **Full working support** |

\* Due to changes in OpenSSL in Node v18, some chains helper may not work. If you encounter bugs using Node v18, you might want to consider using the `--openssl-legacy-provider` feature flag while running your project.

Expand Down

0 comments on commit 59efe8d

Please sign in to comment.