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

package/src/actions/wallet/deleteEntity.ts

@@ -8,7 +8,7 @@ import { opsToTxData, sendArkivTransaction } from "../../utils/arkivTransactions
  * - entityKey: The key of the entity to delete.
  */
 export type DeleteEntityParameters = {
-	entityKey: Hex
+  entityKey: Hex
 }
 
 /**
@@ -17,23 +17,23 @@ export type DeleteEntityParameters = {
  * - txHash: The transaction hash.
  */
 export type DeleteEntityReturnType = {
-	entityKey: Hex
-	txHash: string
+  entityKey: Hex
+  txHash: string
 }
 
 export async function deleteEntity(
-	client: ArkivClient,
-	data: DeleteEntityParameters,
-	txParams?: TxParams,
+  client: ArkivClient,
+  data: DeleteEntityParameters,
+  txParams?: TxParams,
 ): Promise<DeleteEntityReturnType> {
-	console.debug("deleteEntity", data)
-	const txData = opsToTxData({ deletes: [data] })
-	const receipt = await sendArkivTransaction(client, txData, txParams)
+  console.debug("deleteEntity", data)
+  const txData = opsToTxData({ deletes: [data] })
+  const receipt = await sendArkivTransaction(client, txData, txParams)
 
-	console.debug("Receipt from deleteEntity", receipt)
+  console.debug("Receipt from deleteEntity", receipt)
 
-	return {
-		txHash: receipt.transactionHash,
-		entityKey: data.entityKey,
-	}
+  return {
+    txHash: receipt.transactionHash,
+    entityKey: data.entityKey,
+  }
 }

package/src/actions/wallet/extendEntity.ts

@@ -9,8 +9,8 @@ import { opsToTxData, sendArkivTransaction } from "../../utils/arkivTransactions
  * - expiresIn: The expires in of the entity in seconds.
  */
 export type ExtendEntityParameters = {
-	entityKey: Hex
-	expiresIn: number
+  entityKey: Hex
+  expiresIn: number
 }
 
 /**
@@ -19,23 +19,23 @@ export type ExtendEntityParameters = {
  * - txHash: The transaction hash.
  */
 export type ExtendEntityReturnType = {
-	entityKey: Hex
-	txHash: string
+  entityKey: Hex
+  txHash: string
 }
 
 export async function extendEntity(
-	client: ArkivClient,
-	data: ExtendEntityParameters,
-	txParams?: TxParams,
+  client: ArkivClient,
+  data: ExtendEntityParameters,
+  txParams?: TxParams,
 ): Promise<ExtendEntityReturnType> {
-	console.debug("extendEntity", data)
-	const txData = opsToTxData({ extensions: [data] })
-	const receipt = await sendArkivTransaction(client, txData, txParams)
+  console.debug("extendEntity", data)
+  const txData = opsToTxData({ extensions: [data] })
+  const receipt = await sendArkivTransaction(client, txData, txParams)
 
-	console.debug("Receipt from extendEntity", receipt)
+  console.debug("Receipt from extendEntity", 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,
+  }
 }

package/src/actions/wallet/mutateEntities.ts

