# @windingtree/sdk-types

> Typescript types for the Windingtree market protocol SDK

Latest version **1.1.4** (published 2024-01-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install @windingtree/sdk-types
pnpm add @windingtree/sdk-types
yarn add @windingtree/sdk-types
bun add @windingtree/sdk-types
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.4 |
| Published | 2024-01-17 |
| First published | 2023-07-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 27.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Kostiantyn Smyrnov |
| Maintainers | valera_rozuvan, kostysh, kvakes, tomashq |

## Links

- npm: https://www.npmjs.com/package/@windingtree/sdk-types
- Repository: https://github.com/windingtree/sdk.git#readme
- Homepage: https://github.com/windingtree/sdk/tree/readme#readme
- Issues: https://github.com/windingtree/sdk/issues
- npm.io page: https://npm.io/package/@windingtree/sdk-types

## Dependencies (1)

- [viem](https://npm.io/package/viem.md) ^1.19.13

## Recent versions

- 1.1.4 (latest) — 2024-01-17
- 1.1.4-beta.0 (beta) — 2024-01-17
- 1.1.3 — 2023-12-11
- 1.1.2 — 2023-10-31
- 1.1.1 — 2023-10-25
- 1.1.1-beta.0 — 2023-10-25
- 1.1.0 — 2023-07-27
- 1.1.0-beta.3 — 2023-07-27
- 1.1.0-beta.2 — 2023-07-27
- 1.1.0-beta.1 — 2023-07-23
- 1.1.0-beta.0 — 2023-07-23

## README

# @windingtree/sdk-types

The `@windingtree/sdk-types` package provides a collection of TypeScript interfaces and types which are commonly used across the Winding Tree SDK. It includes data types for messages, requests, offers, deals, contracts, and various configuration options.

## Installation

```bash
pnpm i @windingtree/sdk-types
```

## Key concepts

This package encapsulates a variety of data types used across the SDK:

- Message, Request, Offer, and Deal types: These provide structure for core data transactions within the SDK.
- ContractConfig and Contracts: These interfaces define configurations for interacting with Ethereum smart contracts.
- PaginationOptions: This interface is used for paged responses in some methods.
- Other utility types such as NodeKeyJson, PeerOptions, ChainsConfigOption, NoncePeriodOption and more.

## Usage

These types are generally used for type checking purposes within the SDK and might not be directly interacted with during typical usage of the SDK. They are imported when needed for type annotations in TypeScript files.

```typescript
import { RequestData, GenericQuery } from '@windingtree/sdk-types';

const requestData: RequestData<GenericQuery> = {
  // populate data here
};
```

## Documentation

For full documentation and examples, visit [windingtree.github.io/sdk](https://windingtree.github.io/sdk)

## Testing

```bash
pnpm test
```

## Contributing

[Contribution guidelines](https://windingtree.github.io/sdk/#/docs/contribution)

---
_Source: https://npm.io/package/@windingtree/sdk-types · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._