@arkiv-network/sdk 0.0.36-dev.6 → 0.1.0

package/package.json

@@ -1,118 +1,120 @@
 {
-	"name": "@arkiv-network/sdk",
-	"version": "0.0.36-dev.6",
-	"description": "TypeScript-only client library for Arkiv blockchain interactions",
-	"type": "module",
-	"main": "./dist/_cjs/index.js",
-	"module": "./dist/_esm/index.js",
-	"types": "./dist/_types/index.d.ts",
-	"typings": "./dist/_types/index.d.ts",
-	"sideEffects": false,
-	"exports": {
-		".": {
-			"source": "./src/index.ts",
-			"types": "./dist/_types/index.d.ts",
-			"import": "./dist/_esm/index.js",
-			"default": "./dist/_cjs/index.js"
-		},
-		"./chains": {
-			"source": "./src/chains/index.ts",
-			"types": "./dist/_types/chains/index.d.ts",
-			"import": "./dist/_esm/chains/index.js",
-			"default": "./dist/_cjs/chains/index.js"
-		},
-		"./accounts": {
-			"source": "./src/accounts/index.ts",
-			"types": "./dist/_types/accounts/index.d.ts",
-			"import": "./dist/_esm/accounts/index.js",
-			"default": "./dist/_cjs/accounts/index.js"
-		},
-		"./utils": {
-			"source": "./src/utils/index.ts",
-			"types": "./dist/_types/utils/index.d.ts",
-			"import": "./dist/_esm/utils/index.js",
-			"default": "./dist/_cjs/utils/index.js"
-		},
-		"./query": {
-			"source": "./src/query/index.ts",
-			"types": "./dist/_types/query/index.d.ts",
-			"import": "./dist/_esm/query/index.js",
-			"default": "./dist/_cjs/query/index.js"
-		},
-		"./package.json": "./package.json"
-	},
-	"typesVersions": {
-		"*": {
-			"chains": [
-				"./dist/_types/chains/index.d.ts"
-			],
-			"accounts": [
-				"./dist/_types/accounts/index.d.ts"
-			],
-			"utils": [
-				"./dist/_types/utils/index.d.ts"
-			],
-			"query": [
-				"./dist/_types/query/index.d.ts"
-			]
-		}
-	},
-	"files": [
-		"dist/**/*.js",
-		"dist/**/*.js.map",
-		"dist/**/*.d.ts",
-		"dist/**/*.d.ts.map",
-		"src/**/*.ts",
-		"!src/**/*.test.ts",
-		"!src/**/*.spec.ts"
-	],
-	"scripts": {
-		"build": "rimraf dist && bun run build:cjs && bun run build:esm && bun run build:types",
-		"build:cjs": "tsc --project tsconfig.cjs.json",
-		"build:esm": "tsc --project tsconfig.esm.json",
-		"build:types": "tsc --project tsconfig.types.json",
-		"postbuild": "rimraf *.tsbuildinfo",
-		"type-check": "tsc --noEmit",
-		"lint": "biome check src/",
-		"lint:fix": "biome check --write src/",
-		"package": "rimraf arkiv-network-sdk-*.tgz && bun run build && bun pm pack --no-cache",
-		"package:test": "bun run package && mv arkiv-network-sdk-*.tgz arkiv-network-sdk-latest.tgz",
-		"prepublishOnly": "bun run build && bun run package && mv arkiv-network-sdk-*.tgz arkiv-network-sdk-latest.tgz",
-		"publish-main": "npm publish ./arkiv-network-sdk-latest.tgz --access public",
-		"publish-main:dry": "npm publish ./arkiv-network-sdk-latest.tgz --access public --dry-run",
-		"publish-dev": "npm version prerelease --preid=dev && npm publish ./arkiv-network-sdk-latest.tgz --access public --tag dev",
-		"publish-dev:dry": "npm version prerelease --preid=dev && npm publish ./arkiv-network-sdk-latest.tgz --access public --tag dev --dry-run"
-	},
-	"devDependencies": {
-		"@biomejs/biome": "2.2.4",
-		"@types/bun": "latest",
-		"rimraf": "^6.0.1"
-	},
-	"peerDependencies": {
-		"typescript": "^5.0.0"
-	},
-	"peerDependenciesMeta": {
-		"typescript": {
-			"optional": false
-		}
-	},
-	"engines": {
-		"node": ">=18.0.0"
-	},
-	"keywords": [
-		"typescript",
-		"blockchain",
-		"golem",
-		"arkiv",
-		"golemdb",
-		"ethereum",
-		"viem"
-	],
-	"repository": {
-		"type": "git",
-		"url": "https://github.com/Arkiv-Network/arkiv-sdk-js.git"
-	},
-	"dependencies": {
-		"viem": "^2.38.2"
-	}
+  "name": "@arkiv-network/sdk",
+  "version": "0.1.0",
+  "description": "TypeScript-only client library for Arkiv blockchain interactions",
+  "type": "module",
+  "main": "./dist/_cjs/index.js",
+  "module": "./dist/_esm/index.js",
+  "types": "./dist/_types/index.d.ts",
+  "typings": "./dist/_types/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "source": "./src/index.ts",
+      "types": "./dist/_types/index.d.ts",
+      "import": "./dist/_esm/index.js",
+      "default": "./dist/_cjs/index.js"
+    },
+    "./chains": {
+      "source": "./src/chains/index.ts",
+      "types": "./dist/_types/chains/index.d.ts",
+      "import": "./dist/_esm/chains/index.js",
+      "default": "./dist/_cjs/chains/index.js"
+    },
+    "./accounts": {
+      "source": "./src/accounts/index.ts",
+      "types": "./dist/_types/accounts/index.d.ts",
+      "import": "./dist/_esm/accounts/index.js",
+      "default": "./dist/_cjs/accounts/index.js"
+    },
+    "./utils": {
+      "source": "./src/utils/index.ts",
+      "types": "./dist/_types/utils/index.d.ts",
+      "import": "./dist/_esm/utils/index.js",
+      "default": "./dist/_cjs/utils/index.js"
+    },
+    "./query": {
+      "source": "./src/query/index.ts",
+      "types": "./dist/_types/query/index.d.ts",
+      "import": "./dist/_esm/query/index.js",
+      "default": "./dist/_cjs/query/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "typesVersions": {
+    "*": {
+      "chains": [
+        "./dist/_types/chains/index.d.ts"
+      ],
+      "accounts": [
+        "./dist/_types/accounts/index.d.ts"
+      ],
+      "utils": [
+        "./dist/_types/utils/index.d.ts"
+      ],
+      "query": [
+        "./dist/_types/query/index.d.ts"
+      ]
+    }
+  },
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.js.map",
+    "dist/**/*.d.ts",
+    "dist/**/*.d.ts.map",
+    "src/**/*.ts",
+    "!src/**/*.test.ts",
+    "!src/**/*.spec.ts"
+  ],
+  "scripts": {
+    "build": "rimraf dist && bun run build:cjs && bun run build:esm && bun run build:types",
+    "build:cjs": "tsc --project tsconfig.cjs.json",
+    "build:esm": "tsc --project tsconfig.esm.json",
+    "build:types": "tsc --project tsconfig.types.json",
+    "postbuild": "rimraf *.tsbuildinfo",
+    "type-check": "tsc --noEmit",
+    "lint": "biome check src/",
+    "lint:fix": "biome check --write src/",
+    "package": "rimraf arkiv-network-sdk-*.tgz && bun run build && bun pm pack --no-cache",
+    "package:test": "bun run package && mv arkiv-network-sdk-*.tgz arkiv-network-sdk-latest.tgz",
+    "prepublishOnly": "bun run build && bun run package && mv arkiv-network-sdk-*.tgz arkiv-network-sdk-latest.tgz",
+    "publish-main": "npm publish ./arkiv-network-sdk-latest.tgz --access public",
+    "publish-main:dry": "npm publish ./arkiv-network-sdk-latest.tgz --access public --dry-run",
+    "publish-dev": "npm version prerelease --preid=dev && npm publish ./arkiv-network-sdk-latest.tgz --access public --tag dev",
+    "publish-dev:dry": "npm version prerelease --preid=dev && npm publish ./arkiv-network-sdk-latest.tgz --access public --tag dev --dry-run"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "2.2.4",
+    "@types/bun": "latest",
+    "rimraf": "^6.0.1"
+  },
+  "peerDependencies": {
+    "typescript": "^5.0.0"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": false
+    }
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "keywords": [
+    "typescript",
+    "blockchain",
+    "golem",
+    "arkiv",
+    "golemdb",
+    "ethereum",
+    "viem"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Arkiv-Network/arkiv-sdk-js.git"
+  },
+  "dependencies": {
+    "@bokuweb/zstd-wasm": "^0.0.27",
+    "@oneidentity/zstd-js": "^1.0.3",
+    "viem": "^2.38.2"
+  }
 }

