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

package/src/types/rpcSchema.ts

@@ -1,68 +1,61 @@
 import type { Hex, PublicRpcSchema } from "viem"
+import type { MimeType } from "./mimeTypes"
 
 export type RpcEntity = {
-	key: Hex
-	value: string
-	expiresAt: bigint
-	owner: Hex
-	stringAnnotations?: [{ key: string; value: string }]
-	numericAnnotations?: [{ key: string; value: number }]
+  key: Hex
+  contentType: MimeType
+  value: string
+  expiresAt: bigint
+  owner: Hex
+  stringAttributes?: [{ key: string; value: string }]
+  numericAttributes?: [{ key: string; value: number }]
 }
 
 export type RpcQueryOptions = {
-	atBlock?: number
-	includeData?: RpcIncludeData
-	resultsPerPage?: number
-	cursor?: string
+  atBlock?: number
+  includeData?: RpcIncludeData
+  resultsPerPage?: number
+  cursor?: string
 }
 
 export type RpcIncludeData = {
-	key: boolean
-	annotations: boolean
-	payload: boolean
-	expiration: boolean
-	owner: boolean
+  key: boolean
+  attributes: boolean
+  payload: boolean
+  contentType: boolean
+  expiration: boolean
+  owner: boolean
 }
 
 export type ArkivRpcSchema = [
-	{
-		Method: "golembase_getStorageValue"
-		Parameters?: [entityId: Hex]
-		ReturnType: string
-	},
-	{
-		Method: "arkiv_query"
-		Parameters?: [query: string, queryOptions?: RpcQueryOptions]
-		ReturnType: {
-			data: [RpcEntity]
-			blockNumber: bigint
-			cursor: string
-		}
-	},
-	{
-		Method: "golembase_getEntityMetaData"
-		Parameters?: [entityId: Hex]
-		ReturnType: {
-			expiresAtBlock: number
-			owner: Hex
-			numericAnnotations: [{ key: string; value: number }]
-			stringAnnotations: [{ key: string; value: string }]
-		}
-	},
-	{
-		Method: "arkiv_getBlockTiming"
-		Parameters?: []
-		ReturnType: {
-			current_block: bigint
-			current_block_time: number
-			duration: number
-		}
-	},
-	{
-		Method: "arkiv_getEntityCount"
-		Parameters?: []
-		ReturnType: number
-	},
+  {
+    Method: "golembase_getStorageValue"
+    Parameters?: [entityId: Hex]
+    ReturnType: string
+  },
+  {
+    Method: "arkiv_query"
+    Parameters?: [query: string, queryOptions?: RpcQueryOptions]
+    ReturnType: {
+      data: [RpcEntity]
+      blockNumber: bigint
+      cursor: string
+    }
+  },
+  {
+    Method: "arkiv_getBlockTiming"
+    Parameters?: []
+    ReturnType: {
+      current_block: bigint
+      current_block_time: number
+      duration: number
+    }
+  },
+  {
+    Method: "arkiv_getEntityCount"
+    Parameters?: []
+    ReturnType: number
+  },
 ]
 
 export type PublicArkivRpcSchema = [...PublicRpcSchema, ...ArkivRpcSchema]

package/src/types/txParams.ts

@@ -1,15 +1,15 @@
 export type TxParams =
-	| {
-			gas?: bigint
-			nonce?: number
-			gasPrice?: bigint
-			maxFeePerGas?: never
-			maxPriorityFeePerGas?: never
-	  }
-	| {
-			gas?: bigint
-			nonce?: number
-			maxFeePerGas?: bigint
-			maxPriorityFeePerGas?: bigint
-			gasPrice?: never
-	  }
+  | {
+      gas?: bigint
+      nonce?: number
+      gasPrice?: bigint
+      maxFeePerGas?: never
+      maxPriorityFeePerGas?: never
+    }
+  | {
+      gas?: bigint
+      nonce?: number
+      maxFeePerGas?: bigint
+      maxPriorityFeePerGas?: bigint
+      gasPrice?: never
+    }

