Skip to content

About

QHooks builder kit: JavaScript SDK, public API docs, module guide and roadmap

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

10 Commits

Folders and files

Repository files navigation

QHooks builder kit

QHooks is an ecosystem for token builders on Uniswap v4: pick or build the hooks a token trades through, launch it, trade it in one terminal, let holders stake, protect creator actions with a second post-quantum key, and integrate it all into your own app. Live at qhooks.com.

This repository is the public toolkit for builders:

Path What it is
sdk/qhooks.mjs The QHooks JavaScript SDK: one ES module, no dependencies, no build step. Read launches, pools, trades and holders; quote through a launch's hook; build swap transactions your users sign in their own wallets. Release source for https://qhooks.com/sdk/qhooks.mjs; compare the SDK version and checksum with the site release before integration.
docs/api.md The free public read API (https://qhooks.com/api/v1): endpoints, SDK functions, limits.
docs/discover.md QHooks Discover: every Uniswap v4 hook across chains with live evidence (permissions, code fingerprint, shared code, owner), the project registry, the Hook Tape on Base and Robinhood Chain, and hook alerts.
docs/modules.md How builder-marketplace modules work, what review checks, and how to submit one.
contracts/ The module template (MIT): QModuleBase plus the staking and raffle reference modules, with checksums and build settings.
examples/ Small runnable examples.
ROADMAP.md What we plan to build next.

The SDK never holds keys or sends transactions. It returns { to, data, value } for the user's wallet to review and send.

Reference modules

QRafflePot uses blockhash randomness. Block producers or sequencers can predict or influence the result, so keep pots small. VRF is planned for a future version. See contracts/README.md for module behavior and tests.

Quick start

import { createClient, withSlippage } from 'https://qhooks.com/sdk/qhooks.mjs';

const q = createClient({ rpc: { '8453': 'https://mainnet.base.org' } });
const pools = await q.pools({ chain: '8453' });

See examples/quote.mjs for a full quote-and-build-transaction example.

Links

License

MIT, see LICENSE. The QHooks name and logo are not covered by the license.

SDK release checks

SDK and package version: 1.2.1. Run npm test without network access. The site release is owned separately; the 1.2.1 site candidate and this repository use byte-identical SDK source. Confirm the deployed version/checksum after that release rather than assuming main has already been deployed.

The standalone SDK includes an MIT-licensed noble Keccak-256 implementation for CREATE2 address checks. Its editable inputs/license are in scripts/vendor/hashes; scripts/build-sdk-hash.mjs regenerates only that embedded section with an existing esbuild installation. No runtime import or npm dependency is required.

About

QHooks builder kit: JavaScript SDK, public API docs, module guide and roadmap

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages