open-index/open-npm huggingface dataset:
npm package: @renec-foundation/wallet-adapter-react
Description: Wallet adapter React UI components shared for Next.js projects
Author: RENEC Foundation
Latest version: 0.2.7-b

# Demon wallet adapter for React

## How to use

##### Install the sdk

```shell
  npm install @renec-foundation/wallet-adapter-react
  // or
  yarn add @renec-foundation/wallet-adapter-react
```

**_In case you are using Next.js, install below module add this to your `next.config.js` file_**

```shell
  npm install next-transpile-modules --save-dev
  // or
  yarn add next-transpile-modules -D
```

_`next.config.js`_:

```typescript
/** @type {import('next').NextConfig} */
const withTM = require("next-transpile-modules")([
  "@renec-foundation/wallet-adapter-react",
]);

module.exports = withTM({});
```

##### Integrate

1. Import css

   ```js
   import "@renec-foundation/wallet-adapter-react/src/style.css";
   ```

2. Add provider

   ```js
   import { Provider as WalletProvider } from "@renec-foundation/wallet-adapter-react";

   <WalletProvider isMainnet={true} e2eWalletPrivKey={""}>
     {children}
   </WalletProvider>;
   ```

   - **Require**
     - **isMainnet**: Choose either `true` or `false` to select the mainnet or testnet.
   - **Optional**
     - **e2eWalletPrivKey**: The passphrase of the test wallet used for end-to-end (e2e) testing.

##### Import button connect

```js
import { WalletMultiButton as DemonWalletConnect } from "@renec-foundation/wallet-adapter-react";
// or
const DemonWalletConnect = dynamic(
  async () =>
    (await import("@renec-foundation/wallet-adapter-react")).WalletMultiButton,
  { ssr: false }
);
```

- using the button

```js
// Default
<DemonWalletConnect />

// Customs
<DemonWalletConnect
  listMenuItems={
    <>
      <li onClick={undefine}>
        {'Title 1'}
      </li>
      <li onClick={undefine}>
        {'Title 2'}
      </li>
    </>
  }
/>
```

- **className?: string**: The class add-ons for button
- **disabled?: boolean**: Disabled button
- **endIcon?: ReactElement**: The end icon in button
- **beginIcon?: ReactElement**: The begin icon in button
- **style?: CSSProperties**: The style of button
- **listMenuItems**: The list contains custom add-ons
- **tabIndex?: number**: The tab Index
npm package: @renegade-fi/base-sepolia-match
Description: Example of fetching and assembling base sepolia matches using Renegade SDK
Latest version: 0.0.8

### External Match Example
This example demonstrates how to fetch and assemble an external match on Base Sepolia.

## Setup

1. Install dependencies:
```bash
pnpm install
```

2. Set up environment variables:
```bash
cp .env.example .env
```
Then replace the values with your own API key and secret.

3. Run the example:
```bash
pnpm start
```

## What's happening?
An external match is a match between an order internal to the darkpool, and an order external to the darkpool. An external party (this script) requests a quote for the order, and assembles the quote into a bundle, if the quote is acceptable. The bundle contains a transaction which may be submitted on-chain to settle the match.

The flow of this example is as follows:

1. Get a quote for the order
2. Assemble the quote into a bundle
3. Submit the bundle to the chain

_Note: [In-kind gas sponsorship](../in-kind-gas-sponsorship/README.md) is enabled by default. You can see this by inspecting your resulting TX._
npm package: @renegade-fi/cli
Description: A CLI tool for interacting with the Renegade protocol
Latest version: 0.0.10

# Renegade CLI

A command-line interface tool for interacting with the Renegade protocol.

## Installation

Install globally using npm (or your preferred package manager)
```bash
npm install -g @renegade-fi/cli
```

```bash
yarn global add @renegade-fi/cli
```

```bash
pnpm add -g @renegade-fi/cli
```

```bash
bun install -g @renegade-fi/cli
```

## Getting Started

### 1. Prepare Your Wallet File
You'll need a wallet secrets file (JSON format) that looks like this:

```json
{
  "wallet_id": "****-****-****-****",
  "blinder_seed": "0x***",
  "share_seed": "0x***",
  "symmetric_key": "0x***",
  "sk_match": "0x***"
}
```

To generate this file, follow the instructions at: https://docs.renegade.fi/technical-reference/typescript-sdk#generating-wallet-secrets

Note: This wallet file only enables read operations (like viewing balances and orders).

### 2. Configure the CLI
Run the setup command to configure your environment:
```bash
renegade setup
```

The setup will prompt you for:
- Path to your wallet secrets file
- Chain selection:
  - Arbitrum One (42161)
  - Arbitrum Sepolia (421614)

You can later view or modify these settings using:
```bash
# View current configuration
renegade config

# Reset configuration and run setup again
renegade config reset
```

You can also temporarily override the configured settings for any command:
```bash
# Use a different wallet file
renegade wallet --wallet-path=/path/to/other/wallet.json

# Use a different chain
renegade wallet --chain-id=421614
```

## Available Commands

### Setup
Configure your environment settings:
```bash
renegade setup
```

### Config
View and reset CLI configuration:
```bash
# View current configuration
renegade config

# Reset configuration
renegade config reset
```

### Wallet
View wallet status and balance. By default shows all wallet information.

```bash
# View all wallet information
renegade wallet

# View only open orders
renegade wallet --field=orders

# View only token balances
renegade wallet --field=balances

# View only fee balances
renegade wallet --field=fees

# Include default/zero values in output
renegade wallet --no-filter
```