@@ -15,40 +15,40 @@ import type { UpdateEntityParameters } from "./updateEntity"
  * - extensions: The extensions to perform.
  */
 export type MutateEntitiesParameters = {
-	creates?: CreateEntityParameters[]
-	updates?: UpdateEntityParameters[]
-	deletes?: DeleteEntityParameters[]
-	extensions?: ExtendEntityParameters[]
+  creates?: CreateEntityParameters[]
+  updates?: UpdateEntityParameters[]
+  deletes?: DeleteEntityParameters[]
+  extensions?: ExtendEntityParameters[]
 }
 
 function parseReceipt(receipt: TransactionReceipt, params: MutateEntitiesParameters) {
-	const createdEntities: Hex[] = []
-	const updatedEntities: Hex[] = []
-	const deletedEntities: Hex[] = []
-	const extendedEntities: Hex[] = []
-	const totalCreates = params.creates?.length ?? 0
-	const totalUpdates = params.updates?.length ?? 0
-	const totalDeletes = params.deletes?.length ?? 0
+  const createdEntities: Hex[] = []
+  const updatedEntities: Hex[] = []
+  const deletedEntities: Hex[] = []
+  const extendedEntities: Hex[] = []
+  const totalCreates = params.creates?.length ?? 0
+  const totalUpdates = params.updates?.length ?? 0
+  const totalDeletes = params.deletes?.length ?? 0
 
-	// iterate over all logs and parse the event
-	// each odd log is the interested ones, logs goes in order like: creates, deleted, updates, extends
-	for (let i = 0; i < receipt.logs.length; i++) {
-		const log = receipt.logs[i]
-		if (i % 2 === 1) continue
+  // iterate over all logs and parse the event
+  // each odd log is the interested ones, logs goes in order like: creates, deleted, updates, extends
+  for (let i = 0; i < receipt.logs.length; i++) {
+    const log = receipt.logs[i]
+    if (i % 2 === 1) continue
 
-		const index = i / 2
-		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 {
-			extendedEntities.push(log.topics[1] as Hex)
-		}
-	}
+    const index = i / 2
+    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 {
+      extendedEntities.push(log.topics[1] as Hex)
+    }
+  }
 
-	return { createdEntities, updatedEntities, deletedEntities, extendedEntities }
+  return { createdEntities, updatedEntities, deletedEntities, extendedEntities }
 }
 
 /**
@@ -60,41 +60,41 @@ function parseReceipt(receipt: TransactionReceipt, params: MutateEntitiesParamet
  * - extendedEntities: The keys of the extended entities.
  */
 export type MutateEntitiesReturnType = {
-	txHash: string
-	createdEntities: Hex[]
-	updatedEntities: Hex[]
-	deletedEntities: Hex[]
-	extendedEntities: Hex[]
+  txHash: string
+  createdEntities: Hex[]
+  updatedEntities: Hex[]
+  deletedEntities: Hex[]
+  extendedEntities: Hex[]
 }
 export async function mutateEntities(
-	client: ArkivClient,
-	data: MutateEntitiesParameters,
-	txParams?: TxParams,
+  client: ArkivClient,
+  data: MutateEntitiesParameters,
+  txParams?: TxParams,
 ): Promise<MutateEntitiesReturnType> {
-	if (!data.creates && !data.updates && !data.deletes && !data.extensions) {
-		throw new Error("No operations to perform")
-	}
+  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 ?? [],
-	})
+  const txData = opsToTxData({
+    creates: data.creates ?? [],
+    updates: data.updates ?? [],
+    deletes: data.deletes ?? [],
+    extensions: data.extensions ?? [],
+  })
 
-	const receipt = await sendArkivTransaction(client, txData, txParams)
+  const receipt = await sendArkivTransaction(client, txData, txParams)
 
-	console.debug("Receipt from mutateEntities", receipt)
+  console.debug("Receipt from mutateEntities", receipt)
 
-	const { createdEntities, updatedEntities, deletedEntities, extendedEntities } = parseReceipt(
-		receipt,
-		data,
-	)
-	return {
-		txHash: receipt.transactionHash,
-		createdEntities,
-		updatedEntities,
-		deletedEntities,
-		extendedEntities,
-	}
+  const { createdEntities, updatedEntities, deletedEntities, extendedEntities } = parseReceipt(
+    receipt,
+    data,
+  )
+  return {
+    txHash: receipt.transactionHash,
+    createdEntities,
+    updatedEntities,
+    deletedEntities,
+    extendedEntities,
+  }
 }

package/src/actions/wallet/updateEntity.ts

@@ -1,20 +1,22 @@
 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 updateEntity function.
  * - entityKey: The key of the entity to update.
  * - 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 UpdateEntityParameters = {
-	entityKey: Hex
-	payload: Uint8Array | string
-	annotations: Annotation[]
-	expiresIn: number
+  entityKey: Hex
+  payload: Uint8Array
+  attributes: Attribute[]
+  contentType: MimeType
+  expiresIn: number
 }
 
 /**
@@ -23,23 +25,23 @@ export type UpdateEntityParameters = {
  * - txHash: The transaction hash.
  */
 export type UpdateEntityReturnType = {
-	entityKey: Hex
-	txHash: string
+  entityKey: Hex
+  txHash: string
 }
 
 export async function updateEntity(
-	client: ArkivClient,
-	data: UpdateEntityParameters,
-	txParams?: TxParams,
+  client: ArkivClient,
+  data: UpdateEntityParameters,
+  txParams?: TxParams,
 ): Promise<UpdateEntityReturnType> {
-	console.debug("updateEntity", data)
-	const txData = opsToTxData({ updates: [data] })
-	const receipt = await sendArkivTransaction(client, txData, txParams)
+  console.debug("updateEntity", data)
+  const txData = opsToTxData({ updates: [data] })
+  const receipt = await sendArkivTransaction(client, txData, txParams)
 
-	console.debug("Receipt from updateEntity", receipt)
+  console.debug("Receipt from updateEntity", 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,
+  }
 }

