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 a4d80dd commit 11d53e7
Showing 1 changed file with 77 additions and 14 deletions.
91 changes: 77 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,22 +41,57 @@ With Tatum SDK, you can:

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)

#### 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:

- Incoming and outgoing transactions
- Balance updates
- Contract interactions

- [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:
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)

- Balances
- Transaction history
- Other pertinent information
### πŸ–ΌοΈ NFT Actions

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)

### 🌱 Always Evolving
Our library is on a continuous journey of growth. We regularly add new features and extend support for more blockchains. It's the go-to choice for developers aiming to craft robust, scalable, and efficient blockchain apps without the overwhelming intricacies of diverse blockchain protocols.
Expand Down Expand Up @@ -127,6 +162,7 @@ console.log(`Balance: ${data}`)
// Destroy Tatum SDK - needed for stopping background jobs
tatum.destroy()
```
For more details, check out the [RPC documentation](https://docs.tatum.io/docs/rpc).

### Subscribing to Notifications

Expand All @@ -150,6 +186,8 @@ console.log(response)
tatum.destroy()
```

For more details, check out the [Notifications documentation](https://docs.tatum.io/docs/notifications).

### Get NFT balance of a wallet

Using TatumSDK, obtain the NFT balance of an address by calling the getNFTBalance method within the NFT submodule and passing the target address as an argument. This streamlined process efficiently retrieves the total number of NFTs owned by the specified address. To achieve this, use the following code:
Expand All @@ -169,6 +207,8 @@ console.log(balances)
tatum.destroy()
```

For more details, check out the [NFTs documentation](https://docs.tatum.io/docs/nfts).

### Connect to MetaMask and send transaction

Using TatumSDK, it's possible to connect your browser application to MetaMask and perform transactions using it. To achieve this, use the following code:
Expand All @@ -190,6 +230,8 @@ console.log(txId)
tatum.destroy()
```

For more details, check out the [Wallet Provider documentation](https://docs.tatum.io/docs/wallet-provider).

### Get exchange rates

Using TatumSDK, obtain current fiat/crypto exchange rates To achieve this, use the following code:
Expand All @@ -207,14 +249,11 @@ console.log(res.data)
tatum.destroy()
```

### Get current fees
For more details, check out the [Exchange Rates documentation](https://docs.tatum.io/docs/exchange-rates).

Using TatumSDK, you can obtain recommended fee/gas price for a blockchain. Supported blockchains are:
### Get current fees

- `Bitcoin`
- `Litecoin`
- `Dogecoin`
- `Ethereum`
Using TatumSDK, you can obtain recommended fee/gas price for a blockchain.

```ts
import { TatumSDK, Network, Ethereum } from '@tatumio/tatum'
Expand All @@ -235,6 +274,8 @@ console.log(result.data)
tatum.destroy()
```

For more details, check out the [Fee Estimation documentation](https://docs.tatum.io/docs/fee-estimation).

### Get token balance

Using TatumSDK, obtain all fungible token balances of an address by calling the getBalance method within the `token` submodule and passing the target address as an argument. This streamlined process efficiently retrieves all balances for fungible tokens that specified address holds. To achieve this, use the following code:
Expand All @@ -254,6 +295,28 @@ console.log(balances)
tatum.destroy()
```

For more details, check out the [Fungible Tokens documentation](https://docs.tatum.io/docs/fungible-tokens).

### Get all transactions on the wallet
Using TatumSDK, you can obtain transaction history of the wallet.

```ts
import { TatumSDK, Network, Ethereum } from '@tatumio/tatum'

const tatum = await TatumSDK.init<Ethereum>({ network: Network.ETHEREUM_SEPOLIA })

const { data: txs } = await tatum.address.getTransactions({
address: '0x514d547c8ac8ccbec29b5144810454bd7d3625ca',
});

console.log(txs);

// Destroy Tatum SDK - needed for stopping background jobs
tatum.destroy()
```

For more details, check out the [Wallet address operations documentation](https://docs.tatum.io/docs/wallet-address-operations).

## Documentation

- [Documentation and Guides](https://docs.tatum.io) to get started with Tatum SDK
Expand Down

0 comments on commit 11d53e7

Please sign in to comment.