@arkiv-network/sdk 0.5.0-dev.1 → 0.5.0-dev.2

package/dist/index.d.ts

@@ -1,393 +1,4 @@
-import { _ as ArkivRpcSchema, a as MutateEntitiesReturnType, b as RpcQueryOptions, c as ExtendEntityParameters, d as DeleteEntityReturnType, f as CreateEntityParameters, g as ArkivClient, h as ChangeOwnershipReturnType, i as MutateEntitiesParameters, l as ExtendEntityReturnType, m as ChangeOwnershipParameters, n as TxParams, o as UpdateEntityParameters, p as CreateEntityReturnType, r as Attribute, s as UpdateEntityReturnType, t as Entity, u as DeleteEntityParameters, v as RpcEntity, x as MimeType, y as RpcIncludeData } from "./entity-D7fzI0Hc.js";
-import { t as QueryBuilder } from "./queryBuilder-BGz98Y1C.js";
-import { n as stringToPayload, t as jsonToPayload } from "./payload-Da9gJMG5.js";
-import { Account, Address, Chain, Client, Hex, ParseAccount, Prettify, PublicActions, PublicClientConfig, RpcSchema, Transport, WalletActions, WalletClientConfig } from "viem";
+import { $ as RpcIncludeData, A as CreateEntityParameters, C as MutateEntitiesReturnType, D as ExtendEntityReturnType, E as ExtendEntityParameters, J as QueryOptionsIncludeData, M as ChangeOwnershipParameters, N as ChangeOwnershipReturnType, O as DeleteEntityParameters, P as GetBlockTimingReturnType, Q as RpcEntity, S as MutateEntitiesParameters, T as UpdateEntityReturnType, X as ArkivClient, Y as QueryOptionsOrderBy, Z as ArkivRpcSchema, _ as OnEntityExpiredEvent, a as PublicArkivClient, b as OnEntityUpdatedEvent, et as RpcOrderByAttribute, g as OnEntityDeletedEvent, h as OnEntityCreatedEvent, i as WalletArkivActions, j as CreateEntityReturnType, k as DeleteEntityReturnType, m as TxParams, n as WalletArkivClient, nt as MimeType, o as createPublicClient, p as Entity, q as QueryOptions, r as createWalletClient, s as PublicArkivActions, t as chainFromName, tt as RpcQueryOptions, v as OnEntityExpiresInExtendedEvent, w as UpdateEntityParameters, x as Attribute, y as OnEntityOwnerChangedEvent } from "./index-B801JxcV.js";
+import { n as stringToPayload, t as jsonToPayload } from "./payload-BI2NXPDf.js";
 export * from "viem";
