@tatumio/evm-wallet-provider
TypeScript icon, indicating that this package has built-in type declarations

1.0.11 • Public • Published

🌍 EVM Wallet Provider

EVM Wallet Provider integrates seamlessly with Tatum SDK to provide extended wallet capabilities for EVM-based blockchains.

📖 Description

The EVM Wallet Provider provides an array of tools for:

  • Generating mnemonics for seed phrases.
  • Creating extended public keys (xpubs) from mnemonics.
  • Deriving private keys and addresses from mnemonics and xpubs.
  • Signing and broadcasting transactions to the EVM-based networks.

It is built upon popular packages like ethereumjs-wallet, ethers, and bip39, ensuring a robust and secure foundation.

🚀 Quick Start

  1. Installation

    Firstly, ensure that the @tatumio/evm-wallet-provider package is set as a dependency within your project. Next, import the EVM Wallet Provider extension:

    import { EvmWalletProvider } from '@tatumio/evm-wallet-provider';
  2. Initialization

    Create an instance of Tatum SDK passing EvmWalletProvider as one of wallet providers.

    const tatumSdk = await TatumSDK.init<Ethereum>({
         network: Network.ETHEREUM,
         configureWalletProviders: [
             EvmWalletProvider,
         ]
     })

🛠️ How to Use

  1. Generate Mnemonic

    const mnemonic = tatumSdk.walletProvider.use(EvmWalletProvider).generateMnemonic()
  2. Generate xpub with or without Mnemonic

    const xpubDetails = await tatumSdk.walletProvider.use(EvmWalletProvider).generateXpub(mnemonic)
  3. Generate Private Key from Mnemonic

    const privateKey = await tatumSdk.walletProvider.use(EvmWalletProvider).generatePrivateKeyFromMnemonic(mnemonic, 0)
  4. Generate Address from Mnemonic or xpub

    const addressFromMnemonic = await tatumSdk.walletProvider.use(EvmWalletProvider).generateAddressFromMnemonic(mnemonic, 0)
    const addressFromXpub = await tatumSdk.walletProvider.use(EvmWalletProvider).generateAddressFromXpub(xpubDetails.xpub, 0)
  5. Sign and Broadcast a Transaction

    Define your payload according to the EvmTxPayload type:

    const payloadEvm = {
       privateKey: 'YOUR_PRIVATE_KEY',
       to: 'TARGET_WALLET_ADDRESS',
       value: '0.00001', // ETH_AMOUNT
    }
    const txHash = await tatumSdk.walletProvider.use(EvmWalletProvider).signAndBroadcast(payloadEvm)

Remember to always ensure the safety of mnemonics, private keys, and other sensitive data. Never expose them in client-side code or public repositories.

🔗🔗 Supported Networks

Network.ETHEREUM,
Network.ETHEREUM_SEPOLIA,
Network.ETHEREUM_CLASSIC,
Network.ETHEREUM_GOERLI,
Network.ETHEREUM_HOLESKY,
Network.AVALANCHE_C,
Network.AVALANCHE_C_TESTNET,
Network.POLYGON,
Network.POLYGON_MUMBAI,
Network.GNOSIS,
Network.GNOSIS_TESTNET,
Network.FANTOM,
Network.FANTOM_TESTNET,
Network.AURORA,
Network.AURORA_TESTNET,
Network.CELO,
Network.CELO_ALFAJORES,
Network.BINANCE_SMART_CHAIN_TESTNET,
Network.VECHAIN,
Network.VECHAIN_TESTNET,
Network.XDC,
Network.XDC_TESTNET,
Network.PALM,
Network.PALM_TESTNET,
Network.CRONOS,
Network.CRONOS_TESTNET,
Network.KUCOIN,
Network.KUCOIN_TESTNET,
Network.OASIS,
Network.OASIS_TESTNET,
Network.OPTIMISM,
Network.OPTIMISM_TESTNET,
Network.HARMONY_ONE_SHARD_0,
Network.HARMONY_ONE_TESTNET_SHARD_0,
Network.KLAYTN,
Network.KLAYTN_BAOBAB,
Network.FLARE_COSTON,
Network.FLARE_COSTON_2,
Network.FLARE,
Network.FLARE_SONGBIRD,
Network.HAQQ,
Network.HAQQ_TESTNET,
Network.ARBITRUM_NOVA,
Network.ARBITRUM_NOVA_TESTNET,
Network.ARBITRUM_ONE,
Network.BINANCE_SMART_CHAIN,
Network.HORIZEN_EON,
Network.HORIZEN_EON_GOBI,
Network.CHILIZ

Package Sidebar

Install

npm i @tatumio/evm-wallet-provider

Weekly Downloads

21

Version

1.0.11

License

MIT

Unpacked Size

48 kB

Total Files

27

Last publish

Collaborators

  • jiriandras
  • smrecz
  • npwork.tatum
  • sramkos
  • hathoriel