@arkiv-network/sdk 0.4.2 → 0.4.4

package/README.md

@@ -32,9 +32,9 @@ mkdir arkiv-sample
 cd arkiv-sample
 ```
 
-Create an empty `index.ts` file:
+Create an empty `read_example.ts` file:
 ```bash
-touch index.ts
+touch read_example.ts
 ```
 
 Initialize a new JavaScript/TypeScript project:
@@ -59,7 +59,7 @@ After this step, a `package.json` file will be created with content similar to:
 }
 ```
 
-Modify the `"main"` entry to `"index.ts"` and set `"type"` to `"module"` so your `package.json` looks like this:
+Modify the `"main"` entry to `"read_example.ts"` and set `"type"` to `"module"` so your `package.json` looks like this:
 
 ```json
 {
@@ -69,7 +69,7 @@ Modify the `"main"` entry to `"index.ts"` and set `"type"` to `"module"` so your
   "license": "ISC",
   "author": "",
   "type": "module",
-  "main": "index.ts",
+  "main": "read_example.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   }
@@ -83,14 +83,14 @@ npm install @arkiv-network/sdk
 This command will update your `package.json` with a section like:
 ```json
 "dependencies": {
-  "@arkiv-network/sdk": "^0.4.2"
+  "@arkiv-network/sdk": "^0.4.4"
 }
 ```
 It will also create a `node_modules` directory with all dependencies installed.
 
 ### Public Client Example (Query Data)
 
-To query data from Arkiv, use the following sample code in `index.ts`:
+You can now use Arkiv's public client to query data. Paste the following in `read_example.ts`:
 
 ```typescript
 import { createPublicClient, http } from "@arkiv-network/sdk"
@@ -135,12 +135,12 @@ You have several options to run your TypeScript sample:
 
 - **With Node.js (using experimental TypeScript support):**
   ```bash
-  node --experimental-strip-types index.ts
+  node --experimental-strip-types read_example.ts
   ```
 
 - **With Bun (native TypeScript support):**
   ```bash
-  bun index.ts
+  bun read_example.ts
   ```
 
 - **Classic Node.js (using transpilation to JavaScript):**
@@ -158,26 +158,28 @@ You have several options to run your TypeScript sample:
      ```bash
      npx tsc --outDir dist
      ```
-     This creates a `dist` directory containing `index.js` (the transpiled code), along with corresponding type declaration and source map files.
+     This creates a `dist` directory containing `read_example.js` (the transpiled code), along with corresponding type declaration and source map files.
   4. Run the transpiled script:
      ```bash
-     node dist/index.js
+     node dist/read_example.js
      ```
 
 ### Wallet Client Example (Create Entity)
 
-Now, let's add storage functionality.  
-First, import the required modules at the top of your `index.ts`:
+Now let's add storage (write) functionality.  
+Create a file named `write_example.ts` with the following content:
 
 ```typescript
-import { createWalletClient } from '@arkiv-network/sdk';
-import { ExpirationTime, jsonToPayload } from '@arkiv-network/sdk/utils';
-import { privateKeyToAccount } from '@arkiv-network/sdk/accounts';
-```
-
-Then, add the following example below your query code to create an entity:
+import { createPublicClient, createWalletClient, http } from "@arkiv-network/sdk"
+import { privateKeyToAccount } from "@arkiv-network/sdk/accounts"
+import { mendoza } from "@arkiv-network/sdk/chains"
+import { ExpirationTime, jsonToPayload } from "@arkiv-network/sdk/utils"
 
-```typescript
+// Create a public client
+const publicClient = createPublicClient({
+  chain: mendoza, // mendoza is the Arkiv testnet for the purposes of hackathons organized in Buenos Aires during devconnect 2025
+  transport: http(),
+})
 // Create a wallet client with an account
 const client = createWalletClient({
   chain: mendoza,
@@ -209,6 +211,23 @@ const newEntity = await publicClient.getEntity(entityKey);
 console.log('Entity:', newEntity);
 ```
 