package/src/chains/kaolin.ts

@@ -1,26 +1,26 @@
 import { defineChain } from "viem"
 
 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,
+  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,
 })

package/src/chains/localhost.ts

@@ -1,14 +1,14 @@
 import { defineChain } from "viem"
 
 export const localhost = defineChain({
-	id: 1337,
-	name: "Localhost",
-	nativeCurrency: {
-		decimals: 18,
-		name: "Ether",
-		symbol: "ETH",
-	},
-	rpcUrls: {
-		default: { http: ["http://127.0.0.1:8545"] },
-	},
+  id: 1337,
+  name: "Localhost",
+  nativeCurrency: {
+    decimals: 18,
+    name: "Ether",
+    symbol: "ETH",
+  },
+  rpcUrls: {
+    default: { http: ["http://127.0.0.1:8545"] },
+  },
 })

package/src/chains/marketplace.ts

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

package/src/clients/baseClient.ts

@@ -2,8 +2,8 @@ import type { Account, Chain, Client, RpcSchema, Transport } from "viem"
 import type { ArkivRpcSchema } from "../types/rpcSchema"
 
 export type ArkivClient<
-	transport extends Transport = Transport,
-	chain extends Chain | undefined = Chain | undefined,
-	accountOrAddress extends Account | undefined = Account | undefined,
-	rpcSchema extends RpcSchema | undefined = ArkivRpcSchema,
+  transport extends Transport = Transport,
+  chain extends Chain | undefined = Chain | undefined,
+  accountOrAddress extends Account | undefined = Account | undefined,
+  rpcSchema extends RpcSchema | undefined = ArkivRpcSchema,
 > = Client<transport, chain, accountOrAddress, rpcSchema>

package/src/clients/createPublicClient.ts

@@ -1,25 +1,25 @@
 import type {
-	Account,
-	Address,
-	Chain,
-	Client,
-	ParseAccount,
-	Prettify,
-	PublicClientConfig,
-	RpcSchema,
-	Transport,
+  Account,
+  Address,
+  Chain,
+  Client,
+  ParseAccount,
+  Prettify,
+  PublicClientConfig,
+  RpcSchema,
+  Transport,
 } from "viem"
 import { createClient, publicActions } from "viem"
 import type { ArkivRpcSchema } from "../types/rpcSchema"
 import { type PublicArkivActions, publicArkivActions } from "./decorators/arkivPublic"
 
 export type PublicArkivClient<
-	transport extends Transport = Transport,
-	chain extends Chain | undefined = Chain | undefined,
-	accountOrAddress extends Account | undefined = undefined,
-	rpcSchema extends RpcSchema | undefined = ArkivRpcSchema,
+  transport extends Transport = Transport,
+  chain extends Chain | undefined = Chain | undefined,
+  accountOrAddress extends Account | undefined = undefined,
+  rpcSchema extends RpcSchema | undefined = ArkivRpcSchema,
 > = Prettify<
-	Client<transport, chain, accountOrAddress, rpcSchema, PublicArkivActions<transport, chain>>
+  Client<transport, chain, accountOrAddress, rpcSchema, PublicArkivActions<transport, chain>>
 >
 
 /**
@@ -42,24 +42,24 @@ export type PublicArkivClient<
  * })
  */
 export function createPublicClient<
