Skip to content

Latest commit

 

History

History
66 lines (46 loc) · 1.29 KB

README.md

File metadata and controls

66 lines (46 loc) · 1.29 KB

tfchain_client

This a Dart client to communicate with TFChain.

dart pub get

Usage

There are 2 types of client. one for just query the chain and the other one for query and do transaction on the chain.

Query Client

import 'package:tfchain_client/tfchain_client.dart';

final client = QueryClient("wss://tfchain.dev.grid.tf/ws");
await client.connect();
final contract = await client.contracts.get(contractId: BigInt.from(123456));
print(contract!.toJson());
await client.disconnect();

Full Client

final client = Client("wss://tfchain.dev.grid.tf/ws", "your-mnemonic", "sr25519");
client.connect();
final farmId = await client.farms.create(CreateFarmOptions(name: "name"));
print(farmId);
await client.disconnect();

Generating Functions

To generate functions for the chain, add the following configuration in pubspec.yaml:

polkadart:
  output_dir: lib/generated
  chains:
    dev: chain-url

Then run the following command:

dart run polkadart_cli:generate -v

Run Tests

Prerequisites

1- To run the tests against a local docker image of the TFChain:

docker run --network host ghcr.io/threefoldtech/tfchain --dev --rpc-cors all --rpc-external --rpc-methods=safe

2- Then run:

 dart test --concurrency=1