+Now you can run it in the same way as in the previous example:
+- **With Node.js (using experimental TypeScript support):**
+  ```bash
+  node --experimental-strip-types write_example.ts
+  ```
+
+- **With Bun (native TypeScript support):**
+  ```bash
+  bun write_example.ts
+  ```
+
+- **Classic Node.js (using transpilation to JavaScript):**
+  ```bash
+  npx tsc --outDir dist
+  node dist/write_example.js
+  ```
+
 **Note:**  
 You must provide your own private key with a minimum balance on the Arkiv L3 network.  
 You can generate a private key using any tool, for example: https://vanity-eth.tk/  
@@ -221,7 +240,7 @@ For quick testing, you may use this example key:
 ```
 However, funds may not always be available for this key.
 
-The full example code can be found in the `sample` directory of this repository.
+Sample code can also be found in the [`sample`](./sample) directory of this repository.
 
 ## Package Distribution
 

package/dist/chains/index.d.cts

@@ -1,4 +1,4 @@
-import * as viem8 from "viem";
+import * as viem0 from "viem";
 
 //#region src/chains/kaolin.d.ts
 declare const kaolin: {
@@ -11,13 +11,13 @@ declare const kaolin: {
   };
   blockTime?: number | undefined | undefined;
   contracts?: {
-    [x: string]: viem8.ChainContract | {
-      [sourceId: number]: viem8.ChainContract | undefined;
+    [x: string]: viem0.ChainContract | {
+      [sourceId: number]: viem0.ChainContract | undefined;
     } | undefined;
-    ensRegistry?: viem8.ChainContract | undefined;
-    ensUniversalResolver?: viem8.ChainContract | undefined;
-    multicall3?: viem8.ChainContract | undefined;
-    erc6492Verifier?: viem8.ChainContract | undefined;
+    ensRegistry?: viem0.ChainContract | undefined;
+    ensUniversalResolver?: viem0.ChainContract | undefined;
+    multicall3?: viem0.ChainContract | undefined;
+    erc6492Verifier?: viem0.ChainContract | undefined;
   } | undefined;
   ensTlds?: readonly string[] | undefined;
   id: 60138453025;
@@ -37,9 +37,9 @@ declare const kaolin: {
   sourceId?: number | undefined | undefined;
   testnet: true;
   custom?: Record<string, unknown> | undefined;
-  fees?: viem8.ChainFees<undefined> | undefined;
+  fees?: viem0.ChainFees<undefined> | undefined;
   formatters?: undefined;
-  serializers?: viem8.ChainSerializers<undefined, viem8.TransactionSerializable> | undefined;
+  serializers?: viem0.ChainSerializers<undefined, viem0.TransactionSerializable> | undefined;
   readonly network: "kaolin";
 };
 //#endregion
@@ -59,13 +59,13 @@ declare const localhost: {
   } | undefined | undefined;
   blockTime?: number | undefined | undefined;
   contracts?: {
-    [x: string]: viem8.ChainContract | {
-      [sourceId: number]: viem8.ChainContract | undefined;
+    [x: string]: viem0.ChainContract | {
+      [sourceId: number]: viem0.ChainContract | undefined;
     } | undefined;
-    ensRegistry?: viem8.ChainContract | undefined;
-    ensUniversalResolver?: viem8.ChainContract | undefined;
-    multicall3?: viem8.ChainContract | undefined;
-    erc6492Verifier?: viem8.ChainContract | undefined;
+    ensRegistry?: viem0.ChainContract | undefined;
+    ensUniversalResolver?: viem0.ChainContract | undefined;
+    multicall3?: viem0.ChainContract | undefined;
+    erc6492Verifier?: viem0.ChainContract | undefined;
   } | undefined;
   ensTlds?: readonly string[] | undefined;
   id: 1337;
@@ -84,9 +84,9 @@ declare const localhost: {
   sourceId?: number | undefined | undefined;
   testnet?: boolean | undefined | undefined;
   custom?: Record<string, unknown> | undefined;
-  fees?: viem8.ChainFees<undefined> | undefined;
+  fees?: viem0.ChainFees<undefined> | undefined;
   formatters?: undefined;
-  serializers?: viem8.ChainSerializers<undefined, viem8.TransactionSerializable> | undefined;
+  serializers?: viem0.ChainSerializers<undefined, viem0.TransactionSerializable> | undefined;
 };
 //#endregion
 //#region src/chains/marketplace.d.ts
@@ -100,13 +100,13 @@ declare const marketplace: {
   };
   blockTime?: number | undefined | undefined;
   contracts?: {
-    [x: string]: viem8.ChainContract | {
-      [sourceId: number]: viem8.ChainContract | undefined;
+    [x: string]: viem0.ChainContract | {
+      [sourceId: number]: viem0.ChainContract | undefined;
     } | undefined;
-    ensRegistry?: viem8.ChainContract | undefined;
-    ensUniversalResolver?: viem8.ChainContract | undefined;
-    multicall3?: viem8.ChainContract | undefined;
-    erc6492Verifier?: viem8.ChainContract | undefined;
+    ensRegistry?: viem0.ChainContract | undefined;
+    ensUniversalResolver?: viem0.ChainContract | undefined;
+    multicall3?: viem0.ChainContract | undefined;
+    erc6492Verifier?: viem0.ChainContract | undefined;
   } | undefined;
   ensTlds?: readonly string[] | undefined;
   id: 60138453027;
@@ -126,9 +126,9 @@ declare const marketplace: {
   sourceId?: number | undefined | undefined;
   testnet: true;
   custom?: Record<string, unknown> | undefined;
-  fees?: viem8.ChainFees<undefined> | undefined;
+  fees?: viem0.ChainFees<undefined> | undefined;
   formatters?: undefined;
-  serializers?: viem8.ChainSerializers<undefined, viem8.TransactionSerializable> | undefined;
+  serializers?: viem0.ChainSerializers<undefined, viem0.TransactionSerializable> | undefined;
   readonly network: "marketplace";
 };
 //#endregion
@@ -143,13 +143,13 @@ declare const mendoza: {
   };
   blockTime?: number | undefined | undefined;
   contracts?: {
-    [x: string]: viem8.ChainContract | {
-      [sourceId: number]: viem8.ChainContract | undefined;
+    [x: string]: viem0.ChainContract | {
+      [sourceId: number]: viem0.ChainContract | undefined;
     } | undefined;
-    ensRegistry?: viem8.ChainContract | undefined;
-    ensUniversalResolver?: viem8.ChainContract | undefined;
-    multicall3?: viem8.ChainContract | undefined;
-    erc6492Verifier?: viem8.ChainContract | undefined;
+    ensRegistry?: viem0.ChainContract | undefined;
+    ensUniversalResolver?: viem0.ChainContract | undefined;
+    multicall3?: viem0.ChainContract | undefined;
+    erc6492Verifier?: viem0.ChainContract | undefined;
   } | undefined;
   ensTlds?: readonly string[] | undefined;
   id: 60138453056;
@@ -169,9 +169,9 @@ declare const mendoza: {
   sourceId?: number | undefined | undefined;
   testnet: true;
   custom?: Record<string, unknown> | undefined;
-  fees?: viem8.ChainFees<undefined> | undefined;
+  fees?: viem0.ChainFees<undefined> | undefined;
   formatters?: undefined;
-  serializers?: viem8.ChainSerializers<undefined, viem8.TransactionSerializable> | undefined;
+  serializers?: viem0.ChainSerializers<undefined, viem0.TransactionSerializable> | undefined;
   readonly network: "mendoza";
 };
 //#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkiv-network/sdk",
-  "version": "0.4.2",
+  "version": "0.4.4",
   "description": "TypeScript client library for Arkiv's blockchains interactions",
   "type": "module",
   "target": "esnext",