@arkiv-network/sdk 0.7.0 → 0.8.0-advanced.3

package/dist/utils/index.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/utils/expirationTime.ts"],"sourcesContent":[],"mappings":";;;cAEa;;;EAAA,SAAA,EAAA,CAAA,KAUZ,EAAA,MAAA,EAAA,GADkB,MAAI;;;;;;mBAAJ"}

package/dist/utils/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/utils/expirationTime.ts"],"sourcesContent":[],"mappings":";;;cAEa;;;EAAA,SAAA,EAAA,CAAA,KAUZ,EAAA,MAAA,EAAA,GADkB,MAAI;;;;;;mBAAJ"}

package/dist/utils/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../src/utils/expirationTime.ts"],"sourcesContent":["import { BLOCK_TIME } from \"../consts\"\n\nexport const ExpirationTime = {\n  fromSeconds: (seconds: number) => seconds,\n  fromMinutes: (minutes: number) => minutes * 60,\n  fromHours: (hours: number) => hours * 60 * 60,\n  fromDays: (days: number) => days * 24 * 60 * 60,\n  fromWeeks: (weeks: number) => weeks * 7 * 24 * 60 * 60,\n  fromMonths: (months: number) => months * 30 * 24 * 60 * 60,\n  fromYears: (years: number) => years * 365 * 24 * 60 * 60,\n  fromBlocks: (blocks: number) => blocks * BLOCK_TIME,\n  fromDate: (date: Date) => Math.floor(date.getTime() / 1000) - Math.floor(Date.now() / 1000),\n}\n"],"mappings":";;;;AAEA,MAAa,iBAAiB;CAC5B,cAAc,YAAoB;CAClC,cAAc,YAAoB,UAAU;CAC5C,YAAY,UAAkB,QAAQ,KAAK;CAC3C,WAAW,SAAiB,OAAO,KAAK,KAAK;CAC7C,YAAY,UAAkB,QAAQ,IAAI,KAAK,KAAK;CACpD,aAAa,WAAmB,SAAS,KAAK,KAAK,KAAK;CACxD,YAAY,UAAkB,QAAQ,MAAM,KAAK,KAAK;CACtD,aAAa,WAAmB,SAAS;CACzC,WAAW,SAAe,KAAK,MAAM,KAAK,SAAS,GAAG,IAAK,GAAG,KAAK,MAAM,KAAK,KAAK,GAAG,IAAK;CAC5F"}

package/src/actions/public/buildQuery.ts

@@ -1,10 +0,0 @@
-import type { ArkivClient } from "../../clients/baseClient"
-import { QueryBuilder } from "../../query/queryBuilder"
-
-/**
- * @deprecated Use `client.select()` (see SelectQueryBuilder) instead. `buildQuery()` returns
- * only the entity `key` unless data is explicitly opted in to, which is an easy mistake.
- */
-export async function buildQuery(client: ArkivClient) {
-  return new QueryBuilder(client)
-}

package/src/actions/public/subscribeEntityEvents.ts

