open-index/open-npm huggingface dataset:
npm package: @0xobelisk/sov-client
Description: Sovereign Typescript SDK
Author: Obelisk Labs
Latest version: 0.2.8

# @0xobelisk/sov-client

This is an early experimental client used to communicate with the sequencer

## Install (TODO: Need release to [npmjs](https://www.npmjs.com/))

```typescript
pnpm i @0xobelisk/sov-client
```

## How to use

### Account

```typescript
import {Ed25519Keypair, getFullnodeUrl, SovereignClient} from "@0xobelisk/sov-client"

const main = async () => {
	// import an Ed25519 account
	const test_private_key: Uint8Array = new Uint8Array([
		117, 251, 248, 217, 135, 70, 194, 105, 46, 80, 41, 66, 185, 56, 200, 35,
		121, 253, 9, 234, 159, 91, 96, 212, 211, 158, 135, 225, 180, 36, 104,
		253,
	]);
	const importKeypair = Ed25519Keypair.fromSecretKey(test_private_key, {
		skipValidation: true,
	});
  
	// generate a new Ed25519 account
	const keypair = new Ed25519Keypair();

	console.log(keypair.getPublicKey());
	console.log(keypair.getSecretKey());
	console.log(keypair.toAddress());

	console.log();

	// generate a new Secp256k1 account
	const ethKey = new Secp256k1Keypair();
	console.log(ethKey.getPublicKey());
	console.log(ethKey.getSecretKey());
};

main();
```

### Submit Transaction

> dev in localnet tips: don't forget start the local sov node.

```typescript
import { Ed25519Keypair, Secp256k1Keypair, SovereignClient, getFullnodeUrl } from '@0xobelisk/sov-client';

const main = async () => {
  const nodeApi = getFullnodeUrl('localnet');
  const client = new SovereignClient(nodeApi);

	// call bank.Freeze func
  	const callPayload: any = {
		bank: {
			Freeze: {
				token_id:
					'token_1rwrh8gn2py0dl4vv65twgctmlwck6esm2as9dftumcw89kqqn3nqrduss6',
			},
		},
	};

	// sign and submit tx
  	await client.signAndExecuteTransaction({
		callPayload,
		signer: keypair
	})
};

main();
```


### Call RPC 

> dev in localnet tips: don't forget start the local sov node.

```typescript
import { Ed25519Keypair, Secp256k1Keypair, SovereignClient, getFullnodeUrl } from '@0xobelisk/sov-client';

const main = async () => {
  const nodeApi = getFullnodeUrl('localnet');
  const client = new SovereignClient(nodeApi);

	const params = {
    	user_address:
    		'sov15vspj48hpttzyvxu8kzq5klhvaczcpyxn6z6k0hwpwtzs4a6wkvqwr57gc',
    	token_id:
    		'token_1zdwj8thgev2u3yyrrlekmvtsz4av4tp3m7dm5mx5peejnesga27ss0lusz',
    };
    const balance = await client.query('bank_balanceOf', params);
    console.log(balance);
};

main();
```


### Query Module State

> dev in localnet tips: don't forget start the local sov node.

```typescript
import { Ed25519Keypair, Secp256k1Keypair, SovereignClient, getFullnodeUrl } from '@0xobelisk/sov-client';

const main = async () => {
  const nodeApi = getFullnodeUrl('localnet');
  const client = new SovereignClient(nodeApi);


	const state = await client.get('/xxxx', []);
    console.log(state);
};

main();
```


## How to build `sov-client`

**Clone sov-clone repo**
```bash
git clone https://github.com/Sovereign-Labs/sov-client

cd sov-client
```


**compile sov-client**
```
pnpm i
ts-node scripts/index.ts
```
npm package: @0xobelisk/sui-indexer
Description: Minimal Typescript indexer for Dubhe
Author: team@obelisk.build
Latest version: 1.2.0-pre.51

# sui-indexer

