open-index/open-npm huggingface dataset:
npm package: @planq-network/base
Description: Planq base common utils, no dependencies
Author: Planq
Latest version: 4.1.0


# @planq-network/base

This package contains shared classes and functions used by other planq packages. It was designed to have minimal external dependencies. (for shared planq functions that have big external dependencies see the @planq-network/utils, @planq-network/cryptographic-utils, @planq-network/phone-utils, @planq-network/network-utils packages)


## Notable Types

```typescript
// enums StableTokens and Token are enums, PlanqTokenType is the type that must be one of the 2 enums
import { StableTokens, Token, PlanqTokenType } from "@planq-network/base"

StableTokens.aUSD

StableTokens.aREAL

Token.PLQ
```

## Notable Functions

```typescript
import { eqAddress, normalizeAddress, isNullAddress } from "@planq-network/base"
```
npm package: @planq-network/connect
Description: Light Toolkit for connecting with the Planq network
Author: Planq
Latest version: 4.1.0

# @planq-network/connect


*Connect to the Planq Blockchain.*  `Connection` provides the core of what you need to interact with Planq blockchain. The Core Difference between it and ContractKit is that it provides zero Contract Wrappers, and therefore leaves out convenience methods for example for setting FeeCurrency, or getting configs.

## Examples

### Basic

```typescript
import { Connection, PlanqProvider } from '@planq-network/connect'

const web3 = new Web3("YOUR_RPC_URL")
const connection = new Connection(web3)

connection.setProvider()

const connectedChainID =  await connection.chainId()

```

For a raw transaction:

```ts
const onePlanq = connection.web3.utils.toWei('1', 'ether')

const tx = connection.sendTransaction({
  from: myAddress,
  to: someAddress,
  value: onePlanq,
})
const hash = await tx.getHash()
const receipt = await tx.waitReceipt()
```
npm package: @planq-network/identity
Description: Utilities for interacting with Planq's identity protocol
Author: Planq
Latest version: 4.1.1

# @planq-network/identity

@planq-network/identity simplifies interacting with ODIS, Planq’s lightweight identity layer based on phone numbers.

