@arkiv-network/sdk/src/actions/wallet/deleteEntity.ts

TypeScript client library for Arkiv's blockchains interactions

import type { Hash, Hex } from "viem"
import type { ArkivClient } from "../../clients/baseClient"
import type { TxParams } from "../../types"
import { sendArkivTransaction } from "../../utils/arkivTransactions"
import { getLogger } from "../../utils/logger"

const logger = getLogger("actions:wallet:delete-entity")

/**
 * Parameters for the deleteEntity function.
 * - entityKey: The key of the entity to delete.
 */
export type DeleteEntityParameters = {
  entityKey: Hex
}

/**
 * Return type for the deleteEntity function.
 * - entityKey: The key of the entity.
 * - txHash: The transaction hash.
 */
export type DeleteEntityReturnType = {
  entityKey: Hex
  txHash: Hash
}

export async function deleteEntity(
  client: ArkivClient,
  data: DeleteEntityParameters,
  txParams?: TxParams,
): Promise<DeleteEntityReturnType> {
  logger("deleteEntity %o", data)
  const { receipt } = await sendArkivTransaction(client, { deletes: [data] }, txParams)

  logger("Receipt from deleteEntity %o", receipt)

  return {
    txHash: receipt.transactionHash as Hash,
    entityKey: data.entityKey,
  }
}