@@ -1,119 +0,0 @@
-import { decodeEventLog, type Hex, parseAbi, toHex } from "viem"
-import type { ArkivClient } from "../../clients/baseClient"
-import type { PublicArkivClient } from "../../clients/createPublicClient"
-import type {
-  OnEntityCreatedEvent,
-  OnEntityDeletedEvent,
-  OnEntityExpiredEvent,
-  OnEntityExpiresInExtendedEvent,
-  OnEntityOwnerChangedEvent,
-  OnEntityUpdatedEvent,
-} from "../../types/events"
-import { getLogger } from "../../utils/logger"
-
-const logger = getLogger("actions:public:subscribe-entity-events")
-
-export const arkivABI = parseAbi([
-  "event ArkivEntityCreated(uint256 indexed entityKey, address indexed ownerAddress, uint256 expirationBlock, uint256 cost)",
-  "event ArkivEntityUpdated(uint256 indexed entityKey, address indexed ownerAddress, uint256 oldExpirationBlock, uint256 newExpirationBlock, uint256 cost)",
-  "event ArkivEntityExpired(uint256 indexed entityKey, address indexed ownerAddress)",
-  "event ArkivEntityDeleted(uint256 indexed entityKey, address indexed ownerAddress)",
-  "event ArkivEntityBTLExtended(uint256 indexed entityKey, address indexed ownerAddress, uint256 oldExpirationBlock, uint256 newExpirationBlock, uint256 cost)",
-  "event ArkivEntityOwnerChanged(uint256 indexed entityKey, address indexed oldOwnerAddress, address indexed newOwnerAddress)",
-])
-
-export async function subscribeEntityEvents(
-  client: ArkivClient,
-  {
-    onError,
-    onEntityCreated,
-    onEntityUpdated,
-    onEntityDeleted,
-    onEntityExpired,
-    onEntityExpiresInExtended,
-    onEntityOwnerChanged,
-  }: {
-    onError: ((error: Error) => void) | undefined
-    onEntityCreated?: ((event: OnEntityCreatedEvent) => void) | undefined
-    onEntityUpdated?: ((event: OnEntityUpdatedEvent) => void) | undefined
-    onEntityDeleted?: ((event: OnEntityDeletedEvent) => void) | undefined
-    onEntityExpired?: ((event: OnEntityExpiredEvent) => void) | undefined
-    onEntityExpiresInExtended?: ((event: OnEntityExpiresInExtendedEvent) => void) | undefined
-    onEntityOwnerChanged?: ((event: OnEntityOwnerChangedEvent) => void) | undefined
-  },
-  pollingInterval?: number,
-  fromBlock?: bigint,
-): Promise<() => void> {
-  const unsubscribe = (client as PublicArkivClient).watchEvent({
-    pollingInterval: pollingInterval ?? 1000,
-    fromBlock,
-    events: arkivABI,
-    onLogs: (logs) => {
-      logger("logs from subscribeEntityEvents %o", logs)
-      for (const log of logs) {
-        const event = decodeEventLog({
-          abi: arkivABI,
-          topics: log.topics as [Hex, ...Hex[]] | [],
-          data: log.data,
-        })
-        logger("event from subscribeEntityEvents %o", event)
-        switch (event.eventName) {
-          case "ArkivEntityCreated":
-            onEntityCreated?.({
-              entityKey: toHex(event.args.entityKey, { size: 32 }),
-              owner: event.args.ownerAddress,
-              expirationBlock: Number(event.args.expirationBlock),
-              cost: event.args.cost,
-            })
-            break
-          case "ArkivEntityUpdated":
-            onEntityUpdated?.({
-              entityKey: toHex(event.args.entityKey, { size: 32 }),
-              owner: event.args.ownerAddress,
-              oldExpirationBlock: Number(event.args.oldExpirationBlock),
-              newExpirationBlock: Number(event.args.newExpirationBlock),
-              cost: event.args.cost,
-            })
-            break
-          case "ArkivEntityDeleted":
-            onEntityDeleted?.({
-              entityKey: toHex(event.args.entityKey, { size: 32 }),
-              owner: event.args.ownerAddress,
-            })
-            break
-          case "ArkivEntityBTLExtended":
-            onEntityExpiresInExtended?.({
-              entityKey: toHex(event.args.entityKey, { size: 32 }),
-              owner: event.args.ownerAddress,
-              oldExpirationBlock: Number(event.args.oldExpirationBlock),
-              newExpirationBlock: Number(event.args.newExpirationBlock),
-              cost: event.args.cost,
-            })
-            break
-          case "ArkivEntityExpired":
-            onEntityExpired?.({
-              entityKey: toHex(event.args.entityKey, { size: 32 }),
-              owner: event.args.ownerAddress,
-            })
-            break
-          case "ArkivEntityOwnerChanged":
-            onEntityOwnerChanged?.({
-              entityKey: toHex(event.args.entityKey, { size: 32 }),
-              oldOwner: event.args.oldOwnerAddress,
-              newOwner: event.args.newOwnerAddress,
-            })
-            break
-          default:
-            console.warn("unknown event from subscribeEntityEvents", event)
-            break
-        }
-      }
-    },
-    onError: (error) => {
-      console.error("error from subscribeEntityEvents", error)
-      onError?.(error)
-    },
-  })
-
-  return unsubscribe
-}

package/src/actions/wallet/mutateEntities.ts

