Skip to content

Commit

Permalink
Update README.md - add more links and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Hathoriel committed Aug 9, 2023
1 parent d41311f commit 24fe2cf
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 61 deletions.
136 changes: 75 additions & 61 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ SDK</h3>
## πŸš€ Tatum SDK
A powerful, feature-rich TypeScript/JavaScript library that streamlines the development of blockchain applications.

πŸ” Designed For Developers
If you're looking to integrate blockchain functionalities into your projects, Tatum SDK is for you.
πŸ” **Designed For Developers**
If you're looking to integrate blockchain functionalities into your projects, [Tatum SDK](https://docs.tatum.io/sdk/get-started-with-tatum-sdk) is for you.

We simplify the integration process by offering:
- A user-friendly interface 🀝
Expand All @@ -40,9 +40,7 @@ We simplify the integration process by offering:
A powerful, feature-rich TypeScript/JavaScript library that streamlines the development of blockchain applications.

πŸ” **Designed For Developers**
If you're looking to integrate blockchain functionalities into your projects, [Tatum SDK](https://docs.tatum.io/sdk/get-started-with-tatum-sdk) is for you.

We simplify the integration process by offering:
If you're looking to integrate blockchain functionalities into your projects, [Tatum SDK](https://docs.tatum.io/sdk/get-started-with-tatum-sdk) is for you.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.
Expand All @@ -53,99 +51,115 @@ For more details, visit our [documentation](https://docs.tatum.io) and [examples

With Tatum SDK, you can:

### πŸ”Œ Perform Native RPC Calls

Interact seamlessly with various blockchains through native RPC calls. Say goodbye to the hassle of juggling separate RPC clients for each blockchain.

#### EVM Blockchains
- [Ethereum RPC documentation](https://docs.tatum.io/docs/rpc/evm-blockchains/ethereum-rpc-documentation)
- [Polygon RPC documentation](https://docs.tatum.io/docs/rpc/evm-blockchains/polygon-rpc-documentation)
- [Flare RPC documentation](https://docs.tatum.io/docs/rpc/evm-blockchains/flare-rpc-documentation)
- [Haqq RPC documentation](https://docs.tatum.io/docs/rpc/evm-blockchains/haqq-rpc-documentation)
- [Optimism RPC documentation](/https://docs.tatum.iodocs/rpc/evm-blockchains/optimism-rpc-documentation)
![Alt text for the image](docs/mermaid-diagram-2023-08-09-121335.svg)

#### UTXO Blockchains
- [Bitcoin RPC documentation](https://docs.tatum.io/docs/rpc/utxo-blockchains/bitcoin-rpc-documentation)
- [Litecoin RPC documentation](https://docs.tatum.io/docs/rpc/utxo-blockchains/litecoin-rpc-documentation)
- [Dogecoin RPC documentation](https://docs.tatum.io/docs/rpc/utxo-blockchains/dogecoin-rpc-documentation)

#### Solana Blockchains
- [Solana RPC documentation](https://docs.tatum.io/docs/rpc/solana-blockchains/solana-rpc-documentation)

#### XPR Blockchains
- [XPR RPC documentation](https://docs.tatum.io/docs/rpc/xpr-blockchains/xpr-rpc-documentation)
### πŸ”Œ Perform Native RPC Calls

#### Tron Blockchains
- [Tron RPC documentation](https://docs.tatum.io/docs/rpc/tron-blockchains/tron-rpc-documentation)
Interact seamlessly with various blockchains through native RPC calls. Say goodbye to the hassle of juggling separate RPC clients for each blockchain.

| Documentation |
|----------------------------------------------------------------------------------------------------------|
| **EVM Blockchains** |
| [Ethereum RPC documentation](https://docs.tatum.io/docs/rpc/evm-blockchains/ethereum-rpc-documentation) |
| [Polygon RPC documentation](https://docs.tatum.io/docs/rpc/evm-blockchains/polygon-rpc-documentation) |
| [Flare RPC documentation](https://docs.tatum.io/docs/rpc/evm-blockchains/flare-rpc-documentation) |
| [Haqq RPC documentation](https://docs.tatum.io/docs/rpc/evm-blockchains/haqq-rpc-documentation) |
| [Optimism RPC documentation](https://docs.tatum.io/docs/rpc/evm-blockchains/optimism-rpc-documentation) |
| **UTXO Blockchains** |
| [Bitcoin RPC documentation](https://docs.tatum.io/docs/rpc/utxo-blockchains/bitcoin-rpc-documentation) |
| [Litecoin RPC documentation](https://docs.tatum.io/docs/rpc/utxo-blockchains/litecoin-rpc-documentation) |
| [Dogecoin RPC documentation](https://docs.tatum.io/docs/rpc/utxo-blockchains/dogecoin-rpc-documentation) |
| **Solana Blockchains** |
| [Solana RPC documentation](https://docs.tatum.io/docs/rpc/solana-blockchains/solana-rpc-documentation) |
| **XPR Blockchains** |
| [XPR RPC documentation](https://docs.tatum.io/docs/rpc/xpr-blockchains/xpr-rpc-documentation) |
| **Tron Blockchains** |
| [Tron RPC documentation](https://docs.tatum.io/docs/rpc/tron-blockchains/tron-rpc-documentation) |

### πŸ”” Create Notifications

Effortlessly monitor wallet activities. Set up real-time notifications for events like:

- [Start monitoring of the address](https://docs.tatum.io/docs/notifications/notification-workflow/start-monitoring-of-the-address)
- [Stop monitoring of the address](https://docs.tatum.io/docs/notifications/notification-workflow/stop-monitoring-of-the-address)
- [Get all sent notifications](https://docs.tatum.io/docs/notifications/notification-workflow/get-all-sent-notifications)
- [Get all existing monitoring subscriptions](https://docs.tatum.io/docs/notifications/notification-workflow/get-all-existing-monitoring-subscriptions)
| Documentation |
| ----- |
| [Start monitoring of the address](https://docs.tatum.io/docs/notifications/notification-workflow/start-monitoring-of-the-address) |
| [Stop monitoring of the address](https://docs.tatum.io/docs/notifications/notification-workflow/stop-monitoring-of-the-address) |
| [Get all sent notifications](https://docs.tatum.io/docs/notifications/notification-workflow/get-all-sent-notifications) |
| [Get all existing monitoring subscriptions](https://docs.tatum.io/docs/notifications/notification-workflow/get-all-existing-monitoring-subscriptions) |


### πŸ‘› Access Wallet Information

Through a single interface, obtain crucial wallet details such as balances, transaction history, and other pertinent information.

- [Get all assets the wallet holds](https://docs.tatum.io/docs/wallet-address-operations/get-all-assets-the-wallet-holds)
- [Get all transactions on the wallet](https://docs.tatum.io/docs/wallet-address-operations/get-all-transactions-on-the-wallet)
| Documentation |
| ----- |
| [Get all assets the wallet holds](https://docs.tatum.io/docs/wallet-address-operations/get-all-assets-the-wallet-holds) |
| [Get all transactions on the wallet](https://docs.tatum.io/docs/wallet-address-operations/get-all-transactions-on-the-wallet) |

### πŸ–ΌοΈ NFT Actions

Dive into a comprehensive suite of actions related to non-fungible tokens (NFTs):
Dive into a comprehensive suite of actions related to non-fungible tokens (NFTs).

- [Get all NFTs the wallet holds](https://docs.tatum.io/docs/nfts/get-all-nfts-the-wallet-holds)
- [Get all NFTs in the NFT collection](https://docs.tatum.io/docs/nfts/get-all-nfts-in-the-nft-collection)
- [Trace the history of a specific NFT](https://docs.tatum.io/docs/nfts/trace-the-history-of-a-specific-nft)
- [Show the NFT history of a wallet](https://docs.tatum.io/docs/nfts/show-the-nft-history-of-a-wallet)
- [Create NFT Collection](https://docs.tatum.io/docs/nfts/create-nft-collection)
- [Create MultiToken NFT Collection](https://docs.tatum.io/docs/nfts/create-multitoken-nft-collection)
- [Retrieve the owner of the NFT](https://docs.tatum.io/docs/nfts/retrieve-the-owner-of-the-nft)
- [Check if the wallet owns a specific NFT](https://docs.tatum.io/docs/nfts/check-if-the-wallet-owns-a-specific-nft)
- [Get the metadata of a specific NFT](https://docs.tatum.io/docs/nfts/get-the-metadata-of-a-specific-nft)
| Documentation |
| ----- |
| [Get all NFTs the wallet holds](https://docs.tatum.io/docs/nfts/get-all-nfts-the-wallet-holds) |
| [Get all NFTs in the NFT collection](https://docs.tatum.io/docs/nfts/get-all-nfts-in-the-nft-collection) |
| [Trace the history of a specific NFT](https://docs.tatum.io/docs/nfts/trace-the-history-of-a-specific-nft) |
| [Show the NFT history of a wallet](https://docs.tatum.io/docs/nfts/show-the-nft-history-of-a-wallet) |
| [Create NFT Collection](https://docs.tatum.io/docs/nfts/create-nft-collection) |
| [Create MultiToken NFT Collection](https://docs.tatum.io/docs/nfts/create-multitoken-nft-collection) |
| [Retrieve the owner of the NFT](https://docs.tatum.io/docs/nfts/retrieve-the-owner-of-the-nft) |
| [Check if the wallet owns a specific NFT](https://docs.tatum.io/docs/nfts/check-if-the-wallet-owns-a-specific-nft) |
| [Get the metadata of a specific NFT](https://docs.tatum.io/docs/nfts/get-the-metadata-of-a-specific-nft) |

### πŸͺ™ Fungible Tokens
### πŸͺ™ Fungible Tokens

Explore the world of fungible tokens, manage their properties, and track your assets seamlessly.

- [Get all fungible tokens the wallet holds](https://docs.tatum.io/docs/fungible-tokens/get-all-fungible-tokens-the-wallet-holds)
- [Show fungible token history of a wallet](https://docs.tatum.io/docs/fungible-tokens/show-fungible-token-history-of-a-wallet)
- [Get metadata of a fungible token](https://docs.tatum.io/docs/fungible-tokens/get-metadata-of-a-fungible-token)
- [Create a fungible token](https://docs.tatum.io/docs/fungible-tokens/create-a-fungible-token)
| Documentation |
| ----- |
| [Get all fungible tokens the wallet holds](https://docs.tatum.io/docs/fungible-tokens/get-all-fungible-tokens-the-wallet-holds) |
| [Show fungible token history of a wallet](https://docs.tatum.io/docs/fungible-tokens/show-fungible-token-history-of-a-wallet) |
| [Get metadata of a fungible token](https://docs.tatum.io/docs/fungible-tokens/get-metadata-of-a-fungible-token) |
| [Create a fungible token](https://docs.tatum.io/docs/fungible-tokens/create-a-fungible-token) |

### β›½ Fee Estimation

Stay updated with real-time fee insights and ensure smooth transactions without overpaying.

- [Fetch real-time gas fee data](https://docs.tatum.io/docs/getCurrentFee)
| Documentation |
| ----- |
| [Fetch real-time gas fee data](https://docs.tatum.io/docs/getCurrentFee) |

### πŸ’» Wallet Provider

Integrate, transact, and manage assets using a secure and user-friendly wallet provider interface.

- [Connect a wallet](https://docs.tatum.io/docs/wallet-provider/metamask/connect-a-wallet)
- [Transfer native assets](https://docs.tatum.io/docs/wallet-provider/metamask/transfer-native-assets)
- [Transfer your NFT](https://docs.tatum.io/docs/wallet-provider/metamask/transfer-your-nft)
- [Create your NFT Collection](https://docs.tatum.io/docs/wallet-provider/metamask/create-your-nft-collection)
- [Create your Fungible Token](https://docs.tatum.io/docs/wallet-provider/metamask/create-your-fungible-token)
- [Create your NFT (ERC-1155 MultiToken) Collection](https://docs.tatum.io/docs/wallet-provider/metamask/create-your-nft-erc-1155-multitoken-collection)
- [Transfer fungible tokens like USDT](https://docs.tatum.io/docs/wallet-provider/metamask/transfer-fungible-tokens-like-usdt)
- [Approve the transfer of a fungible token like USDT](https://docs.tatum.io/docs/wallet-provider/metamask/approve-the-transfer-of-a-fungible-token-like-usdt)
- [Build your own custom transaction](https://docs.tatum.io/docs/wallet-provider/metamask/build-your-own-custom-transaction)
| Documentation |
| ----- |
| [Connect a wallet](https://docs.tatum.io/docs/wallet-provider/metamask/connect-a-wallet) |
| [Transfer native assets](https://docs.tatum.io/docs/wallet-provider/metamask/transfer-native-assets) |
| [Transfer your NFT](https://docs.tatum.io/docs/wallet-provider/metamask/transfer-your-nft) |
| [Create your NFT Collection](https://docs.tatum.io/docs/wallet-provider/metamask/create-your-nft-collection) |
| [Create your Fungible Token](https://docs.tatum.io/docs/wallet-provider/metamask/create-your-fungible-token) |
| [Create your NFT (ERC-1155 MultiToken) Collection](https://docs.tatum.io/docs/wallet-provider/metamask/create-your-nft-erc-1155-multitoken-collection) |
| [Transfer fungible tokens like USDT](https://docs.tatum.io/docs/wallet-provider/metamask/transfer-fungible-tokens-like-usdt) |
| [Approve the transfer of a fungible token like USDT](https://docs.tatum.io/docs/wallet-provider/metamask/approve-the-transfer-of-a-fungible-token-like-usdt) |
| [Build your own custom transaction](https://docs.tatum.io/docs/wallet-provider/metamask/build-your-own-custom-transaction) |

### πŸ’² Exchange Rates

Access the latest crypto exchange rates and supported currency information to stay ahead in the market.

- [Get current exchange rate of the crypto asset](https://docs.tatum.io/docs/exchange-rates/get-current-exchange-rate-of-the-crypto-asset)
- [Get current rates for multiple crypto assets at once](https://docs.tatum.io/docs/exchange-rates/get-current-rates-for-multiple-crypto-assets-at-once)
- [Supported Crypto Currencies](https://docs.tatum.io/docs/exchange-rates/supported-crypto-currencies)
- [Supported Fiats](https://docs.tatum.io/docs/exchange-rates/supported-fiats)
| Documentation |
| ----- |
| [Get current exchange rate of the crypto asset](https://docs.tatum.io/docs/exchange-rates/get-current-exchange-rate-of-the-crypto-asset) |
| [Get current rates for multiple crypto assets at once](https://docs.tatum.io/docs/exchange-rates/get-current-rates-for-multiple-crypto-assets-at-once) |
| [Supported Crypto Currencies](https://docs.tatum.io/docs/exchange-rates/supported-crypto-currencies) |
| [Supported Fiats](https://docs.tatum.io/docs/exchange-rates/supported-fiats) |


### πŸ“˜ Getting Started with TatumSDK

Expand Down
Loading

0 comments on commit 24fe2cf

Please sign in to comment.