> For the complete documentation index, see [llms.txt](https://suisec.gitbook.io/suisec/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://suisec.gitbook.io/suisec/honeypot-detection/introduction.md).

# Introduction

`HoneyPotDetection` is a JavaScript/TypeScript library for identifying identifying HoneyPots.

## Installation

```bash
npm install suihoneypot
```

## Usage

```typescript
import { isHoneyPot } from 'suihoneypot';

const ca: string = "0x566923c3995f64c3f861e694da52cdc79d8b968bfcdb7f8a275c19c73fd9b99d::brett::BRETT"
const res = await isHoneyPot(ca);
console.log(res);
```

### Example Hint

> This token is detected to have Deny List feature. It's an optional feature on Sui designed for regulated coins (like stable coins). However, it could be misused by HoneyPot scams, which may restrict users from selling the tokens after buying. Please be cautious.

* Github: <https://github.com/SuiSec/HoneyPotDetectionOnSui>
* NPM: <https://www.npmjs.com/package/suihoneypot>