@@ -1,111 +0,0 @@
-import type { Hash, Hex, TransactionReceipt } from "viem"
-import type { ArkivClient } from "../../clients/baseClient"
-import type { TxParams } from "../../types"
-import { opsToTxData, sendArkivTransaction } from "../../utils/arkivTransactions"
-import { getLogger } from "../../utils/logger"
-import type { ChangeOwnershipParameters } from "./changeOwnership"
-
-const logger = getLogger("actions:wallet:mutate-entities")
-
-import type { CreateEntityParameters } from "./createEntity"
-import type { DeleteEntityParameters } from "./deleteEntity"
-import type { ExtendEntityParameters } from "./extendEntity"
-import type { UpdateEntityParameters } from "./updateEntity"
-
-/**
- * Parameters for the mutateEntities function.
- * - creates: The creates to perform.
- * - updates: The updates to perform.
- * - deletes: The deletes to perform.
- * - extensions: The extensions to perform.
- */
-export type MutateEntitiesParameters = {
-  creates?: CreateEntityParameters[]
-  updates?: UpdateEntityParameters[]
-  deletes?: DeleteEntityParameters[]
-  extensions?: ExtendEntityParameters[]
-  ownershipChanges?: ChangeOwnershipParameters[]
-}
-
-function parseReceipt(receipt: TransactionReceipt, params: MutateEntitiesParameters) {
-  const createdEntities: Hex[] = []
-  const updatedEntities: Hex[] = []
-  const deletedEntities: Hex[] = []
-  const extendedEntities: Hex[] = []
-  const ownershipChanges: Hex[] = []
-
-  const totalCreates = params.creates?.length ?? 0
-  const totalUpdates = params.updates?.length ?? 0
-  const totalDeletes = params.deletes?.length ?? 0
-  const totalExtensions = params.extensions?.length ?? 0
-
-  // iterate over all logs and parse the event
-  // logs go in the following order: creates, deleted, updates, extends, ownership changes
-  for (let index = 0; index < receipt.logs.length; index++) {
-    const log = receipt.logs[index]
-
-    if (index < totalCreates) {
-      createdEntities.push(log.topics[1] as Hex)
-    } else if (index < totalCreates + totalDeletes) {
-      deletedEntities.push(log.topics[1] as Hex)
-    } else if (index < totalCreates + totalUpdates + totalDeletes) {
-      updatedEntities.push(log.topics[1] as Hex)
-    } else if (index < totalCreates + totalUpdates + totalDeletes + totalExtensions) {
-      extendedEntities.push(log.topics[1] as Hex)
-    } else {
-      ownershipChanges.push(log.topics[1] as Hex)
-    }
-  }
-
-  return { createdEntities, updatedEntities, deletedEntities, extendedEntities, ownershipChanges }
-}
-
-/**
- * Return type for the mutateEntities function.
- * - txHash: The transaction hash.
- * - createdEntities: The keys of the created entities.
- * - updatedEntities: The keys of the updated entities.
- * - deletedEntities: The keys of the deleted entities.
- * - extendedEntities: The keys of the extended entities.
- * - ownershipChanges: The keys of the ownership changes.
- */
-export type MutateEntitiesReturnType = {
-  txHash: Hash
-  createdEntities: Hex[]
-  updatedEntities: Hex[]
-  deletedEntities: Hex[]
-  extendedEntities: Hex[]
-  ownershipChanges: Hex[]
-}
-export async function mutateEntities(
-  client: ArkivClient,
-  data: MutateEntitiesParameters,
-  txParams?: TxParams,
-): Promise<MutateEntitiesReturnType> {
-  if (!data.creates && !data.updates && !data.deletes && !data.extensions) {
-    throw new Error("No operations to perform")
-  }
-
-  const txData = opsToTxData({
-    creates: data.creates ?? [],
-    updates: data.updates ?? [],
-    deletes: data.deletes ?? [],
-    extensions: data.extensions ?? [],
-    ownershipChanges: data.ownershipChanges ?? [],
-  })
-
-  const receipt = await sendArkivTransaction(client, txData, txParams)
-
-  logger("Receipt from mutateEntities %o", receipt)
-
-  const { createdEntities, updatedEntities, deletedEntities, extendedEntities, ownershipChanges } =
-    parseReceipt(receipt, data)
-  return {
-    txHash: receipt.transactionHash as Hash,
-    createdEntities,
-    updatedEntities,
-    deletedEntities,
-    extendedEntities,
-    ownershipChanges,
-  }
-}

package/src/actions/wallet/updateEntity.ts

