createWalletClient

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

Defined in: src/clients/createWalletClient.ts:50

Creates a Wallet Client with a given Transport configured for a Chain and an account.

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

A Wallet Client signs and sends transactions, so it carries an account and exposes everything that mutates state — createEntity, patchEntity, deleteEntity, extendEntity, changeOwnership and mutateEntities — on top of the read actions a Public Client has.

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

Throws

If the expiry exceeds a protocol bound or would leave the entity dead on arrival.

Throws

If an attribute value does not fit the type it names.

Throws

If a name violates the attribute-name grammar.

Example

import { createWalletClient, ExpirationTime, jsonToPayload } from "@arkiv-network/sdk"
import { i32 } from "@arkiv-network/sdk/attr"
import { cheesecake } from "@arkiv-network/sdk/chains"
import { http } from "viem"

const client = createWalletClient({
  chain: cheesecake,
  transport: http(),
})
const { entityKey, txHash, expiresAt } = await client.createEntity({
  payload: jsonToPayload({ entityType: "testType", entityId: "testId" }),
  contentType: "application/json",
  attributes: { testKey: "testValue", level: i32(3) },
  expires: ExpirationTime.fromDays(30),
})

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 } from "@arkiv-network/sdk"
import { cheesecake } from "@arkiv-network/sdk/chains"
import { http } from "viem"

const client = createWalletClient({
  chain: cheesecake,
  transport: http(),
})
// entityKey is the bytes32 key returned by createEntity.
const { txHash } = await client.deleteEntity({ entityKey })

extendEntity()

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

Sets a new expiry on the entity with the given key.

The new lifetime is resolved the same way a create’s is: a duration counts from now rather than adding to what the entity has left, and atBlock / atDate pin an absolute deadline. The engine rejects an extension that would not move the expiry later.

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

Parameters

data

ExtendEntityParameters

The entity key and its new lifetime

txParams?

TxParams

Optional transaction parameters

Returns

Promise<ExtendEntityReturnType>

The entity key, transaction hash, and the block it is now expected to expire at

Throws

If the expiry is malformed, exceeds a protocol bound, or would leave the entity dead on arrival.

Example

import { createWalletClient, ExpirationTime } from "@arkiv-network/sdk"
import { cheesecake } from "@arkiv-network/sdk/chains"
import { http } from "viem"

const client = createWalletClient({
  chain: cheesecake,
  transport: http(),
})
const { txHash, expiresAt } = await client.extendEntity({
  entityKey,
  expires: ExpirationTime.fromDays(30),
})

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

Every operation lands in one transaction, so the whole batch applies or none of it does. At least one operation is required.

Parameters

data

MutateEntitiesParameters

The mutation parameters (creates, patches, deletes, extensions, ownershipChanges)

txParams?

TxParams

Optional transaction parameters

Returns

Promise<MutateEntitiesReturnType>

The mutation result with transaction hash

Throws

If an expiry exceeds a protocol bound or would leave the entity dead on arrival.

Throws

If an attribute value does not fit the type it names.

Example

import { createWalletClient, ExpirationTime, jsonToPayload } from "@arkiv-network/sdk"
import { cheesecake } from "@arkiv-network/sdk/chains"
import { http } from "viem"

const client = createWalletClient({
  chain: cheesecake,
  transport: http(),
})
const { txHash, createdEntities } = await client.mutateEntities({
  creates: [{
    payload: jsonToPayload({ entityType: "testType", entityId: "testId" }),
    contentType: "application/json",
    attributes: { testKey: "testValue" },
    expires: ExpirationTime.fromDays(30),
  }],
  patches: [{ entityKey: keyToRevise, set: { status: "archived" }, unset: ["draft"] }],
  deletes: [{ entityKey: staleKey }],
  extensions: [{
    entityKey: keyToKeepAlive,
    expires: ExpirationTime.atBlock(1_200_000n),
  }],
  ownershipChanges: [{ entityKey: keyToHandOver, newOwner }],
})

patchEntity()

patchEntity: (data, txParams?) => Promise<PatchEntityReturnType>

Applies a patch to the entity with the given key: sets some fields, unsets others, and leaves everything it does not name alone.

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

Parameters

data

PatchEntityParameters

The entity key and the mutations to apply

txParams?

TxParams

Optional transaction parameters

Returns

Promise<PatchEntityReturnType>

The entity key and the transaction hash

Throws

If the patch has nothing to apply.

Throws

If a name appears in both set and unset.

Throws

If an attribute value does not fit the type it names.

Throws

If a name violates the attribute-name grammar.

Example

import { createWalletClient, jsonToPayload } from "@arkiv-network/sdk"
import { i32 } from "@arkiv-network/sdk/attr"
import { cheesecake } from "@arkiv-network/sdk/chains"
import { http } from "viem"

const client = createWalletClient({
  chain: cheesecake,
  transport: http(),
})
// Publish the entity: one attribute changes, one goes away, the payload is replaced.
const { txHash } = await client.patchEntity({
  entityKey,
  set: { status: "published", revision: i32(2) },
  unset: ["draft"],
  payload: jsonToPayload({ title: "Hello" }),
})

Example

import { createWalletClient } from "@arkiv-network/sdk"
import { cheesecake } from "@arkiv-network/sdk/chains"
import { http } from "viem"
import { privateKeyToAccount } from "viem/accounts"

const client = createWalletClient({
  chain: cheesecake,
  transport: http(),
  account: privateKeyToAccount("0x..."),
})