# @freemarket/funkit

> This module provides an integration between FunWallet and Free Market.

Latest version **0.1.0** (published 2023-10-23) · 0 weekly downloads

## Install

```sh
npm install @freemarket/funkit
pnpm add @freemarket/funkit
yarn add @freemarket/funkit
bun add @freemarket/funkit
```

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2023-10-23 |
| First published | 2023-10-23 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 32 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | freemarketlabs |

## Links

- npm: https://www.npmjs.com/package/@freemarket/funkit
- npm.io page: https://npm.io/package/@freemarket/funkit

## Dependencies (3)

- [@funkit/core](https://npm.io/package/@funkit/core.md) *
- [@freemarket/client-sdk](https://npm.io/package/@freemarket/client-sdk.md) ^0.3.0
- [@ethersproject/providers](https://npm.io/package/@ethersproject/providers.md) ^5.7.2

## Recent versions

- 0.1.0 (latest) — 2023-10-23

## README

# Free Market Integration Library for FunKit Wallet

This module provides an integration between FunWallet and Free Market.  

## Installation

```bash
npm install  -S @funfair-tech/fun-wallet-integration
```

## Usage

This library extends the definition of `FunWallet` to include an additional method `executeWorkflow` which enables 
the wallet to execute Free Market workflows with a single line of code.  

To use this library, you must first create a `FunWallet` instance as normal.  Then invoke the helper function `addExecuteWorkflow` to add the `executeWorkflow` method to the `FunWallet` instance:

```typescript
import { addExecuteWorkflow } from '@freemarket/funkit'

// create FunWallet instance as normal
const baseFunWallet: FunWallet =  /* omitted for brevity */ 

// add the exececuteWorkflow method to it
const funWallet = addExecuteWorkflow(baseFunWallet)

// now you can use the executeWorkflow method
const workflow: Workflow =  /* omitted for brevity */
const args: Arguments = {}
const result = await funWallet.executeWorkflow(workflow, args)
```

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