# @ocap/client > graphql client to read/write data on arcblock blockchain Latest version **1.30.24** (published 2026-05-14) · Apache-2.0 license · 637 weekly downloads ## Install ```sh npm install @ocap/client pnpm add @ocap/client yarn add @ocap/client bun add @ocap/client ``` ## Health **Score 60/100 (C)** — status: active. Positive: has types; esm support; no vulnerabilities; high quality score. Warnings: low downloads. ## Facts | | | |---|---| | Version | 1.30.24 | | Published | 2026-05-14 | | First published | 2021-03-09 | | Weekly downloads | 637 | | License | Apache-2.0 | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 20 | | Unpacked size | 5 MB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | wangshijun | | Maintainers | wangshijun, polunzh, mave99a | | Keywords | graphql, client, blockchain, arcblock | ## Links - npm: https://www.npmjs.com/package/@ocap/client - Repository: https://github.com/ArcBlock/blockchain - Homepage: https://www.arcblock.io/docs/blockchain-sdk-nodejs - Issues: https://github.com/ArcBlock/blockchain/issues - npm.io page: https://npm.io/package/@ocap/client ## Dependencies (20) - [debug](https://npm.io/package/debug.md) ^4.4.3 - [buffer](https://npm.io/package/buffer.md) 6.0.3 - [lodash](https://npm.io/package/lodash.md) ^4.17.23 - [jsonpack](https://npm.io/package/jsonpack.md) ^1.1.5 - [@ocap/util](https://npm.io/package/@ocap/util.md) 1.30.24 - [@ocap/asset](https://npm.io/package/@ocap/asset.md) 1.30.24 - [@ocap/proto](https://npm.io/package/@ocap/proto.md) 1.30.24 - [blueimp-md5](https://npm.io/package/blueimp-md5.md) ^2.19.0 - [@arcblock/ws](https://npm.io/package/@arcblock/ws.md) 1.30.24 - [@ocap/wallet](https://npm.io/package/@ocap/wallet.md) 1.30.24 - [@arcblock/did](https://npm.io/package/@arcblock/did.md) 1.30.24 - [@arcblock/jwt](https://npm.io/package/@arcblock/jwt.md) 1.30.24 - [@ocap/mcrypto](https://npm.io/package/@ocap/mcrypto.md) 1.30.24 - [@ocap/message](https://npm.io/package/@ocap/message.md) 1.30.24 - [is-absolute-url](https://npm.io/package/is-absolute-url.md) ^3.0.3 - [readable-stream](https://npm.io/package/readable-stream.md) 3.6.0 - [@arcblock/did-util](https://npm.io/package/@arcblock/did-util.md) 1.30.24 - [@arcblock/sdk-util](https://npm.io/package/@arcblock/sdk-util.md) ^0.36.4 - [react-app-polyfill](https://npm.io/package/react-app-polyfill.md) ^1.0.6 - [wolfy87-eventemitter](https://npm.io/package/wolfy87-eventemitter.md) ^5.2.9 ## Alternatives - [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads - [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads - [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads - [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads - [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads ## Recent versions - 1.30.24 (latest) — 2026-05-14 - 1.30.23 — 2026-05-13 - 1.30.22 — 2026-05-13 - 1.30.21 — 2026-05-12 - 1.30.20 — 2026-05-12 - 1.30.19 — 2026-05-12 - 1.30.18 — 2026-05-11 - 1.30.17 — 2026-05-11 - 1.30.16 — 2026-05-10 - 1.30.15 — 2026-05-08 - 1.30.14 — 2026-05-08 - 1.30.13 — 2026-05-08 - 1.30.12 — 2026-05-05 - 1.30.11 — 2026-05-03 - 1.30.10 — 2026-04-22 - … 598 more at https://npm.io/package/@ocap/client/versions ## README ![graphql-client](https://www.arcblock.io/.netlify/functions/badge/?text=graphql-client) [![docs](https://img.shields.io/badge/powered%20by-arcblock-green.svg)](https://docs.arcblock.io) [![Gitter](https://badges.gitter.im/ArcBlock/community.svg)](https://gitter.im/ArcBlock/community?utm_source=badge\&utm_medium=badge\&utm_campaign=pr-badge) Client library to connect your app with forge powered blockchain node, all requests are sent over http/https, can be used in both Node.js and browser environment. A `GraphQLClient` instance mainly supports 5 groups of methods that saves you time when read/write data from/to blockchain. * `queries`: query block/transaction/account/asset/chain/node data form the blockchain * `mutations`: send transaction to the blockchain, `sendTx`, all transactions should be signed before sending out to the blockchain * `subscriptions`: listen to changes of any data on the blockchain * `senders`: shortcut methods that takes a `wallet` and a `tx` object, then do the signing, and sending * `encoders`: shortcut methods that takes a `wallet` and a `tx` object, encode the transaction for later signing, used internally by senders ## Table of Contents * [Install](#install) * [Usage](#usage) * [Subscriptions](#subscriptions) * [Subpath Exports](#subpath-exports) * [Migration Notes](#migration-notes) * [Examples](#examples) * [Debugging](#debugging) * [Documentation](#documentation) ## Install ```shell npm i @ocap/client -S # OR bun install @ocap/client ``` ## Usage ```js const Mcrypto = require('@ocap/mcrypto'); const GraphQLClient = require('@ocap/client'); const { fromRandom, WalletType } = require('@ocap/wallet'); const { hexToBytes } = require('@ocap/util'); const client = new GraphQLClient('http://localhost:8210/api'); console.log({ queries: client.getQueries(), subscriptions: client.getSubscriptions(), mutations: client.getMutations(), senders: client.getTxSendMethods(), encoders: client.getTxEncodeMethods(), }); (async () => { // Query chain state data const chainInfo = await client.getChainInfo(); const forgeState = await client.getForgeState(); const block = await client.getBlock({ height: 2 }); console.log('getChainInfo', chainInfo); console.log('getForgeState', forgeState); console.log('getBlock', block); // Send transaction const wallet = fromRandom( WalletType({ role: Mcrypto.types.RoleType.ROLE_ACCOUNT, pk: Mcrypto.types.KeyType.SECP256K1, hash: Mcrypto.types.HashType.SHA3, }) ); const hash = await client.declare({ moniker: 'username', wallet, }); console.log(hash); })(); ``` ## Subscriptions `subscribe` / `unsubscribe` pull in `@arcblock/ws` (phoenix + `ws`), which is \~68 KB after minification. To keep the default browser bundle small, the websocket client is shipped as an optional install: * **Node / `@ocap/client/legacy`** — auto-installed by the constructor, call `client.subscribe(topic, cb)` directly. * **Browser** — the default entry's `subscribe` / `unsubscribe` throw until you install them explicitly: ```js import Client from '@ocap/client'; import { install as installSubscribe } from '@ocap/client/subscribe'; const client = new Client(endpoint); installSubscribe(client); client.subscribe('tx.create', (tx) => console.log(tx)); ``` Apps that never need subscriptions pay zero bytes for this code path. ## Subpath Exports The package ships three subpath entries in addition to the default: | Entry | Purpose | Bundle cost | | ------------------------ | ------------------------------------------------------------------------------- | ------------------------------------ | | `@ocap/client` | Full CBOR-only client (queries, mutations, senders, encoders) | ~503 KB minified | | `@ocap/client/encode` | Tree-shakable `encodeTx` / `decodeTx` helpers — no GraphQL, no websockets | ~179 KB minified | | `@ocap/client/subscribe` | Optional websocket installer, see [Subscriptions](#subscriptions) | ~68 KB minified | | `@ocap/client/legacy` | Protobuf wire-encoding client for chain nodes that still decode the legacy path | pulls in `google-protobuf` (~300 KB) | All subpaths require a bundler that honors the `exports` field (webpack 5, Vite, esbuild, Rollup, Bun). For webpack 4 you must enable `resolve.exportsFields`. ## Migration Notes * **`options.encoding`** — the default entry is CBOR-only. Passing `new Client(endpoint, true, { encoding: 'protobuf' })` throws immediately. Import from `@ocap/client/legacy` when you need the protobuf path. * **Browser `subscribe` / `unsubscribe`** — now throw `SUBSCRIBE_NOT_INSTALLED` by default; see [Subscriptions](#subscriptions). Node and `/legacy` behavior is unchanged. * **Client-side factory validation** — `createAssetFactory` no longer runs `isValidFactory` before sending. Invalid factories surface as a chain-side RPC error instead of a local throw. * **`setGasPayer` parsing** — the GraphQL AST parse was replaced with a bounded regex. Queries with `$tx` variables (instead of the literal form the built-in `sendTx` uses) will silently skip the gas-payer headers. ## Examples * [Declare identify on the blockchain](./examples/declare.js) * [Get free token for newly created account](./examples/get_free_token.js) * [Transfer assets between 2 accounts](./examples/transfer_asset.js) * [Transfer tokens between 2 accounts](./examples/transfer_token.js) * [Exchange asset and token between 2 newly created accounts](./examples/exchange.js) * [Create/update asset on the blockchain](./examples/asset.js) * [Consume newly create asset](./examples/consume_asset.js) * [Stake for the connected node](./examples/stake_for_node.js) ## Debugging * If you are in Node.js: `DEBUG=@ocap/client node script.js` * If you are in browser: `localStorage.setItem('DEBUG', '@ocap/client')` ## Documentation * Query arguments and response structure can be found here: [QUERIES.md](./docs/QUERIES.md) * Complete method list can be found here: [README.md](./docs/README.md) --- _Source: https://npm.io/package/@ocap/client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._