package/src/actions/public/buildQuery.ts

@@ -2,5 +2,5 @@ import type { ArkivClient } from "../../clients/baseClient"
 import { QueryBuilder } from "../../query/queryBuilder"
 
 export async function buildQuery(client: ArkivClient) {
-	return new QueryBuilder(client)
+  return new QueryBuilder(client)
 }

package/src/actions/public/getBlockTiming.ts

@@ -1,20 +1,20 @@
 import type { ArkivClient } from "../../clients/baseClient"
 
 export type GetBlockTimingReturnType = {
-	currentBlock: bigint
-	currentBlockTime: number
-	blockDuration: number
+  currentBlock: bigint
+  currentBlockTime: number
+  blockDuration: number
 }
 
 export async function getBlockTiming(client: ArkivClient) {
-	const blockTiming = await client.request({
-		method: "arkiv_getBlockTiming",
-		params: [],
-	})
-	console.debug("Block timing", blockTiming)
-	return {
-		currentBlock: blockTiming.current_block,
-		currentBlockTime: blockTiming.current_block_time,
-		blockDuration: blockTiming.duration,
-	}
+  const blockTiming = await client.request({
+    method: "arkiv_getBlockTiming",
+    params: [],
+  })
+  console.debug("Block timing", blockTiming)
+  return {
+    currentBlock: blockTiming.current_block,
+    currentBlockTime: blockTiming.current_block_time,
+    blockDuration: blockTiming.duration,
+  }
 }

