๐Ÿ“ฆ FuelLabs / fuels-ts

๐Ÿ“„ README.md ยท 52 lines
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52# `@fuel-ts/contract`

**@fuel-ts/contract** is a sub-module for interacting with **Fuel**.

This module allows for a simple way to serialize calls and transactions to an on-chain contract and deserialize their results and emitted logs.

# Table of contents

- [Documentation](#documentation)
- [Usage](#usage)
  - [Installation](#installation)
  - [Full SDK Installation](#full-sdk-installation)
- [Contributing](#contributing)
- [Changelog](#changelog)
- [License](#license)

## Documentation

See [Fuels-ts Documentation](https://docs.fuel.network/docs/fuels-ts/contracts/)

## Usage

### Installation

```sh
pnpm add @fuel-ts/contract
# or
npm add @fuel-ts/contract
```

### Full SDK Installation

Alternatively, we recommend you install the [complete SDK](https://github.com/FuelLabs/fuels-ts) using the umbrella package:

```sh
pnpm add fuels
# or
npm add fuels
```

## Contributing

In order to contribute to `@fuel-ts/contract`, please see the main [fuels-ts](https://github.com/FuelLabs/fuels-ts) monorepo.

## Changelog

The `@fuel-ts/contract` changelog can be found at [CHANGELOG](./CHANGELOG.md).

## License

The primary license for `@fuel-ts/contract` is `Apache 2.0`, see [LICENSE](./LICENSE).