A minimal Typescript indexer for `Sui Move` events (built on [sui-client](https://npmjs.com/package/@0xobelisk/sui-client))

## Usage

Install and run with:

```sh
npm install @0xobelisk/sui-indexer

npm sqlite-indexer
# or
npm postgres-indexer & npm postgres-frontend
```

or execute the one of the package bins directly:

```sh
npx -p @latticexyz/store-indexer sqlite-indexer
# or
npx -p @latticexyz/store-indexer postgres-indexer & npx -p @latticexyz/store-indexer postgres-frontend
```

## Configuration

Each indexer can be configured with environment variables.

### Common environment variables for indexer

| Variable           | Description                                                                                                   | Default |
| ------------------ | ------------------------------------------------------------------------------------------------------------- | ------- |
| `RPC_HTTP_URL`     | HTTP URL for Ethereum RPC to fetch data from                                                                  |         |
| `RPC_WS_URL`       | WebSocket URL for Ethereum RPC to fetch data from                                                             |         |
| `START_BLOCK`      | Block number to start indexing from                                                                           | `0`     |
| `MAX_BLOCK_RANGE`  | Maximum number of blocks to fetch from the RPC per request                                                    | `1000`  |
| `POLLING_INTERVAL` | How often to poll for new blocks (in milliseconds)                                                            | `1000`  |
| `STORE_ADDRESS`    | Optional address of the Dubhe Store to index. By default, store-indexer will index all Dubhe Stores on the chain. |         |

Note that you only need one of `RPC_HTTP_URL` or `RPC_WS_URL`, but we recommend both. The WebSocket URL will be prioritized and fall back to the HTTP URL if there are any connection issues.

### Common environment variables for frontend

| Variable | Description                                      | Default   |
| -------- | ------------------------------------------------ | --------- |
| `HOST`   | Host that the indexer frontend server listens on | `0.0.0.0` |
| `PORT`   | Port that the indexer frontend server listens on | `3001`    |

### Postgres indexer environment variables

| Variable           | Description                                         | Default |
| ------------------ | --------------------------------------------------- | ------- |
| `DATABASE_URL`     | Postgres connection URL                             |         |
| `HEALTHCHECK_HOST` | Host that the indexer healthcheck server listens on |         |
| `HEATHCHECK_PORT`  | Port that the indexer healthcheck server listens on |         |

### SQLite indexer environment variables

| Variable          | Description              | Default      |
| ----------------- | ------------------------ | ------------ |
| `SQLITE_FILENAME` | SQLite database filename | `indexer.db` |
npm package: @0xproject/asset-buyer
Description: Convenience package for discovering and buying assets with Ether.
Latest version: 2.0.0

## @0xproject/asset-buyer

**Warning: In Beta, has not been extensively tested.**

Convenience package for buying assets represented on the Ethereum blockchain using 0x. In its simplest form, the package helps in the usage of the [0x forwarder contract](https://github.com/0xProject/0x-protocol-specification/blob/master/v2/forwarder-specification.md), which allows users to execute [Wrapped Ether](https://weth.io/) based 0x orders without having to set allowances, wrap Ether or own ZRX, meaning they can buy tokens with Ether alone. Given some liquidity (0x signed orders), it helps estimate the Ether cost of buying a certain asset (giving a range) and then buying that asset.

In its more advanced and useful form, it integrates with the [Standard Relayer API](https://github.com/0xProject/standard-relayer-api) and takes care of sourcing liquidity for you given an SRA compliant endpoint. The final result is a library that tells you what assets are available, provides an Ether based quote for any asset desired, and allows you to buy that asset using Ether alone.

## Installation

```bash
yarn add @0xproject/asset-buyer
```

**Import**

```typescript
import { AssetBuyer } from '@0xproject/asset-buyer';
```

or

```javascript
var AssetBuyer = require('@0xproject/asset-buyer').AssetBuyer;
```

If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:

```json
"compilerOptions": {
    "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"],
}
```

## Contributing

We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.

Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.

### Install dependencies

If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:

```bash
yarn config set workspaces-experimental true
```

Then install dependencies

```bash
yarn install
```

### Build

To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:

```bash
PKG=@0xproject/asset-buyer yarn build
```

Or continuously rebuild on change:

```bash
PKG=@0xproject/asset-buyer yarn watch
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```

### Run Tests

```bash
yarn test
```
npm package: @0xproject/dev-utils
Description: 0x dev TS utils
Latest version: 1.0.12

## Dev utils

Dev utils to be shared across 0x projects and packages

## Configuration

Some env variables might be set to change the behaviour of created web3 providers/instances.

```
VERBOSE_GANACHE: boolean. Enables verbose Ganache logging. Every request/response payload. Slightly slower, but useful for testing.
SOLIDITY_COVERAGE: boolean. If set - adds coverage subprovider which intercepts all calls/transactions and can be later used to compute code coverage.
```

Boolean env variables should be either `true` or `false`. Defaults to `false` if not set.

## Install

```bash
yarn add @0xproject/dev-utils
```

If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:

```json
"compilerOptions": {
    "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"],
}
```

## Contributing

We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.

Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.

### Install dependencies

If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:

```bash
yarn config set workspaces-experimental true
```

Then install dependencies

```bash
yarn install
```

### Build

To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:

```bash
PKG=@0xproject/dev-utils yarn build
```

Or continuously rebuild on change:

```bash
PKG=@0xproject/dev-utils yarn watch
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```

### Run Tests

```bash
yarn test
```
npm package: @0xproject/order-utils
Description: 0x order utils
Latest version: 1.0.7

## @0xproject/order-utils

0x order-related utilities for those developing on top of 0x protocol.

### Read the [Documentation](https://0xproject.com/docs/order-utils).

## Installation

```bash
yarn add @0xproject/order-utils
```

If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:

```json
"compilerOptions": {
    "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"],
}
```

## Contributing

We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.

Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.

### Install dependencies

If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:

```bash
yarn config set workspaces-experimental true
```

Then install dependencies

```bash
yarn install
```

### Build

To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:

```bash
PKG=@0xproject/order-utils yarn build
```

Or continuously rebuild on change:

```bash
PKG=@0xproject/order-utils yarn watch
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```
npm package: @0xproject/sol-compiler
Description: Solidity compiler wrapper and artifactor
Author: Amir Bandeali
Latest version: 1.1.7

## @0xproject/sol-compiler

Sol-compiler is a wrapper around [solc-js](https://www.npmjs.com/package/solc) that adds:

*   Smart re-compilation: Only recompiles when smart contracts have changed
*   Ability to compile an entire project instead of only individual `.sol` files
*   Compilation using the Solidity version specified at the top of each individual `.sol` file
*   Proper parsing of Solidity version ranges
*   Support for the standard [input description](https://solidity.readthedocs.io/en/develop/using-the-compiler.html#input-description) for what information you'd like added to the resulting `artifacts` file (i.e 100% configurable artifacts content).

### Read the [Documentation](https://0xproject.com/docs/sol-compiler).

## Installation

#### CLI Installation

```bash
yarn global add @0xproject/sol-compiler
```

#### API Installation

```bash
yarn add @0xproject/sol-compiler
```

If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:

```json
"compilerOptions": {
    "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"],
}
```

**Import**

```typescript
import { Compiler } from '@0xproject/sol-compiler';
```

or

```javascript
var Compiler = require('@0xproject/sol-compiler').Compiler;
```

## Contributing

We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.

Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.

### Install dependencies

If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:

```bash
yarn config set workspaces-experimental true
```

Then install dependencies

```bash
yarn install
```

### Build

To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:

```bash
PKG=@0xproject/sol-compiler yarn build
```

Or continuously rebuild on change:

```bash
PKG=@0xproject/sol-compiler yarn watch
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```

### Run Tests

```bash
yarn test
```
npm package: @0xproject/sol-resolver
Description: Import resolver for smart contracts dependencies
Latest version: 1.0.14

## @0xproject/sol-resolver

A Solidity import resolver used by [sol-compiler](https://github.com/0xProject/0x-monorepo/tree/development/packages/sol-compiler).

## Installation

```bash
yarn add @0xproject/sol-resolver
```

**Import**

```javascript
import { Resolver } from '@0xproject/sol-resolver';
```

or

```javascript
var Resolver = require('@0xproject/sol-resolver').Resolver;
```

## Contributing

We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.

Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.

### Install dependencies

If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:

```bash
yarn config set workspaces-experimental true
```

Then install dependencies

```bash
yarn install
```

### Build

To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:

```bash
PKG=@0xproject/sol-resolver yarn build
```

Or continuously rebuild on change:

```bash
PKG=@0xproject/sol-resolver yarn watch
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```
npm package: @0xproject/tslint-config
Description: Lint rules related to 0xProject for TSLint
Author: Fabio Berger
Latest version: 1.0.8

## @0xproject/tslint-config

TSLint configuration and custom linter rules used by 0xProject.

## Installation

```bash
yarn add --dev @0xproject/tslint-config
```

## Usage

Add the following to your `tslint.json` file

```json
{
    "extends": ["@0xproject/tslint-config"]
}
```

## Contributing

We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.

Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.

### Install dependencies

If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:

```bash
yarn config set workspaces-experimental true
```

Then install dependencies

```bash
yarn install
```

### Build

To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:

```bash
PKG=@0xproject/tslint-config yarn build
```

Or continuously rebuild on change:

```bash
PKG=@0xproject/tslint-config yarn watch
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```

### Run Tests

```bash
yarn test
```
npm package: @0xproject/types
Description: 0x types
Latest version: 1.1.4

## @0xproject/types

Typescript types shared across 0x projects and packages

## Installation

```bash
yarn add -D @0xproject/types
```

If your project is in [TypeScript](https://www.typescriptlang.org/), add the following to your `tsconfig.json`:

```json
"compilerOptions": {
    "typeRoots": ["node_modules/@0xproject/typescript-typings/types", "node_modules/@types"],
}
```

## Usage

```javascript
import { TransactionReceipt, TxData, TxDataPayable } from '@0xproject/types';
```

## Contributing

We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.

Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.

### Install dependencies

If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:

```bash
yarn config set workspaces-experimental true
```

Then install dependencies

```bash
yarn install
```

### Build

To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:

```bash
PKG=@0xproject/types yarn build
```

Or continuously rebuild on change:

```bash
PKG=@0xproject/types yarn watch
```

### Clean

```bash
yarn clean
```

### Lint

```bash
yarn lint
```