-
-//#region src/types/events.d.ts
-type OnEntityCreatedEvent = {
-  entityKey: Hex;
-  owner: Hex;
-  expirationBlock: number;
-  cost: bigint;
-};
-type OnEntityUpdatedEvent = {
-  entityKey: Hex;
-  owner: Hex;
-  oldExpirationBlock: number;
-  newExpirationBlock: number;
-  cost: bigint;
-};
-type OnEntityDeletedEvent = {
-  entityKey: Hex;
-  owner: Hex;
-};
-type OnEntityExpiredEvent = {
-  entityKey: Hex;
-  owner: Hex;
-};
-type OnEntityExpiresInExtendedEvent = {
-  entityKey: Hex;
-  owner: Hex;
-  oldExpirationBlock: number;
-  newExpirationBlock: number;
-  cost: bigint;
-};
-//#endregion
-//#region src/clients/decorators/arkivPublic.d.ts
-type PublicArkivActions<transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined> = Pick<PublicActions<transport, chain, account>, "getBalance" | "getBlock" | "getBlockNumber" | "getChainId" | "getLogs" | "getTransaction" | "getTransactionCount" | "getTransactionReceipt" | "waitForTransactionReceipt" | "watchEvent"> & {
-  /**
-   * Returns the entity with the given key.
-   *
-   * - Docs: https://docs.arkiv.network/ts-sdk/actions/public/getEntity
-   *
-   * @param args - {entityKey}
-   * @returns The entity with the given key. {@link Entity}
-   *
-   * @example
-   * import { createPublicClient, http } from 'arkiv'
-   * import { kaolin } from 'arkiv/chains'
-   *
-   * const client = createPublicClient({
-   *   chain: kaolin,
-   *   transport: http(),
-   * })
-   * const entity = await client.getEntity("0x123")
-   * // {
-   * //   key: "0x123",
-   * //   value: "0x123",
-   * // }
-   */
-  getEntity: (key: Hex) => Promise<Entity>;
-  /**
-   * Returns a QueryBuilder instance for building and executing queries.
-   * The QueryBuilder object follows the Builder pattern, allowing you to chain methods to build a query and then execute it.
-   *
-   * - Docs: https://docs.arkiv.network/ts-sdk/actions/public/query
-   *
-   * @returns A QueryBuilder instance for building and executing queries. {@link QueryBuilder}
-   *
-   * @example
-   * import { createPublicClient, http } from 'arkiv'
-   * import { kaolin } from 'arkiv/chains'
-   *
-   * const client = createPublicClient({
-   *   chain: kaolin,
-   *   transport: http(),
-   * })
-   * const query = client.buildQuery()
-   * const entities = await query.where("key", "=", "value").ownedBy("0x123").fetch()
-   *
-   */
-  buildQuery: () => QueryBuilder;
-  /**
-   * Returns a QueryResult instance for fetching the results of a raw query.
-   * @returns A QueryResult instance for fetching the results of a raw query. {@link QueryResult}
-   *
-   * @example
-   * import { createPublicClient, http } from 'arkiv'
-   * import { kaolin } from 'arkiv/chains'
-   *
-   * const client = createPublicClient({
-   *   chain: kaolin,
-   *   transport: http(),
-   * })
-   * const queryResult = client.query('key = value && $owner = 0x123')
-   *
-   */
-  query: (query: string) => Promise<Entity[]>;
-  /**
-   * Returns the number of entities in the DBChain.
-   * @returns The number of entities in the DBChain. {@link number}
-   *
-   * @example
-   * import { createPublicClient, http } from 'arkiv'
-   * import { kaolin } from 'arkiv/chains'
-   *
-   * const client = createPublicClient({
-   *   chain: kaolin,
-   *   transport: http(),
-   * })
-   * const entityCount = await client.getEntityCount()
-   * // entityCount = 0
-   */
-  getEntityCount: () => Promise<number>;
-  /**
-   * Returns the current block timing.
-   * @returns The current block timing. {@link GetBlockTimingReturnType}
-   *
-   * @example
-   * import { createPublicClient, http } from 'arkiv'
-   * import { kaolin } from 'arkiv/chains'
-   *
-   * const client = createPublicClient({
-   *   chain: kaolin,
-   *   transport: http(),
-   * })
-   * const blockTiming = await client.getBlockTiming()
-   * // {
-   * //   currentBlock: 10n, // block number
-   * //   currentBlockTime: 1234567890, // block timestamp
-   * //   blockDuration: 2, // in seconds
-   * // }
-   */
-  getBlockTiming: () => Promise<{
-    currentBlock: bigint;
-    currentBlockTime: number;
-    blockDuration: number;
-  }>;
-  /**
-   * Subscribes to entity events.
-   * @param events to watch - {onError, onEntityCreated, onEntityUpdated, onEntityDeleted, onEntityExpiresInExtended}
-   * @param pollingInterval - The polling interval in milliseconds. {@link number}
-   * @param fromBlock - The block number to start from. {@link bigint}
-   * @returns A function to unsubscribe from the events. {() => void}
-   *
-   * @example
-   * import { createPublicClient, http } from 'arkiv'
-   * import { kaolin } from 'arkiv/chains'
-   *
-   * const client = createPublicClient({
-   *   chain: kaolin,
-   *   transport: http(),
-   * })
-   * const unsubscribe = await client.subscribeEntityEvents({
-   *   onError: (error) => console.error("subscribeEntityEvents error", error),
-   * })
-   * unsubscribe() // unsubscribe from the events
-   */
-  subscribeEntityEvents: ({
-    onError,
-    onEntityCreated,
-    onEntityUpdated,
-    onEntityDeleted,
-    onEntityExpiresInExtended
-  }: {
-    onError?: (error: Error) => void;
-    onEntityCreated?: (event: OnEntityCreatedEvent) => void;
-    onEntityUpdated?: (event: OnEntityUpdatedEvent) => void;
-    onEntityDeleted?: (event: OnEntityDeletedEvent) => void;
-    onEntityExpired?: (event: OnEntityExpiredEvent) => void;
-    onEntityExpiresInExtended?: (event: OnEntityExpiresInExtendedEvent) => void;
-  }, pollingInterval?: number, fromBlock?: bigint) => Promise<() => void>;
-};
-//#endregion
-//#region src/clients/createPublicClient.d.ts
-type PublicArkivClient<transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined, accountOrAddress extends Account | undefined = undefined, rpcSchema extends RpcSchema | undefined = ArkivRpcSchema> = Prettify<Client<transport, chain, accountOrAddress, rpcSchema, PublicArkivActions<transport, chain>>>;
-/**
- * Creates a Public Client with a given [Transport](https://viem.sh/docs/clients/intro) configured for a [Chain](https://viem.sh/docs/clients/chains).
- *
- * - Docs: https://docs.arkiv.network/ts-sdk/clients/public
- *
- * A Public Client is an interface to "public" [Ethereum JSON-RPC API](https://ethereum.org/en/developers/docs/apis/json-rpc/), [Arkiv JSON-RPC API](https://docs.arkiv.network/json-rpc/), and [Kaolin JSON-RPC API](https://kaolin.holesky.arkiv.network/rpc) methods such as retrieving block numbers, transactions, reading from smart contracts, etc through [Public Actions](/docs/actions/public/introduction).
- *
- * @param config - {@link PublicClientConfig}
- * @returns A Arkiv Public Client. {@link PublicArkivClient}
- *
- * @example
- * import { createPublicClient, http } from 'arkiv'
- * import { kaolin } from 'arkiv/chains'
- *
- * const client = createPublicClient({
- *   chain: kaolin,
- *   transport: http(),
- * })
- */
-declare function createPublicClient<transport extends Transport, chain extends Chain | undefined = undefined, accountOrAddress extends Account | Address | undefined = undefined, rpcSchema extends RpcSchema | undefined = ArkivRpcSchema>(parameters: PublicClientConfig<transport, chain, accountOrAddress, rpcSchema>): PublicArkivClient<transport, chain, ParseAccount<accountOrAddress>, rpcSchema>;
-//#endregion
-//#region src/clients/decorators/arkivWallet.d.ts
-type WalletArkivActions<transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined> = Pick<PublicActions<transport, chain, account>, "waitForTransactionReceipt"> & Pick<WalletActions<chain, account>, "addChain" | "sendTransaction" | "sendTransactionSync" | "sendRawTransaction" | "sendRawTransactionSync" | "signMessage" | "signTransaction"> & {
-  /**
-   * Returns the entity with the given key.
-   *
-   * - Docs: https://docs.arkiv.network/ts-sdk/actions/public/getEntity
-   * - JSON-RPC Methods: [`eth_sendRawTransaction`](https://docs.arkiv.network/dev/json-rpc-api/#mutateEntities)
-   *
-   * @param args - {entityKey}
-   * @returns The entity with the given key. {@link Entity}
-   *
-   * @example
-   * import { createPublicClient, http } from 'arkiv'
-   * import { kaolin } from 'arkiv/chains'
-   *
-   * const client = createPublicClient({
-   *   chain: kaolin,
-   *   transport: http(),
-   * })
-   * const { entityKey, txHash } = await client.createEntity({
-   *   payload: toBytes(JSON.stringify({ entity: { entityType: "testType", entityId: "testId" } })),
-   *   attributes: [{ key: "testKey", value: "testValue" }],
-   *   expiresIn: 1000,
-   * })
-   * console.log("entityKey", entityKey)
-   * console.log("txHash", txHash)
-   * // {
-   * //   entityKey: "0x123",
-   * //   txHash: "0x123",
-   * // }
-   */
-  createEntity: (data: CreateEntityParameters, txParams?: TxParams) => Promise<CreateEntityReturnType>;
-  /**
-   * Updates the entity with the given key.
-   *
-   * - Docs: https://docs.arkiv.network/ts-sdk/actions/wallet/updateEntity
-   * - JSON-RPC Methods: [`eth_sendRawTransaction`](https://docs.arkiv.network/dev/json-rpc-api/#mutateEntities)
-   *
-   * @param args - {entityKey, data}
-   * @returns The entity with the given key. {@link Entity}
-   *
-   * @example
-   * import { createWalletClient, http } from 'arkiv'
-   * import { kaolin } from 'arkiv/chains'
-   *
-   * const client = createWalletClient({
-   *   chain: kaolin,
-   *   transport: http(),
-   * })
-   */
-  updateEntity: (data: UpdateEntityParameters, txParams?: TxParams) => Promise<UpdateEntityReturnType>;
-  /**
-   * Deletes the entity with the given key.
-   *
-   * - Docs: https://docs.arkiv.network/ts-sdk/actions/wallet/deleteEntity
-   * - JSON-RPC Methods: [`eth_sendRawTransaction`](https://docs.arkiv.network/dev/json-rpc-api/#mutateEntities)
-   *
-   * @param args - {entityKey}
-   * @returns The entity with the given key. {@link Entity}
-   *
-   * @example
-   * import { createWalletClient, http } from 'arkiv'
-   * import { kaolin } from 'arkiv/chains'
-   *
-   * const client = createWalletClient({
-   *   chain: kaolin,
-   *   transport: http(),
-   * })
-   * const { entityKey, txHash } = await client.deleteEntity({ entityKey: "0x123" })
-   * console.log("entityKey", entityKey)
-   * console.log("txHash", txHash)
-   * // {
-   * //   entityKey: "0x123",
-   * //   txHash: "0x123",
-   * // }
-   */
-  deleteEntity: (data: DeleteEntityParameters, txParams?: TxParams) => Promise<DeleteEntityReturnType>;
-  /**
-   * Extends the entity with the given key.
-   *
-   * - Docs: https://docs.arkiv.network/ts-sdk/actions/wallet/extendEntity
-   * - JSON-RPC Methods: [`eth_sendRawTransaction`](https://docs.arkiv.network/dev/json-rpc-api/#mutateEntities)
-   *
-   * @param args - {entityKey, data}
-   * @returns The entity with the given key. {@link Entity}
-   *
-   * @example
-   * import { createWalletClient, http } from 'arkiv'
-   * import { kaolin } from 'arkiv/chains'
-   *
-   * const client = createWalletClient({
-   *   chain: kaolin,
-   *   transport: http(),
-   * })
-   * const { entityKey, txHash } = await client.extendEntity("0x123", {
-   *   expiresIn: 1000,
-   * })
-   * console.log("entityKey", entityKey)
-   * console.log("txHash", txHash)
-   * // {
-   * //   entityKey: "0x123",
-   * //   txHash: "0x123",
-   * // }
-   */
-  extendEntity: (data: ExtendEntityParameters, txParams?: TxParams) => Promise<ExtendEntityReturnType>;
-  /**
-   * Changes the ownership of the entity with the given address.
-   *
-   * - Docs: https://docs.arkiv.network/ts-sdk/actions/wallet/changeOwnership
-   * - JSON-RPC Methods: [`eth_sendRawTransaction`](https://docs.arkiv.network/dev/json-rpc-api/#mutateEntities)
-   *
-   * @param args - {entityKey, newOwner}
-   * @returns The entity with the given address. {@link Entity}
-   */
-  changeOwnership: (data: ChangeOwnershipParameters, txParams?: TxParams) => Promise<ChangeOwnershipReturnType>;
-  /**
-   * Mutates the entities with the given keys.
-   *
-   * - Docs: https://docs.arkiv.network/ts-sdk/actions/wallet/mutateEntities
-   * - JSON-RPC Methods: [`eth_sendRawTransaction`](https://docs.arkiv.network/dev/json-rpc-api/#mutateEntities)
-   *
-   * @param args - {data}
-   * @returns The entity with the given key. {@link Entity}
-   *
-   * @example
-   * import { createWalletClient, http } from 'arkiv'
-   * import { kaolin } from 'arkiv/chains'
-   *
-   * const client = createWalletClient({
-   *   chain: kaolin,
-   *   transport: http(),
-   * })
-   * const { entityKey, txHash } = await client.mutateEntities({
-   *   creates: [{
-   *     payload: toBytes(JSON.stringify({ entity: { entityType: "testType", entityId: "testId" } })),
-   *     attriubutes: [{ key: "testKey", value: "testValue" }],
-   *     expiresIn: 1000,
-   *   }],
-   *   updates: [{
-   *     entityKey: "0x123",
-   *     payload: toBytes(JSON.stringify({ entity: { entityType: "testType", entityId: "testId" } })),
-   *     attributes: [{ key: "testKey", value: "testValue" }],
-   *     expiresIn: 1000,
-   *   }],
-   *   deletes: [{
-   *     entityKey: "0x321",
-   *   }],
-   *   extensions: [{
-   *     entityKey: "0x1234",
-   *     expiresIn: 1000,
-   *   }],
-   * })
-   * console.log("entityKey", entityKey)
-   * console.log("txHash", txHash)
-   * // {
-   * //   entityKey: "0x123",
-   * //   txHash: "0x123",
-   * // }
-   */
-  mutateEntities: (data: MutateEntitiesParameters, txParams?: TxParams) => Promise<MutateEntitiesReturnType>;
-};
-//#endregion
-//#region src/clients/createWalletClient.d.ts
-type WalletArkivClient<transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined, rpcSchema extends RpcSchema | undefined = ArkivRpcSchema> = Prettify<Client<transport, chain, account, rpcSchema, WalletArkivActions<transport, chain, account>>>;
-/**
- * Creates a Public Client with a given [Transport](https://viem.sh/docs/clients/intro) configured for a [Chain](https://viem.sh/docs/clients/chains).
- *
- * - Docs: https://docs.arkiv.network/ts-sdk/clients/public
- *
- * A Public Client is an interface to "public" [Ethereum JSON-RPC API](https://ethereum.org/en/developers/docs/apis/json-rpc/), [Arkiv JSON-RPC API](https://docs.arkiv.network/json-rpc/), and [Kaolin JSON-RPC API](https://kaolin.holesky.arkiv.network/rpc) methods such as retrieving block numbers, transactions, reading from smart contracts, etc through [Public Actions](/docs/actions/public/introduction).
- *
- * @param config - {@link PublicClientConfig}
- * @returns A Arkiv Public Client. {@link PublicArkivClient}
- *
- * @example
- * import { createPublicClient, http } from 'arkiv'
- * import { kaolin } from 'arkiv/chains'
- *
- * const client = createPublicClient({
- *   chain: kaolin,
- *   transport: http(),
- * })
- */
-declare function createWalletClient<transport extends Transport, chain extends Chain | undefined = undefined, accountOrAddress extends Account | Address | undefined = undefined, rpcSchema extends RpcSchema | undefined = ArkivRpcSchema>(parameters: WalletClientConfig<transport, chain, accountOrAddress, rpcSchema>): WalletArkivClient<transport, chain, ParseAccount<accountOrAddress>, rpcSchema>;
-//#endregion
-//#region src/utils/chains.d.ts
-/**
- * Get a chain from its name
- * @param name - The name of the chain, case insensitive
- * @returns The chain
- * @throws An error if the chain is not found
- */
-declare function chainFromName(name: string): Chain;
-//#endregion
-export { type ArkivClient, ArkivRpcSchema, Attribute, ChangeOwnershipParameters, ChangeOwnershipReturnType, CreateEntityParameters, CreateEntityReturnType, DeleteEntityParameters, DeleteEntityReturnType, Entity, ExtendEntityParameters, ExtendEntityReturnType, MimeType, MutateEntitiesParameters, MutateEntitiesReturnType, type PublicArkivClient, RpcEntity, RpcIncludeData, RpcQueryOptions, TxParams, UpdateEntityParameters, UpdateEntityReturnType, type WalletArkivClient, chainFromName, createPublicClient, createWalletClient, jsonToPayload, stringToPayload };
-//# sourceMappingURL=index.d.ts.map
+export { ArkivClient, ArkivRpcSchema, Attribute, ChangeOwnershipParameters, ChangeOwnershipReturnType, CreateEntityParameters, CreateEntityReturnType, DeleteEntityParameters, DeleteEntityReturnType, Entity, ExtendEntityParameters, ExtendEntityReturnType, GetBlockTimingReturnType, MimeType, MutateEntitiesParameters, MutateEntitiesReturnType, OnEntityCreatedEvent, OnEntityDeletedEvent, OnEntityExpiredEvent, OnEntityExpiresInExtendedEvent, OnEntityOwnerChangedEvent, OnEntityUpdatedEvent, PublicArkivActions, PublicArkivClient, QueryOptions, QueryOptionsIncludeData, QueryOptionsOrderBy, RpcEntity, RpcIncludeData, RpcOrderByAttribute, RpcQueryOptions, TxParams, UpdateEntityParameters, UpdateEntityReturnType, WalletArkivActions, WalletArkivClient, chainFromName, createPublicClient, createWalletClient, jsonToPayload, stringToPayload };

