Web3dart

https://github.com/xclud/web3dart
Admin
A Dart library for interacting with the Ethereum blockchain, enabling transactions, smart contract...
Tokens:1,773
Snippets:9
Trust Score:9.1
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Configure Analyzer Exclusions for Generated Files

Source: https://github.com/xclud/web3dart/blob/main/README.md

Provides an example of an `analysis_options.yaml` file to exclude generated `.g.dart` files from Dart's static analysis. This helps prevent warnings related to naming conventions in automatically generated code.

```yaml
analyzer:
  exclude: 
    - '**/*.g.dart'
```

--------------------------------

### Run Tests with Dart

Source: https://github.com/xclud/web3dart/blob/main/README.md

A simple command to execute tests for a Dart project using the `dart test` command.

```dart
dart test test
```

--------------------------------

### Connect to an Ethereum RPC server and query balance

Source: https://github.com/xclud/web3dart/blob/main/README.md

Illustrates how to establish a connection to an Ethereum RPC endpoint using an HTTP client. It demonstrates querying the Ether balance of a given address.

```dart
import 'package:http/http.dart'; //You can also import the browser version
import 'package:web3dart/web3dart.dart';

var apiUrl = "http://localhost:7545"; //Replace with your API

var httpClient = Client();
var ethClient = Web3Client(apiUrl, httpClient);

var credentials = EthPrivateKey.fromHex("0x...");
var address = credentials.address;

// You can now call rpc methods. This one will query the amount of Ether you own
EtherAmount balance = ethClient.getBalance(address);
print(balance.getValueInUnit(EtherUnit.ether));
```

--------------------------------

### Create and manage Ethereum credentials from private keys

Source: https://github.com/xclud/web3dart/blob/main/README.md

Demonstrates how to create Ethereum credentials using private keys, either from a hexadecimal string or by generating a new random key. It also shows how to derive the public key and address from the credentials.

```dart
import 'dart:math'; //used for the random number generator

import 'package:web3dart/web3dart.dart';
// You can create Credentials from private keys
Credentials fromHex = EthPrivateKey.fromHex("c87509a[...]dc0d3");

// Or generate a new key randomly
var rng = Random.secure();
Credentials random = EthPrivateKey.createRandom(rng);

// In either way, the library can derive the public key and the address
// from a private key:
var address = credentials.address;
print(address.hex);
```

--------------------------------

### Create and export new Ethereum wallet files

Source: https://github.com/xclud/web3dart/blob/main/README.md

Shows how to create a new Ethereum wallet file using provided credentials and a password. The generated wallet can be exported as a JSON string, compatible with clients like MyEtherWallet.

```dart
import 'package:web3dart/web3dart.dart';

Wallet wallet = Wallet.createNew(credentials, "password", random);
print(wallet.toJson());
```

--------------------------------

### Generate Smart Contract Dart Code

Source: https://github.com/xclud/web3dart/blob/main/README.md

Explains how to generate Dart code for smart contract interaction using Dart's build system. This involves placing the contract's ABI JSON file (ending with `.abi.json`) in the `lib/` directory, adding `build_runner` as a dev dependency, and running the build command.

```dart
pub run build_runner build
```

--------------------------------

### Load Ethereum credentials from V3 wallet files

Source: https://github.com/xclud/web3dart/blob/main/README.md

Explains how to load Ethereum credentials from a V3 wallet file (JSON format) using a password. It covers unlocking the wallet to access the private key for signing transactions.

```dart
import 'dart:io';
import 'package:web3dart/web3dart.dart';

String content = File("wallet.json").readAsStringSync();
Wallet wallet = Wallet.fromJson(content, "testpassword");

Credentials unlocked = wallet.privateKey;
// You can now use these credentials to sign transactions or messages
```

--------------------------------

### Add web3dart_builders Dev Dependency

Source: https://github.com/xclud/web3dart/blob/main/README.md

Shows how to add the web3dart_builders package as a development dependency using the `pub add` command. This package is used in conjunction with Dart's build system to generate Dart code for interacting with smart contracts.

```dart
pub add web3dart_builders --dev
```

--------------------------------

### Send Ethereum Transaction with web3dart

Source: https://github.com/xclud/web3dart/blob/main/README.md

Demonstrates how to create, sign, and send an Ethereum transaction using the web3dart library. It requires an Ethereum client, private key credentials, and transaction details such as recipient address, gas price, and value. Missing transaction parameters like nonce are automatically fetched from the connected node.

```dart
import 'package:web3dart/web3dart';

/// [...], you need to specify the url and your client, see example above
var ethClient = Web3Client(apiUrl, httpClient);

var credentials = EthPrivateKey.fromHex("0x...");

await client.sendTransaction(
  credentials,
  Transaction(
    to: EthereumAddress.fromHex('0xC91...3706'),
    gasPrice: EtherAmount.inWei(BigInt.one),
    maxGas: 100000,
    value: EtherAmount.fromUnitAndValue(EtherUnit.ether, 1),
  ),
);
```
Tokens:
Raw