Skip to content

Commit

Permalink
Update verbose logging (#885)
Browse files Browse the repository at this point in the history
  • Loading branch information
Hathoriel authored Aug 10, 2023
1 parent 7b32cf1 commit de75a1b
Show file tree
Hide file tree
Showing 53 changed files with 79 additions and 4,454 deletions.
1 change: 1 addition & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ on:
env:
SDK_ERROR_MESSAGES_VERSION: "master"
V2_API_KEY: ${{ secrets.V2_API_KEY }}
NON_TATUM_RPC_ETH_URL: ${{ secrets.NON_TATUM_RPC_ETH_URL }}

jobs:
metadata:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release-pr.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ on:

env:
V2_API_KEY: ${{ secrets.V2_API_KEY }}

NON_TATUM_RPC_ETH_URL: ${{ secrets.NON_TATUM_RPC_ETH_URL }}
jobs:
checks:
runs-on: ubuntu-latest
Expand Down
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
## [3.0.9] - 2023.08.10
### Updated
- Add better logging message
- Updated contributing guide
- Removed old example folder

## [3.0.7] - 2023.08.10
### Fixed
- Fix retry requests
Expand Down
55 changes: 47 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ We simplify the integration process by offering:
- A user-friendly interface 🤝
- Consistent interaction with a broad range of blockchains, including Ethereum 🔷, Polygon 🟣, Bitcoin ₿, and many more.

For more details, visit our [documentation](https://docs.tatum.io) and [examples](https://github.com/tatumio/tatum-js#getting-started).
For more details, visit our [documentation](https://docs.tatum.io) and [getting started guide](https://github.com/tatumio/tatum-js#getting-started).


With Tatum SDK, you can:
Expand Down Expand Up @@ -207,6 +207,8 @@ const tatum = await TatumSDK.init<Ethereum>({ network: Network.ETHEREUM })
tatum.destroy()
```

For more details, check out the [Get started documentation](https://docs.tatum.io/sdk/javascript-typescript-sdk).

### RPC Calls

To make RPC calls, use the available methods to interact with Ethereum blockchain. For example, to fetch the balance of a specific Ethereum address:
Expand Down Expand Up @@ -383,21 +385,58 @@ For more details, check out the [Wallet address operations documentation](https:
- [Documentation section](https://github.com/tatumio/tatum-js/tree/master/docs) for more details.

## Examples
Explore various applications that utilize the Tatum SDK. These examples help illustrate the SDK's functionality and offer a starting point for developers looking to integrate similar features into their applications.

- [Browser Example](https://github.com/tatumio/tatum-js/tree/master/examples/browser)
- [Get Balance ETH Example](https://github.com/tatumio/tatum-js/tree/master/examples/docs/get-balance-eth)
- [NextJS Example](https://github.com/tatumio/tatum-js/tree/master/examples/nextjs)
- [TypeScript Example](https://github.com/tatumio/tatum-js/tree/master/examples/typescript)
![Metamask notifications](https://github.com/tatumio/example-apps/blob/master/Metamask/notifications/public/demo.png)
- [Metamask notifications](https://github.com/tatumio/example-apps/tree/master/Metamask/notifications)
- [Metamask portfolio](https://github.com/tatumio/example-apps/tree/master/Metamask/portfolio)
- [Metamask transfer](https://github.com/tatumio/example-apps/tree/master/Metamask/transfer)

## Legacy versions

Older versions of the Tatum SDK has been moved to long living branches [`Tatum SDK V1`](https://github.com/tatumio/tatum-js/tree/v1) and [`Tatum SDK V2`](https://github.com/tatumio/tatum-js/tree/v2).

## Contributing
## 🤝 Contributing

We appreciate your interest in contributing to the Tatum SDK. Here's a guide to help you make meaningful contributions:

### 1️⃣ Local Testing

Before making a pull request, ensure you've thoroughly tested your changes with a local client.

### 2️⃣ Unit Tests

Include unit test coverage for any new code you're adding. This helps in maintaining the quality and reliability of our SDK.

### 3️⃣ Update the Changelog

For every contribution, it's essential to document your changes in the changelog. The changelog keeps track of all the changes, updates, and fixes we make to our SDK. Use the provided format:

```markdown
## [Version Number] - YYYY.MM.DD
### Added/Updated/Fixed/Changed
- Description of the change
```

For instance:

```markdown
## [3.0.10] - 2023.08.11
### Added
- New feature XYZ
```

### 4️⃣ Update `package.json`

Before creating a pull request or releasing a new version, ensure the `version` in `package.json` is updated to reflect the new release number.

### 5️⃣ Release Consideration
Your changes will be released after merging the pull request.

---

Contributions to the Tatum SDK are welcome. Please ensure that you have tested your changes with a local client and have added unit test coverage for your code.
🙌 Thank you for helping make Tatum SDK better! Your contributions play a crucial role in its continuous improvement and growth.

Changes will be included with the nearest release (but please point out if you deem changes worthy dedicated release).

### Bugs and feature requests

Expand Down
4 changes: 2 additions & 2 deletions dot.env
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# E2E
TESTNET_API_KEY=
MAINNET_API_KEY=
V2_API_KEY=
NON_TATUM_RPC_ETH_URL=
39 changes: 0 additions & 39 deletions examples/browser/.gitignore

This file was deleted.

9 changes: 0 additions & 9 deletions examples/browser/index.html

This file was deleted.

7 changes: 0 additions & 7 deletions examples/browser/main.js

This file was deleted.

21 changes: 0 additions & 21 deletions examples/browser/package.json

This file was deleted.

Loading

0 comments on commit de75a1b

Please sign in to comment.