createWalletClient

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

Defined in: src/clients/createWalletClient.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 wallet client (chain, transport, account, etc.)

Returns

A Arkiv Wallet Client. WalletArkivClient

changeOwnership()

changeOwnership: (data, txParams?) => Promise<ChangeOwnershipReturnType>

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

Parameters

data

ChangeOwnershipParameters

The ownership change parameters

txParams?

TxParams

Optional transaction parameters

Returns

Promise<ChangeOwnershipReturnType>

The entity with updated ownership and transaction hash

createEntity()

createEntity: (data, txParams?) => Promise<CreateEntityReturnType>

Creates a new entity.

• Docs: https://docs.arkiv.network/ts-sdk/actions/wallet/createEntity
• JSON-RPC Methods: eth_sendRawTransaction

Parameters

data

CreateEntityParameters

The entity creation parameters

txParams?

TxParams

Optional transaction parameters

Returns

Promise<CreateEntityReturnType>

The created entity with transaction hash

Example

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

const client = createPublicClient({
  chain: braga,
  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",
// }

deleteEntity()

deleteEntity: (data, txParams?) => Promise<DeleteEntityReturnType>

Deletes the entity with the given key.

• Docs: https://docs.arkiv.network/ts-sdk/actions/wallet/deleteEntity
• JSON-RPC Methods: eth_sendRawTransaction

Parameters

data

DeleteEntityParameters

The entity deletion parameters

txParams?

TxParams

Optional transaction parameters

Returns

Promise<DeleteEntityReturnType>

The deleted entity with transaction hash

Example

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

const client = createWalletClient({
  chain: braga,
  transport: http(),
})
const { entityKey, txHash } = await client.deleteEntity({ entityKey: "0x123" })
console.log("entityKey", entityKey)
console.log("txHash", txHash)
// {
//   entityKey: "0x123",
//   txHash: "0x123",
// }

extendEntity()

extendEntity: (data, txParams?) => Promise<ExtendEntityReturnType>

Extends the entity with the given key.

• Docs: https://docs.arkiv.network/ts-sdk/actions/wallet/extendEntity
• JSON-RPC Methods: eth_sendRawTransaction

Parameters

data

ExtendEntityParameters

The entity update parameters

txParams?

TxParams

Optional transaction parameters

Returns

Promise<ExtendEntityReturnType>

The updated entity with transaction hash

Example

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

const client = createWalletClient({
  chain: braga,
  transport: http(),
})
const { entityKey, txHash } = await client.extendEntity("0x123", {
  expiresIn: 1000,
})
console.log("entityKey", entityKey)
console.log("txHash", txHash)
// {
//   entityKey: "0x123",
//   txHash: "0x123",
// }

mutateEntities()

mutateEntities: (data, txParams?) => Promise<MutateEntitiesReturnType>

Mutates the entities with the given keys.

• Docs: https://docs.arkiv.network/ts-sdk/actions/wallet/mutateEntities
• JSON-RPC Methods: eth_sendRawTransaction

Parameters

data

MutateEntitiesParameters

The mutation parameters (creates, updates, deletes, extensions)

txParams?

TxParams

Optional transaction parameters

Returns

Promise<MutateEntitiesReturnType>

The mutation result with transaction hash

Example

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

const client = createWalletClient({
  chain: braga,
  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",
// }

updateEntity()

updateEntity: (data, txParams?) => Promise<UpdateEntityReturnType>

Updates the entity with the given key.

• Docs: https://docs.arkiv.network/ts-sdk/actions/wallet/updateEntity
• JSON-RPC Methods: eth_sendRawTransaction

Parameters

data

UpdateEntityParameters

The entity update parameters

txParams?

TxParams

Optional transaction parameters

Returns

Promise<UpdateEntityReturnType>

The updated entity with transaction hash

Example

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

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

Example

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

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