package/src/utils/arkivTransactions.ts

@@ -1,4 +1,5 @@
-import { type Hex, toHex, toRlp } from "viem"
+import { type Hex, toBytes, toHex, toRlp } from "viem"
+import type { ChangeOwnershipParameters } from "../actions/wallet/changeOwnership"
 import type { CreateEntityParameters } from "../actions/wallet/createEntity"
 import type { DeleteEntityParameters } from "../actions/wallet/deleteEntity"
 import type { ExtendEntityParameters } from "../actions/wallet/extendEntity"
@@ -7,85 +8,93 @@ import type { ArkivClient } from "../clients/baseClient"
 import type { WalletArkivClient } from "../clients/createWalletClient"
 import { ARKIV_ADDRESS, BLOCK_TIME } from "../consts"
 import type { TxParams } from "../types"
+import { compress } from "./compression"
 
 export function opsToTxData({
-	creates,
-	updates,
-	deletes,
-	extensions,
+  creates,
+  updates,
+  deletes,
+  extensions,
+  ownershipChanges,
 }: {
-	creates?: CreateEntityParameters[]
-	updates?: UpdateEntityParameters[]
-	deletes?: DeleteEntityParameters[]
-	extensions?: ExtendEntityParameters[]
+  creates?: CreateEntityParameters[]
+  updates?: UpdateEntityParameters[]
+  deletes?: DeleteEntityParameters[]
+  extensions?: ExtendEntityParameters[]
+  ownershipChanges?: ChangeOwnershipParameters[]
 }) {
-	function formatAnnotation<T extends string | number | bigint | boolean>(annotation: {
-		key: string
-		value: T
-	}): [Hex, Hex] {
-		return [toHex(annotation.key), toHex(annotation.value)]
-	}
+  function formatAttributes<T extends string | number | bigint | boolean>(attribute: {
+    key: string
+    value: T
+  }): [Hex, Hex] {
+    return [toHex(attribute.key), toHex(attribute.value)]
+  }
 
-	const payload = [
-		//creates
-		(creates ?? []).map((item) => [
-			toHex(item.expiresIn / BLOCK_TIME),
-			toHex(item.payload),
-			item.annotations
-				.filter((annotation) => typeof annotation.value === "string")
-				.map(formatAnnotation),
-			item.annotations
-				.filter((annotation) => typeof annotation.value === "number")
-				.map(formatAnnotation),
-		]),
-		//updates
-		(updates ?? []).map((item) => [
-			item.entityKey,
-			toHex(item.expiresIn / BLOCK_TIME),
-			toHex(item.payload),
-			item.annotations
-				.filter((annotation) => typeof annotation.value === "string")
-				.map(formatAnnotation),
-			item.annotations
-				.filter((annotation) => typeof annotation.value === "number")
-				.map(formatAnnotation),
-		]),
-		//deletes
-		(deletes ?? []).map((item) => item.entityKey),
-		//extends
-		(extensions ?? []).map((item) => [item.entityKey, toHex(item.expiresIn / BLOCK_TIME)]),
-	]
+  const payload = [
+    //creates
+    (creates ?? []).map((item) => [
+      toHex(item.expiresIn / BLOCK_TIME),
+      toHex(item.contentType),
+      toHex(item.payload),
+      item.attributes
+        .filter((attribute) => typeof attribute.value === "string")
+        .map(formatAttributes),
+      item.attributes
+        .filter((attribute) => typeof attribute.value === "number")
+        .map(formatAttributes),
+    ]),
+    //updates
+    (updates ?? []).map((item) => [
+      item.entityKey,
+      toHex(item.contentType),
+      toHex(item.expiresIn / BLOCK_TIME),
+      toHex(item.payload),
+      item.attributes
+        .filter((attribute) => typeof attribute.value === "string")
+        .map(formatAttributes),
+      item.attributes
+        .filter((attribute) => typeof attribute.value === "number")
+        .map(formatAttributes),
+    ]),
+    //deletes
+    (deletes ?? []).map((item) => item.entityKey),
+    //extends
+    (extensions ?? []).map((item) => [item.entityKey, toHex(item.expiresIn / BLOCK_TIME)]),
+    //ownershipChanges TODO
+    (ownershipChanges ?? []).map((item) => [item.entityKey, item.newOwner]),
+  ]
 
-	console.debug("txData to send as RLP", payload)
+  console.debug("txData to send as RLP", payload, payload.length)
 
-	return toRlp(payload)
+  return toRlp(payload)
 }
 
 export async function sendArkivTransaction(client: ArkivClient, data: Hex, txParams?: TxParams) {
-	if (!client.account) throw new Error("Account required")
-	const walletClient = client as WalletArkivClient
+  if (!client.account) throw new Error("Account required")
+  const walletClient = client as WalletArkivClient
 
-	console.debug("Sending transaction", {
-		account: client.account,
-		chain: client.chain,
-		to: ARKIV_ADDRESS,
-		value: 0n,
-		data,
-		...txParams,
-	})
+  console.debug("Sending transaction", {
+    account: client.account,
+    chain: client.chain,
+    to: ARKIV_ADDRESS,
+    value: 0n,
+    data,
+    ...txParams,
+  })
 
-	const txHash = await walletClient.sendTransaction({
-		account: client.account,
-		chain: client.chain,
-		to: ARKIV_ADDRESS,
-		value: 0n,
-		data,
-		...txParams,
-	})
+  const compressed = await compress(toBytes(data))
+  const txHash = await walletClient.sendTransaction({
+    account: client.account,
+    chain: client.chain,
+    to: ARKIV_ADDRESS,
+    value: 0n,
+    data: toHex(compressed),
+    ...txParams,
+  })
 
-	const receipt = await walletClient.waitForTransactionReceipt({ hash: txHash })
+  const receipt = await walletClient.waitForTransactionReceipt({ hash: txHash })
 
-	console.debug("Tx receipt", receipt)
+  console.debug("Tx receipt", receipt)
 
-	return receipt
+  return receipt
 }