-	transport extends Transport,
-	chain extends Chain | undefined = undefined,
-	accountOrAddress extends Account | Address | undefined = undefined,
-	rpcSchema extends RpcSchema | undefined = ArkivRpcSchema,
+  transport extends Transport,
+  chain extends Chain | undefined = undefined,
+  accountOrAddress extends Account | Address | undefined = undefined,
+  rpcSchema extends RpcSchema | undefined = ArkivRpcSchema,
 >(
-	parameters: PublicClientConfig<transport, chain, accountOrAddress, rpcSchema>,
+  parameters: PublicClientConfig<transport, chain, accountOrAddress, rpcSchema>,
 ): PublicArkivClient<transport, chain, ParseAccount<accountOrAddress>, rpcSchema> {
-	const { key = "public", name = "Public Client" } = parameters
-	const client = createClient({
-		...parameters,
-		key,
-		name,
-	})
+  const { key = "public", name = "Public Client" } = parameters
+  const client = createClient({
+    ...parameters,
+    key,
+    name,
+  })
 
-	return client.extend(publicArkivActions).extend(publicActions) as unknown as PublicArkivClient<
-		transport,
-		chain,
-		ParseAccount<accountOrAddress>,
-		rpcSchema
-	>
+  return client.extend(publicArkivActions).extend(publicActions) as unknown as PublicArkivClient<
+    transport,
+    chain,
+    ParseAccount<accountOrAddress>,
+    rpcSchema
+  >
 }

package/src/clients/createWalletClient.ts

@@ -1,13 +1,13 @@
 import type {
-	Account,
-	Address,
-	Chain,
-	Client,
-	ParseAccount,
-	Prettify,
-	RpcSchema,
-	Transport,
-	WalletClientConfig,
+  Account,
+  Address,
+  Chain,
+  Client,
+  ParseAccount,
+  Prettify,
+  RpcSchema,
+  Transport,
+  WalletClientConfig,
 } from "viem"
 import { createClient, publicActions, walletActions } from "viem"
 import type { ArkivRpcSchema } from "../types/rpcSchema"
@@ -15,12 +15,12 @@ import { publicArkivActions } from "./decorators/arkivPublic"
 import { type WalletArkivActions, walletArkivActions } from "./decorators/arkivWallet"
 
 export type WalletArkivClient<
-	transport extends Transport = Transport,
-	chain extends Chain | undefined = Chain | undefined,
-	account extends Account | undefined = Account | undefined,
-	rpcSchema extends RpcSchema | undefined = ArkivRpcSchema,
+  transport extends Transport = Transport,
+  chain extends Chain | undefined = Chain | undefined,
+  account extends Account | undefined = Account | undefined,
+  rpcSchema extends RpcSchema | undefined = ArkivRpcSchema,
 > = Prettify<
-	Client<transport, chain, account, rpcSchema, WalletArkivActions<transport, chain, account>>
+  Client<transport, chain, account, rpcSchema, WalletArkivActions<transport, chain, account>>
 >
 
 /**
@@ -43,28 +43,28 @@ export type WalletArkivClient<
  * })
  */
 export function createWalletClient<
-	transport extends Transport,
-	chain extends Chain | undefined = undefined,
-	accountOrAddress extends Account | Address | undefined = undefined,
-	rpcSchema extends RpcSchema | undefined = ArkivRpcSchema,
+  transport extends Transport,
+  chain extends Chain | undefined = undefined,
+  accountOrAddress extends Account | Address | undefined = undefined,
+  rpcSchema extends RpcSchema | undefined = ArkivRpcSchema,
 >(
-	parameters: WalletClientConfig<transport, chain, accountOrAddress, rpcSchema>,
+  parameters: WalletClientConfig<transport, chain, accountOrAddress, rpcSchema>,
 ): WalletArkivClient<transport, chain, ParseAccount<accountOrAddress>, rpcSchema> {
-	const { key = "wallet", name = "Wallet Client" } = parameters
-	const client = createClient({
-		...parameters,
-		key,
-		name,
-	})
+  const { key = "wallet", name = "Wallet Client" } = parameters
+  const client = createClient({
+    ...parameters,
+    key,
+    name,
+  })
 
-	return client
-		.extend(walletActions)
-		.extend(publicActions)
-		.extend(walletArkivActions)
-		.extend(publicArkivActions) as unknown as WalletArkivClient<
-		transport,
-		chain,
-		ParseAccount<accountOrAddress>,
-		rpcSchema
-	>
+  return client
+    .extend(walletActions)
+    .extend(publicActions)
+    .extend(walletArkivActions)
+    .extend(publicArkivActions) as unknown as WalletArkivClient<
+    transport,
+    chain,
+    ParseAccount<accountOrAddress>,
+    rpcSchema
+  >
 }