### Order History
View detailed order history including fill percentages and execution details. Use this command for a more comprehensive view of your orders compared to the basic order list in the wallet command.

```bash
# View last 10 orders
renegade order-history

# View specific number of orders
renegade order-history --limit 20
```

### Task History
View your task history. By default shows last 10 tasks.

```bash
# View last 10 tasks
renegade task-history

# View specific number of tasks
renegade task-history --limit 20
```
npm package: @renegade-fi/core
Description: VanillaJS library for Renegade
Latest version: 1.0.0

# @renegade-fi/core

VanillaJS library for Renegade

## Installation

```bash
pnpm add @renegade-fi/core
```

## Documentation

For documentation and guides, visit [the docs](https://docs.renegade.fi/technical-reference/typescript-sdk).
npm package: @renegade-fi/external-match-example
Description: Example of fetching and assembling external matches using Renegade SDK
Latest version: 1.1.32

### External Match Example
This example demonstrates how to fetch and assemble an external match. 

## Setup

1. Install dependencies:
```bash
pnpm install
```

2. Set up environment variables:
```bash
cp .env.example .env
```
Then replace the values with your own API key and secret.

3. Run the example:
```bash
pnpm start
```

## What's happening?
An external match is a match between an order internal to the darkpool, and an order external to the darkpool. An external party (this script) requests a quote for the order, and assembles the quote into a bundle, if the quote is acceptable. The bundle contains a transaction which may be submitted on-chain to settle the match.

The flow of this example is as follows:

1. Get a quote for the order
2. Assemble the quote into a bundle
3. Submit the bundle to the chain

_Note: [In-kind gas sponsorship](../in-kind-gas-sponsorship/README.md) is enabled by default. You can see this by inspecting your resulting TX._
npm package: @renegade-fi/node
Description: Node.js library for Renegade
Latest version: 1.0.0

# @renegade-fi/node

Node.js library for Renegade

## Installation

```bash
pnpm add @renegade-fi/node
```

## Documentation

For documentation and guides, visit [the docs](https://docs.renegade.fi/technical-reference/typescript-sdk).
npm package: @renegade-fi/price-reporter
Description: A TypeScript client for interacting with the Price Reporter
Latest version: 1.0.0

# @renegade-fi/price-reporter

A TypeScript client for interacting with the Price Reporter

## Installation

```bash
pnpm add @renegade-fi/price-reporter
```

## Documentation

For documentation and guides, visit [the docs](https://docs.renegade.fi/technical-reference/typescript-sdk).
npm package: @renegade-fi/react
Description: React library for Renegade
Latest version: 1.0.0

# @renegade-fi/react

React library for Renegade

## Installation

```bash
pnpm add @renegade-fi/react
```

## Documentation

For documentation and guides, visit [the docs](https://docs.renegade.fi/technical-reference/typescript-sdk).
npm package: @renegade-fi/renegade-sdk
Description: A TypeScript client for interacting with the Renegade Darkpool API
Latest version: 2.0.1

# Renegade External Match Client

A TypeScript client for interacting with the Renegade Darkpool's External Match API.

## Installation

```bash
# Using npm
npm install @renegade-fi/renegade-sdk

# Using yarn
yarn add @renegade-fi/renegade-sdk

# Using bun
bun add @renegade-fi/renegade-sdk
```

## Usage

See the [examples](examples) for usage examples.

## Documentation

See the following resources for more information:
- [Examples From the Existing SDK](https://github.com/renegade-fi/typescript-sdk/tree/main/examples)
- [Renegade Docs](https://docs.renegade.fi/technical-reference/typescript-sdk#external-atomic-matching)
- [OpenAPI spec](https://github.com/renegade-fi/renegade-docs/blob/main/api-specs/external-match-openapi.yaml)

## License

MIT
npm package: @renegade-fi/supported-tokens
Description: Example of fetching supported tokens and their prices using Renegade SDK
Latest version: 0.0.7

### Supported Tokens Example
This example demonstrates how to fetch supported tokens and their prices for the configured chain.

## Setup

1. Install dependencies:
```bash
pnpm install
```

2. Set up environment variables:
```bash
cp .env.example .env
```
Then replace the values with your own API key and secret.

3. Run the example:
```bash
pnpm start
```
npm package: @renegade-fi/token
Description: Token remapping for Renegade
Latest version: 1.0.0

# @renegade-fi/token

Token remapping for Renegade

## Installation

```bash
pnpm add @renegade-fi/token
```

## Documentation

For documentation and guides, visit [the docs](https://docs.renegade.fi/technical-reference/typescript-sdk).
npm package: @renegade-fi/token-nextjs
Description: Token remapping for Renegade, preconfigured for Next.js
Latest version: 1.0.0

# @renegade-fi/token

Token remapping for Renegade, preconfigured for Next.js.

## Installation

```bash
pnpm add @renegade-fi/token
```

## Documentation

Set the `NEXT_PUBLIC_TOKEN_MAPPING` environment variable to the token remap.
npm package: @renegade-fi/types
Description: Types for the Renegade SDK
Latest version: 1.0.0

# @renegade-fi/price-reporter

TypeScript types for the Renegade SDK

## Installation

```bash
pnpm add @renegade-fi/types
```

## Documentation

For documentation and guides, visit [the docs](https://docs.renegade.fi/technical-reference/typescript-sdk).