package/src/utils/compression.ts

@@ -0,0 +1,21 @@
+import { init, compress as zstdCompress, decompress as zstdDecompress } from "@bokuweb/zstd-wasm"
+
+let initialized = false
+export async function compress(data: Uint8Array): Promise<Uint8Array> {
+  if (!initialized) {
+    await init()
+    initialized = true
+  }
+  console.debug(`Compressing data (size: ${data.length})`)
+  const compressed = await zstdCompress(data)
+  console.debug(`Compressed data (size: ${compressed.length})`)
+  return new Uint8Array(compressed)
+}
+
+export async function decompress(data: Uint8Array): Promise<Uint8Array> {
+  if (!initialized) {
+    await init()
+    initialized = true
+  }
+  return await zstdDecompress(data)
+}

package/src/utils/entities.ts

@@ -3,14 +3,21 @@ import { Entity } from "../types/entity"
 import type { RpcEntity } from "../types/rpcSchema"
 
 export async function entityFromRpcResult(rpcEntity: RpcEntity) {
-	return new Entity(rpcEntity.key, rpcEntity.owner, rpcEntity.expiresAt, toBytes(rpcEntity.value), [
-		...(rpcEntity.stringAnnotations ?? []).map(({ key, value }) => ({
-			key,
-			value,
-		})),
-		...(rpcEntity.numericAnnotations ?? []).map(({ key, value }) => ({
-			key,
-			value: value,
-		})),
-	])
+  return new Entity(
+    rpcEntity.key,
+    rpcEntity.contentType,
+    rpcEntity.owner,
+    rpcEntity.expiresAt,
+    toBytes(rpcEntity.value),
+    [
+      ...(rpcEntity.stringAttributes ?? []).map(({ key, value }) => ({
+        key,
+        value,
+      })),
+      ...(rpcEntity.numericAttributes ?? []).map(({ key, value }) => ({
+        key,
+        value: Number(value),
+      })),
+    ],
+  )
 }

