IQ-6900

A Solana-based utility for retrieving and processing on-chain data from the IQ blockchain.

Installation

# Using pnpm (recommended)
pnpm add @sterling/iq-6900

# Using npm
npm install @sterling/iq-6900

# Using yarn
yarn add @sterling/iq-6900

# Using Deno
import { getOnchainJson, getOnchainData } from "@sterling/iq-6900";

Usage

The library provides APIs for retrieving on-chain JSON data:

Get Raw JSON String

import { getOnchainJson } from "@sterling/iq-6900";

// Pass configuration options
const jsonString = await getOnchainJson({
  walletAddress: "your-wallet-address",
  rpcUrl: "https://api.mainnet-beta.solana.com", // Optional
  apiHost: "https://solanacontractapi.uc.r.appspot.com", // Optional
});

console.log(jsonString);

Get Parsed JSON Data (Recommended)

import { getOnchainData } from "@sterling/iq-6900";

// This will automatically parse the JSON for you
const data = await getOnchainData({
  walletAddress: "your-wallet-address",
});

if (data) {
  // TypeScript support with generic type parameter
  const typedData = await getOnchainData<YourDataType>({
    walletAddress: "your-wallet-address",
  });

  console.log(data.someProperty);
}

The original function is still available for backward compatibility:

import { bringAgentWithWalletAddress } from "@sterling/iq-6900";

const jsonString = await bringAgentWithWalletAddress({
  walletAddress: "your-wallet-address",
});

Configuration Options

All functions require a configuration object with the following options:

Development

Setup

# Clone the repository
git clone https://github.com/sterling/iq-6900.git
cd iq-6900

# Install dependencies
pnpm install

Testing

# Run tests
pnpm test

# Run tests with coverage
pnpm test:coverage

# Run tests in watch mode
pnpm test:watch

Building

# Build the package
pnpm build

Contributing

Please see CONTRIBUTING.md for details on how to contribute to this project.

Publishing

To publish a new version:

1. Install the JSR CLI: pnpm add -g @jsr/cli
2. Login: jsr auth
3. Publish: jsr publish

License

ISC