You can find an example of how to use this package to do ODIS lookups [here](https://github.com/critesjosh/register-number).
npm package: @planq-network/phone-utils
Description: Planq phone utils
Author: Planq
Latest version: 4.1.0

# @planq-network/phone-utils

These are A collection of functions for formatting and reading phonenumbers used by the v1 Attestation Service and wallets such as Valora. It uses `google-lib-phonenumber`,  under the hood.


It may be deprecated in the future.
npm package: @planqk/planqk-api-sdk
Description: SDK to interact with the official PLANQK API.
Author: Kipu Quantum GmbH
Latest version: 1.9.4
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

> **⚠️ DEPRECATED ⚠️**  
> 
> **This package has been deprecated and is no longer maintained.**
> 
> Please migrate to the new package: 
> - PyPI: **[`qhub-api`](https://pypi.org/project/qhub-api)**
> - NPM: **[`@quantum-hub/qhub-api`](https://www.npmjs.com/package/@quantum-hub/qhub-api)**
> 
> Install the new package:
> ```bash
> pip install qhub-api
> # or
> npm install @quantum-hub/qhub-api
> ```

---

# planqk-api-sdk

This repository contains the SDK to interact with the official PLANQK API.
The clients are generated from a [OpenAPI](https://swagger.io/specification) description using [Fern](https://buildwithfern.com).
The generated clients are a baseline, and the idea is to adapt and extend them to our specific needs.

## Generate the SDK clients with Fern

> <https://buildwithfern.com/docs/getting-started>

```bash
npm install -g fern-api
fern upgrade
fern generate
```

## Python Setup

To create a new virtual environment and install the dependencies, run:

```bash
uv venv
source .venv/bin/activate

uv sync
```

Update dependencies and lock files:

```bash
uv sync -U
```

## How to update the Python client?

After generating the SDK clients with Fern, the Python client needs to be copied manually.

Copy the content of `./generated/python` to `./planqk/api/sdk`.
Make sure you overwrite any existing files.
It is recommended to remove the old files first.

Next, check if the changes are compatible with our wrapper, e.g., by running the Jupyter notebook in the `notebooks` directory.

## How to update the TypeScript client?

After generating the SDK clients with Fern, the TypeScript client needs to be copied manually.

Copy the content of `./generated/typescript` to `./typescript/src/sdk`.
Make sure you overwrite any existing files.
It is recommended to remove the old files first.

Next, check if the changes are compatible with our wrapper, e.g., by running the `index.test.ts` file.

## License

Apache-2.0 | Copyright 2025 Kipu Quantum GmbH
npm package: @planqk/planqk-cli
Description: PLANQK CLI
Author: Kipu Quantum GmbH
Latest version: 2.42.2
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

> **⚠️ DEPRECATED ⚠️**  
> 
> **This package has been deprecated and is no longer maintained.**
> 
> Please migrate to the new package: 
> - NPM: **[`@quantum-hub/qhubctl`](https://www.npmjs.com/package/@quantum-hub/qhubctl)**
> 
> Install the new package:
> ```bash
> npm install @quantum-hub/qhubctl
> ```

---


# planqk-cli

The PLANQK Command Line Interface (CLI) lets you interact with the PLANQK Platform directly from your terminal.
We have installation instructions to guide you through the initial setup in our
[quickstart](https://docs.hub.kipu-quantum.com/quickstart.html) guide.

Detailed information about the supported commands can be found in our
[CLI reference](https://docs.hub.kipu-quantum.com/cli-reference.html).

## Installation

To install the PLANQK CLI, you must install Node.js and the npm command line interface using either a
[Node version manager](https://github.com/nvm-sh/nvm) or a [Node installer](https://nodejs.org/en/download).

**Make sure you install Node.js version 18 or higher.**

Then install the PLANQK CLI globally using npm:

```bash
npm install -g @planqk/planqk-cli
```

You can use the `--help` flag to get information about the supported commands:

``` bash
planqk --help
```

You may also get information about a specific command:

``` bash
planqk <command> --help
```

> **Troubleshooting:**
> If you experience `EACCES permissions` errors during installation, we recommend using [Node version manager](https://github.com/nvm-sh/nvm) (nvm).
> Further, you may refer to the official [npm documentation](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally) how to resolve such issues.

## License

Apache-2.0 | Copyright 2023-now Kipu Quantum GmbH
npm package: @planqk/planqk-service-sdk
Description: SDK to interact with PLANQK Managed Services.
Author: Kipu Quantum GmbH
Latest version: 2.12.1
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

> **⚠️ DEPRECATED ⚠️**  
> 
> **This package has been deprecated and is no longer maintained.**
> 
> Please migrate to the new package: 
> - PyPI: **[`qhub-service`](https://pypi.org/project/qhub-service)**
> - NPM: **[`@quantum-hub/qhub-service`](https://www.npmjs.com/package/@quantum-hub/qhub-service)**
> 
> Install the new package:
> ```bash
> pip install qhub-service
> # or
> npm install @quantum-hub/qhub-service
> ```

---

# planqk-service-sdk

This repository contains the SDK clients to execute PLANQK Managed Services.
The clients are generated from a very general [OpenAPI](https://swagger.io/specification) description using [Fern](https://buildwithfern.com).
The generated clients are a baseline, and the idea is to adapt and extend them to our specific needs.

## Generate the SDK clients with Fern

> <https://buildwithfern.com/docs/getting-started>

```bash
npm install -g fern-api
fern upgrade
fern generate
```

## Python Setup

To create a new virtual environment and install the dependencies, run:

```bash
uv venv
source .venv/bin/activate

uv sync
```

Update dependencies and lock files:

```bash
uv sync -U
```

## How to update the Python client?

After generating the SDK clients with Fern, the Python client needs to be copied manually.

Copy the content of `./generated/python` to `./planqk/service/sdk`.
Make sure you overwrite any existing files.
It is recommended to remove the old files first.

Next, check by executing `pytest` if the changes are compatible with our wrapper.

## How to update the TypeScript client?

After generating the SDK clients with Fern, the TypeScript client needs to be copied manually.

Copy the content of `./generated/typescript` to `./typescript/src/sdk`.
Make sure you overwrite any existing files.
It is recommended to remove the old files first.

Next, check by executing `npm test` if the changes are compatible with our wrapper.

## License

Apache-2.0 | Copyright 2023-2024 Kipu Quantum GmbH