package/src/utils/expirationTime.ts

@@ -1,13 +1,13 @@
 import { BLOCK_TIME } from "../consts"
 
 export const ExpirationTime = {
-	fromSeconds: (seconds: number) => seconds,
-	fromMinutes: (minutes: number) => minutes * 60,
-	fromHours: (hours: number) => hours * 60 * 60,
-	fromDays: (days: number) => days * 24 * 60 * 60,
-	fromWeeks: (weeks: number) => weeks * 7 * 24 * 60 * 60,
-	fromMonths: (months: number) => months * 30 * 24 * 60 * 60,
-	fromYears: (years: number) => years * 365 * 24 * 60 * 60,
-	fromBlocks: (blocks: number) => blocks * BLOCK_TIME,
-	fromDate: (date: Date) => Math.floor(date.getTime() / 1000) - Math.floor(Date.now() / 1000),
+  fromSeconds: (seconds: number) => seconds,
+  fromMinutes: (minutes: number) => minutes * 60,
+  fromHours: (hours: number) => hours * 60 * 60,
+  fromDays: (days: number) => days * 24 * 60 * 60,
+  fromWeeks: (weeks: number) => weeks * 7 * 24 * 60 * 60,
+  fromMonths: (months: number) => months * 30 * 24 * 60 * 60,
+  fromYears: (years: number) => years * 365 * 24 * 60 * 60,
+  fromBlocks: (blocks: number) => blocks * BLOCK_TIME,
+  fromDate: (date: Date) => Math.floor(date.getTime() / 1000) - Math.floor(Date.now() / 1000),
 }

package/src/utils/payload.ts

@@ -1,9 +1,9 @@
 import { toBytes } from "viem"
 
 export function jsonToPayload(json: object): Uint8Array {
-	return toBytes(JSON.stringify(json))
+  return toBytes(JSON.stringify(json))
 }
 
 export function stringToPayload(data: string): Uint8Array {
-	return toBytes(data)
+  return toBytes(data)
 }

package/dist/_cjs/types/annotation.d.ts

@@ -1,5 +0,0 @@
-export type Annotation = {
-    key: string;
-    value: string | number;
-};
-//# sourceMappingURL=annotation.d.ts.map

package/dist/_cjs/types/annotation.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"annotation.d.ts","sourceRoot":"","sources":["../../../src/types/annotation.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GAAG;IACxB,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;CACtB,CAAA"}

package/dist/_cjs/types/annotation.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"annotation.js","sourceRoot":"","sources":["../../../src/types/annotation.ts"],"names":[],"mappings":""}

package/dist/_esm/types/annotation.d.ts

@@ -1,5 +0,0 @@
-export type Annotation = {
-    key: string;
-    value: string | number;
-};
-//# sourceMappingURL=annotation.d.ts.map

package/dist/_esm/types/annotation.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"annotation.d.ts","sourceRoot":"","sources":["../../../src/types/annotation.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GAAG;IACxB,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;CACtB,CAAA"}

package/dist/_esm/types/annotation.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=annotation.js.map

package/dist/_esm/types/annotation.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"annotation.js","sourceRoot":"","sources":["../../../src/types/annotation.ts"],"names":[],"mappings":""}

package/dist/_types/types/annotation.d.ts

@@ -1,5 +0,0 @@
-export type Annotation = {
-    key: string;
-    value: string | number;
-};
-//# sourceMappingURL=annotation.d.ts.map

package/dist/_types/types/annotation.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"annotation.d.ts","sourceRoot":"","sources":["../../../src/types/annotation.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GAAG;IACxB,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;CACtB,CAAA"}

package/src/types/annotation.ts

@@ -1,4 +0,0 @@
-export type Annotation = {
-	key: string
-	value: string | number
-}