package/dist/index.js

@@ -1,5 +1,5 @@
 import { t as chains_exports } from "./chains-BDsOtN2a.js";
-import { a as entityFromRpcResult, s as NoEntityFoundError, t as QueryBuilder, u as getLogger } from "./queryBuilder-Cy7vf54g.js";
+import { a as entityFromRpcResult, l as getLogger, s as NoEntityFoundError, t as QueryBuilder } from "./queryBuilder-DNUwJvf0.js";
 import { i as BLOCK_TIME, n as stringToPayload, r as ARKIV_ADDRESS, t as jsonToPayload } from "./payload-DKBYYjeA.js";
 import "./types-H-TSmRpm.js";
 import { bytesToHex, createClient, decodeEventLog, hexToBytes, parseAbi, publicActions, toBytes, toHex, toRlp, walletActions } from "viem";
@@ -62,10 +62,32 @@ async function getEntityCount(client) {
 
 //#endregion
 //#region src/actions/public/query.ts
-async function query(client, query$1) {
+async function query(client, query$1, queryOptions) {
+	const rpcQueryOptions = {
+		includeData: {
+			key: true,
+			payload: queryOptions?.includeData?.payload ?? true,
+			attributes: queryOptions?.includeData?.attributes ?? false,
+			contentType: queryOptions?.includeData?.metadata ?? false,
+			expiration: queryOptions?.includeData?.metadata ?? false,
+			owner: queryOptions?.includeData?.metadata ?? false,
+			createdAtBlock: queryOptions?.includeData?.metadata ?? false,
+			lastModifiedAtBlock: queryOptions?.includeData?.metadata ?? false,
+			transactionIndexInBlock: queryOptions?.includeData?.metadata ?? false,
+			operationIndexInTransaction: queryOptions?.includeData?.metadata ?? false
+		},
+		...queryOptions?.atBlock !== void 0 && { atBlock: Number(queryOptions.atBlock) },
+		...queryOptions?.orderBy && { orderBy: queryOptions?.orderBy.map((order) => ({
+			name: order.name,
+			type: order.type,
+			desc: order.desc === "desc"
+		})) },
+		...queryOptions?.resultsPerPage !== void 0 && { resultsPerPage: queryOptions.resultsPerPage },
+		...queryOptions?.cursor !== void 0 && { cursor: queryOptions?.cursor }
+	};
 	const result = await client.request({
 		method: "arkiv_query",
-		params: [query$1]
+		params: [query$1, rpcQueryOptions]
 	});
 	return await Promise.all(result.data.map((entity) => entityFromRpcResult(entity)));
 }
@@ -159,7 +181,7 @@ async function subscribeEntityEvents(client, { onError, onEntityCreated, onEntit
 function publicArkivActions(client) {
 	return {
 		getEntity: (key) => getEntity(client, key),
-		query: (rawQuery) => query(client, rawQuery),
+		query: (rawQuery, queryOptions) => query(client, rawQuery, queryOptions),
 		buildQuery: () => new QueryBuilder(client),
 		getBlockTiming: () => getBlockTiming(client),
 		getEntityCount: () => getEntityCount(client),
@@ -183,7 +205,7 @@ function publicArkivActions(client) {
 *
 * A Public Client is an interface to "public" [Ethereum JSON-RPC API](https://ethereum.org/en/developers/docs/apis/json-rpc/), [Arkiv JSON-RPC API](https://docs.arkiv.network/json-rpc/), and [Kaolin JSON-RPC API](https://kaolin.holesky.arkiv.network/rpc) methods such as retrieving block numbers, transactions, reading from smart contracts, etc through [Public Actions](/docs/actions/public/introduction).
 *
-* @param config - {@link PublicClientConfig}
+* @param parameters - Configuration object for the public client (chain, transport, etc.)
 * @returns A Arkiv Public Client. {@link PublicArkivClient}
 *
 * @example
@@ -224,7 +246,7 @@ async function getBrotli() {
 	if (brotli) return brotli;
 	try {
 		const brotliModule = await import("brotli-wasm");
-		brotli = brotliModule.default || brotliModule;
+		brotli = brotliModule.default ? await brotliModule.default : brotliModule;
 	} catch (error) {
 		console.error("Error importing brotli-wasm", error);
 		return null;
@@ -449,8 +471,8 @@ function walletArkivActions(client) {
 *
 * A Public Client is an interface to "public" [Ethereum JSON-RPC API](https://ethereum.org/en/developers/docs/apis/json-rpc/), [Arkiv JSON-RPC API](https://docs.arkiv.network/json-rpc/), and [Kaolin JSON-RPC API](https://kaolin.holesky.arkiv.network/rpc) methods such as retrieving block numbers, transactions, reading from smart contracts, etc through [Public Actions](/docs/actions/public/introduction).
 *
-* @param config - {@link PublicClientConfig}
-* @returns A Arkiv Public Client. {@link PublicArkivClient}
+* @param parameters - Configuration object for the wallet client (chain, transport, account, etc.)
+* @returns A Arkiv Wallet Client. {@link WalletArkivClient}
 *
 * @example
 * import { createPublicClient, http } from 'arkiv'