@@ -1,60 +0,0 @@
-import type { Hash, Hex } from "viem"
-import type { ArkivClient } from "../../clients/baseClient"
-import type { Attribute, MimeType, TxParams } from "../../types"
-import { opsToTxData, sendArkivTransaction } from "../../utils/arkivTransactions"
-import { getLogger } from "../../utils/logger"
-
-const logger = getLogger("actions:wallet:update-entity")
-
-/**
- * Parameters for the updateEntity function.
- * - entityKey: The key of the entity to update.
- * - payload: The payload of the entity.
- * - attributes: The attributes of the entity. Attribute values may be strings
- *   or numbers, but numeric values **must be integers**. To store a non-integer,
- *   scale it to an integer (e.g. `1.5` -> `1500`) to preserve numeric ordering,
- *   or pass it as a string (e.g. `"1.5"`). A non-integer numeric value throws an
- *   {@link InvalidAttributeError}.
- * - contentType: The content type of the entity.
- * - expiresIn: How long until the entity expires, in seconds. Because Arkiv
- *   measures expiration in blocks (1 block = 2 seconds), this **must be a
- *   positive integer and a multiple of the block time (2 seconds)**.
- *   Invalid values throw an {@link InvalidExpirationError}.
- */
-export type UpdateEntityParameters = {
-  entityKey: Hex
-  payload: Uint8Array
-  /** Entity attributes. Numeric values must be integers (scale non-integers, e.g. `1.5` -> `1500`, or use a string). Throws {@link InvalidAttributeError} otherwise. */
-  attributes: Attribute[]
-  contentType: MimeType | string
-  /** Seconds until expiry. Must be a positive integer and a multiple of the 2s block time.
-   * Throws {@link InvalidExpirationError} otherwise. */
-  expiresIn: number
-}
-
-/**
- * Return type for the updateEntity function.
- * - entityKey: The key of the entity.
- * - txHash: The transaction hash.
- */
-export type UpdateEntityReturnType = {
-  entityKey: Hex
-  txHash: Hash
-}
-
-export async function updateEntity(
-  client: ArkivClient,
-  data: UpdateEntityParameters,
-  txParams?: TxParams,
-): Promise<UpdateEntityReturnType> {
-  logger("updateEntity %o", data)
-  const txData = opsToTxData({ updates: [data] })
-  const receipt = await sendArkivTransaction(client, txData, txParams)
-
-  logger("Receipt from updateEntity %o", receipt)
-
-  return {
-    txHash: receipt.transactionHash as Hash,
-    entityKey: receipt.logs[0].topics[1] as Hex,
-  }
-}

package/src/chains/braga.ts

@@ -1,26 +0,0 @@
-import { defineChain } from "viem"
-
-export const braga = defineChain({
-  id: 60138453102,
-  name: "Braga",
-  network: "braga",
-  nativeCurrency: {
-    name: "Golem",
-    symbol: "GLM",
-    decimals: 18,
-  },
-  rpcUrls: {
-    default: {
-      http: ["https://braga.hoodi.arkiv.network/rpc"],
-      webSocket: ["wss://braga.hoodi.arkiv.network/rpc/ws"],
-    },
-  },
-  blockExplorers: {
-    default: {
-      name: "Braga Arkiv Explorer",
-      url: "https://explorer.braga.hoodi.arkiv.network",
-      apiUrl: "https://explorer.braga.hoodi.arkiv.network/api",
-    },
-  },
-  testnet: true,
-})

package/src/chains/kaolin.ts

@@ -1,29 +0,0 @@
-import { defineChain } from "viem"
-
-/**
- * @deprecated The kaolin network is getting removed on may 15th 2026. Migration guide: https://docs.arkiv.network/networks/migrate-from-kaolin/
- */
-export const kaolin = defineChain({
-  id: 60138453025,
-  name: "Kaolin",
-  network: "kaolin",
-  nativeCurrency: {
-    name: "Ethereum",
-    symbol: "ETH",
-    decimals: 18,
-  },
-  rpcUrls: {
-    default: {
-      http: ["https://kaolin.hoodi.arkiv.network/rpc"],
-      webSocket: ["wss://kaolin.hoodi.arkiv.network/rpc/ws"],
-    },
-  },
-  blockExplorers: {
-    default: {
-      name: "Kaolin Arkiv Explorer",
-      url: "https://explorer.kaolin.hoodi.arkiv.network",
-      apiUrl: "https://explorer.kaolin.hoodi.arkiv.network/api",
-    },
-  },
-  testnet: true,
-})