package/src/actions/public/getEntity.ts

@@ -4,15 +4,15 @@ import { NoEntityFoundError } from "../../query/errors"
 import { entityFromRpcResult } from "../../utils/entities"
 
 export async function getEntity(client: ArkivClient, key: Hex) {
-	const result = await client.request({
-		method: "arkiv_query",
-		params: [`$key = ${key}`],
-	})
-	console.debug("GetEntity result", result)
+  const result = await client.request({
+    method: "arkiv_query",
+    params: [`$key = ${key}`],
+  })
+  console.debug("GetEntity result", result)
 
-	if (!result.data) {
-		throw new NoEntityFoundError()
-	}
+  if (!result.data) {
+    throw new NoEntityFoundError()
+  }
 
-	return entityFromRpcResult(result.data[0])
+  return entityFromRpcResult(result.data[0])
 }

package/src/actions/public/getEntityCount.ts

@@ -1,10 +1,10 @@
 import type { ArkivClient } from "../../clients/baseClient"
 
 export async function getEntityCount(client: ArkivClient) {
-	const count = await client.request({
-		method: "arkiv_getEntityCount",
-		params: [],
-	})
+  const count = await client.request({
+    method: "arkiv_getEntityCount",
+    params: [],
+  })
 
-	return count
+  return count
 }

package/src/actions/public/query.ts

@@ -2,12 +2,12 @@ import type { ArkivClient } from "../../clients/baseClient"
 import { entityFromRpcResult } from "../../utils/entities"
 
 export async function query(client: ArkivClient, query: string) {
-	const result = await client.request({
-		method: "arkiv_query",
-		params: [query],
-	})
+  const result = await client.request({
+    method: "arkiv_query",
+    params: [query],
+  })
 
-	const entities = await Promise.all(result.data.map((entity) => entityFromRpcResult(entity)))
+  const entities = await Promise.all(result.data.map((entity) => entityFromRpcResult(entity)))
 
-	return entities
+  return entities
 }

package/src/actions/public/subscribeEntityEvents.ts

@@ -2,104 +2,104 @@ import { decodeEventLog, parseAbi, toHex } from "viem"
 import type { ArkivClient } from "../../clients/baseClient"
 import type { PublicArkivClient } from "../../clients/createPublicClient"
 import type {
-	OnEntityCreatedEvent,
-	OnEntityDeletedEvent,
-	OnEntityExpiredEvent,
-	OnEntityExpiresInExtendedEvent,
-	OnEntityUpdatedEvent,
+  OnEntityCreatedEvent,
+  OnEntityDeletedEvent,
+  OnEntityExpiredEvent,
+  OnEntityExpiresInExtendedEvent,
+  OnEntityUpdatedEvent,
 } from "../../types/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 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)",
 ])
 
 export async function subscribeEntityEvents(
-	client: ArkivClient,
-	{
-		onError,
-		onEntityCreated,
-		onEntityUpdated,
-		onEntityDeleted,
-		onEntityExpired,
-		onEntityExpiresInExtended,
-	}: {
-		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
-	},
-	pollingInterval?: number,
-	fromBlock?: bigint,
+  client: ArkivClient,
+  {
+    onError,
+    onEntityCreated,
+    onEntityUpdated,
+    onEntityDeleted,
+    onEntityExpired,
+    onEntityExpiresInExtended,
+  }: {
+    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
+  },
+  pollingInterval?: number,
+  fromBlock?: bigint,
 ): Promise<() => void> {
-	const unsubscribe = (client as PublicArkivClient).watchEvent({
-		pollingInterval: pollingInterval ?? 1000,
-		fromBlock: fromBlock ?? 0n,
-		events: arkivABI,
-		onLogs: (logs) => {
-			console.debug("logs from subscribeEntityEvents", logs)
-			for (const log of logs) {
-				const event = decodeEventLog({
-					abi: arkivABI,
-					topics: log.topics,
-					data: log.data,
-				})
-				console.debug("event from subscribeEntityEvents", 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
-					default:
-						console.warn("unknown event from subscribeEntityEvents", event)
-						break
-				}
-			}
-		},
-		onError: (error) => {
-			console.error("error from subscribeEntityEvents", error)
-			onError?.(error)
-		},
-	})
+  const unsubscribe = (client as PublicArkivClient).watchEvent({
+    pollingInterval: pollingInterval ?? 1000,
+    fromBlock: fromBlock ?? 0n,
+    events: arkivABI,
+    onLogs: (logs) => {
+      console.debug("logs from subscribeEntityEvents", logs)
+      for (const log of logs) {
+        const event = decodeEventLog({
+          abi: arkivABI,
+          topics: log.topics,
+          data: log.data,
+        })
+        console.debug("event from subscribeEntityEvents", 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
+          default:
+            console.warn("unknown event from subscribeEntityEvents", event)
+            break
+        }
+      }
+    },
+    onError: (error) => {
+      console.error("error from subscribeEntityEvents", error)
+      onError?.(error)
+    },
+  })
 
-	return unsubscribe
+  return unsubscribe
 }

