createPublicClient

createPublicClient<transport, chain, accountOrAddress, rpcSchema>(parameters): object

Defined in: src/clients/createPublicClient.ts:44

Creates a Public Client with a given Transport configured for a Chain.

• Docs: https://docs.arkiv.network/ts-sdk/clients/public

A Public Client is an interface to “public” Ethereum JSON-RPC API, Arkiv JSON-RPC API, and Braga JSON-RPC API methods such as retrieving block numbers, transactions, reading from smart contracts, etc through Public Actions.

Type Parameters

transport

transport extends Transport

chain

chain extends Chain | undefined = undefined

accountOrAddress

accountOrAddress extends `0x${string}` | Account | undefined = undefined

rpcSchema

rpcSchema extends RpcSchema | undefined = ArkivRpcSchema

Parameters

parameters

Configuration object for the public client (chain, transport, etc.)

Returns

A Arkiv Public Client. PublicArkivClient

buildQuery()

buildQuery: () => QueryBuilder

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

QueryBuilder

A QueryBuilder instance for building and executing queries. QueryBuilder

Example

import { createPublicClient, http } from 'arkiv'
import { braga } from 'arkiv/chains'

const client = createPublicClient({
  chain: braga,
  transport: http(),
})
const query = client.buildQuery()
const entities = await query.where("key", "=", "value").ownedBy("0x123").fetch()

getBlockTiming()

getBlockTiming: () => Promise<{ blockDuration: number; currentBlock: bigint; currentBlockTime: number; }>

Returns the current block timing.

Returns

Promise<{ blockDuration: number; currentBlock: bigint; currentBlockTime: number; }>

The current block timing. GetBlockTimingReturnType

Example

import { createPublicClient, http } from 'arkiv'
import { braga } from 'arkiv/chains'

const client = createPublicClient({
  chain: braga,
  transport: http(),
})
const blockTiming = await client.getBlockTiming()
// {
//   currentBlock: 10n, // block number
//   currentBlockTime: 1234567890, // block timestamp
//   blockDuration: 2, // in seconds
// }

getEntity()

getEntity: (key) => Promise<Entity>

Returns the entity with the given key.

• Docs: https://docs.arkiv.network/ts-sdk/actions/public/getEntity

Parameters

key

`0x${string}`

The entity key (hex string)

Returns

Promise<Entity>

The entity with the given key. Entity

Example

import { createPublicClient, http } from 'arkiv'
import { braga } from 'arkiv/chains'

const client = createPublicClient({
  chain: braga,
  transport: http(),
})
const entity = await client.getEntity("0x123")
// {
//   key: "0x123",
//   value: "0x123",
// }

getEntityCount()

getEntityCount: () => Promise<number>

Returns the number of entities in the DBChain.

Returns

Promise<number>

The number of entities in the DBChain

Example

import { createPublicClient, http } from 'arkiv'
import { braga } from 'arkiv/chains'

const client = createPublicClient({
  chain: braga,
  transport: http(),
})
const entityCount = await client.getEntityCount()
// entityCount = 0

query()

query: (query, queryOptions?) => Promise<QueryReturnType>

Returns a QueryResult instance for fetching the results of a raw query. If no query options are provided, all payload is included, but no metadata (like owner, expiredAt, etc.) and attributes.

Parameters

query

string

The raw query string

queryOptions?

QueryOptions

The optional query options - QueryOptions

Returns

Promise<QueryReturnType>

A QueryReturnType instance - QueryReturnType

Example

import { createPublicClient, http } from 'arkiv'
import { braga } from 'arkiv/chains'

const client = createPublicClient({
  chain: braga,
  transport: http(),
})
const queryResult = client.query('key = value && $owner = 0x123')
// queryResult = { entities: [{ key: "0x123", value: "0x123" }], cursor: undefined, blockNumber: undefined }
const queryResultWithOptions = client.query('key = value && $owner = 0x123', {
  includeData: {
    attributes: false,
    payload: true,
    metadata: true,
  },
  orderBy: [{ name: "key", type: "string", desc: "asc" }],
  resultsPerPage: 10,
  cursor: undefined,
  atBlock: undefined,
})
// queryResultWithOptions = { entities: [{ key: "0x123", value: "0x123" }], cursor: "...", blockNumber: 32223n }

subscribeEntityEvents()

subscribeEntityEvents: (__namedParameters, pollingInterval?, fromBlock?) => Promise<() => void>

Subscribes to entity events. Takes an object with event handlers: {onError, onEntityCreated, onEntityUpdated, onEntityDeleted, onEntityExpiresInExtended}

Parameters

__namedParameters

onEntityCreated?

(event) => void

onEntityDeleted?

(event) => void

onEntityExpired?

(event) => void

onEntityExpiresInExtended?

(event) => void

onEntityUpdated?

(event) => void

onError?

(error) => void

pollingInterval?

number

The polling interval in milliseconds

fromBlock?

bigint

The block number to start from

Returns

Promise<() => void>

A function to unsubscribe from the events

Example

import { createPublicClient, http } from 'arkiv'
import { braga } from 'arkiv/chains'

const client = createPublicClient({
  chain: braga,
  transport: http(),
})
const unsubscribe = await client.subscribeEntityEvents({
  onError: (error) => console.error("subscribeEntityEvents error", error),
})
unsubscribe() // unsubscribe from the events

Example

import { createPublicClient, http } from 'arkiv'
import { braga } from 'arkiv/chains'

const client = createPublicClient({
  chain: braga,
  transport: http(),
})