package/src/actions/wallet/changeOwnership.ts

@@ -0,0 +1,40 @@
+import type { Hex } from "viem"
+import type { ArkivClient } from "../../clients/baseClient"
+import type { TxParams } from "../../types"
+import { opsToTxData, sendArkivTransaction } from "../../utils/arkivTransactions"
+
+/**
+ * Parameters for the deleteEntity function.
+ * - entityKey: The key of the entity to delete.
+ */
+export type ChangeOwnershipParameters = {
+  entityKey: Hex
+  newOwner: Hex
+}
+
+/**
+ * Return type for the deleteEntity function.
+ * - entityKey: The key of the entity.
+ * - txHash: The transaction hash.
+ */
+export type ChangeOwnershipReturnType = {
+  entityKey: Hex
+  txHash: string
+}
+
+export async function changeOwnership(
+  client: ArkivClient,
+  data: ChangeOwnershipParameters,
+  txParams?: TxParams,
+): Promise<ChangeOwnershipReturnType> {
+  console.debug("changeOwnership", data)
+  const txData = opsToTxData({ ownershipChanges: [data] })
+  const receipt = await sendArkivTransaction(client, txData, txParams)
+
+  console.debug("Receipt from changeOwnership", receipt)
+
+  return {
+    txHash: receipt.transactionHash,
+    entityKey: data.entityKey,
+  }
+}

package/src/actions/wallet/createEntity.ts

@@ -1,18 +1,20 @@
 import type { Hex } from "viem"
 import type { ArkivClient } from "../../clients/baseClient"
-import type { Annotation, TxParams } from "../../types"
+import type { Attribute, MimeType, TxParams } from "../../types"
 import { opsToTxData, sendArkivTransaction } from "../../utils/arkivTransactions"
 
 /**
  * Parameters for the createEntity function.
  * - payload: The payload of the entity.
- * - annotations: The annotations of the entity.
+ * - attributes: The attributes of the entity.
+ * - contentType: The content type of the entity.
  * - expiresIn: The expires in of the entity in seconds.
  */
 export type CreateEntityParameters = {
-	payload: Uint8Array
-	annotations: Annotation[]
-	expiresIn: number
+  payload: Uint8Array
+  attributes: Attribute[]
+  contentType: MimeType
+  expiresIn: number
 }
 
 /**
@@ -21,23 +23,23 @@ export type CreateEntityParameters = {
  * - txHash: The transaction hash.
  */
 export type CreateEntityReturnType = {
-	entityKey: Hex
-	txHash: string
+  entityKey: Hex
+  txHash: string
 }
 
 export async function createEntity(
-	client: ArkivClient,
-	data: CreateEntityParameters,
-	txParams?: TxParams,
+  client: ArkivClient,
+  data: CreateEntityParameters,
+  txParams?: TxParams,
 ): Promise<CreateEntityReturnType> {
-	console.debug("createEntity", data)
-	const txData = opsToTxData({ creates: [data] })
-	const receipt = await sendArkivTransaction(client, txData, txParams)
+  console.debug("createEntity", data)
+  const txData = opsToTxData({ creates: [data] })
+  const receipt = await sendArkivTransaction(client, txData, txParams)
 
-	console.debug("Receipt from createEntity", receipt)
+  console.debug("Receipt from createEntity", receipt)
 
-	return {
-		txHash: receipt.transactionHash,
-		entityKey: receipt.logs[0].topics[1] as Hex,
-	}
+  return {
+    txHash: receipt.transactionHash,
+    entityKey: receipt.logs[0].topics[1] as Hex,
+  }
 }