@arkiv-network/sdk 0.7.0 → 0.8.0-dev.1

package/README.md

@@ -97,12 +97,12 @@ You can now use Arkiv's public client to query data. Paste the following in `rea
 
 ```typescript
 import { createPublicClient } from "@arkiv-network/sdk"
-import { braga } from "@arkiv-network/sdk/chains"
+import { cheesecake } from "@arkiv-network/sdk/chains"
 import { eq } from "@arkiv-network/sdk/query"
 import { http } from "viem"
 
 const publicClient = createPublicClient({
-  chain: braga, // "braga" is Arkiv's testnet
+  chain: cheesecake, // "cheesecake" is Arkiv's testnet
   transport: http(),
 });
 
@@ -124,10 +124,17 @@ const result = await publicClient
 
 console.log('Found entities:', result.entities);
 
-// Pagination - fetch next page
+// Pagination
 if (result.hasNextPage()) {
-  await result.next();
-  console.log('Next page:', result.entities);
+  const nextPage = await result.next();
+  console.log('Next page:', nextPage.entities);
+}
+
+// Or walk every page at once
+for await (const entity of publicClient
+  .select({ key: true })
+  .where(eq('category', 'documentation'))) {
+  console.log(entity.key);
 }
 ```
 
@@ -150,7 +157,9 @@ The result type is inferred from your selection: reading a field you didn't sele
 helpers are available only when you select `payload`.
 
 ```typescript
-const [entity] = (await publicClient.select({ owner: true, payload: true }).fetch()).entities;
+const [entity] = (
+  await publicClient.select({ owner: true, payload: true }).where(eq("category", "docs")).fetch()
+).entities;
 entity.owner;     // ✅ Hex
 entity.toJson();  // ✅ payload was selected
 entity.creator;   // ❌ compile error — not selected
@@ -206,19 +215,20 @@ Create a file named `write_example.ts` with the following content:
 
 ```typescript
 import { createPublicClient, createWalletClient } from "@arkiv-network/sdk"
-import { braga } from "@arkiv-network/sdk/chains"
+import { dec, i32 } from "@arkiv-network/sdk/attr"
+import { cheesecake } from "@arkiv-network/sdk/chains"
 import { ExpirationTime, jsonToPayload } from "@arkiv-network/sdk/utils"
 import { http } from "viem"
 import { privateKeyToAccount } from "viem/accounts"
 
 // Create a public client
 const publicClient = createPublicClient({
-  chain: braga, // braga is the Arkiv testnet
+  chain: cheesecake, // cheesecake is the Arkiv testnet
   transport: http(),
 })
 // Create a wallet client with an account
 const client = createWalletClient({
-  chain: braga,
+  chain: cheesecake,
   transport: http(),
   account: privateKeyToAccount('0x...'), // Replace with your private key
 });
@@ -233,11 +243,15 @@ const { entityKey, txHash } = await client.createEntity({
     },
   }),
   contentType: 'application/json',
-  attributes: [
-    { key: 'category', value: 'documentation' },
-    { key: 'version', value: '1.0' },
-  ],
-  expiresIn: ExpirationTime.fromDays(30), // Entity expires in 30 days
+  // Attributes are keyed by name. Values carry their type: use the tagged constructors from
+  // "@arkiv-network/sdk/attr" (i32, u64, u256, dec, str, addr, key, bytes32, bool), or pass a bare
+  // boolean, number, bigint or string where the type is unambiguous.
+  attributes: {
+    category: 'documentation',   // bare string -> str
+    version: i32(1),
+    score: dec('4.5'),
+  },
+  expires: ExpirationTime.fromDays(30), // Entity expires in 30 days
 });
 
 console.log('Created entity:', entityKey);
@@ -267,8 +281,7 @@ Now you can run it in the same way as in the previous example:
 **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/  
-Once you have a key, you can paste it into the example above and fund its address using the Arkiv Braga testnet faucet at:  
-https://braga.hoodi.arkiv.network/faucet/
+Once you have a key, you can paste it into the example above and fund its address on the Arkiv Cheesecake testnet.
 
 For quick testing, you may use this example key:
 ```

package/dist/attr/index.cjs

@@ -0,0 +1,34 @@
+const require_attr = require('../attr-BvxHN99W.cjs');
+
+exports.ConflictingMutationError = require_attr.ConflictingMutationError;
+exports.DECIMAL_SCALE = require_attr.DECIMAL_SCALE;
+exports.DECIMAL_UNIT = require_attr.DECIMAL_UNIT;
+exports.I32_MAX = require_attr.I32_MAX;
+exports.I32_MIN = require_attr.I32_MIN;
+exports.InvalidAttributeNameError = require_attr.InvalidAttributeNameError;
+exports.InvalidValueError = require_attr.InvalidValueError;
+exports.MAX_ATTRIBUTES = require_attr.MAX_ATTRIBUTES;
+exports.MAX_NAME_BYTES = require_attr.MAX_NAME_BYTES;
+exports.MAX_PAYLOAD_BYTES = require_attr.MAX_PAYLOAD_BYTES;
+exports.MAX_STRING_BYTES = require_attr.MAX_STRING_BYTES;
+exports.MissingValueError = require_attr.MissingValueError;
+exports.TooManyAttributesError = require_attr.TooManyAttributesError;
+exports.U256_MAX = require_attr.U256_MAX;
+exports.U64_MAX = require_attr.U64_MAX;
+exports.UnknownAttributeTypeError = require_attr.UnknownAttributeTypeError;
+exports.UntypedValueError = require_attr.UntypedValueError;
+exports.addr = require_attr.addr;
+exports.bool = require_attr.bool;
+exports.bytes32 = require_attr.bytes32;
+exports.dec = require_attr.dec;
+exports.decFromUnits = require_attr.decFromUnits;
+exports.decUnits = require_attr.decUnits;
+exports.i32 = require_attr.i32;
+exports.isArkivValue = require_attr.isArkivValue;
+exports.isValidAttributeName = require_attr.isValidAttributeName;
+exports.key = require_attr.key;
+exports.str = require_attr.str;
+exports.toValue = require_attr.toValue;
+exports.u256 = require_attr.u256;
+exports.u64 = require_attr.u64;
+exports.validateAttributeName = require_attr.validateAttributeName;

package/dist/attr/index.d.cts

@@ -0,0 +1,2 @@
+import { A as i32, B as Bytes32Value, C as ValueInput, D as dec, E as bytes32, F as u64, G as StrValue, H as DecValue, I as AddrValue, J as U64Value, K as TypeTag, L as AnyArkivValue, M as str, N as toValue, O as decFromUnits, P as u256, R as ArkivValue, S as U64_MAX, T as bool, U as I32Value, V as BytesValue, W as KeyValue, X as isArkivValue, Y as UserTypeTag, _ as MAX_PAYLOAD_BYTES, a as InvalidAttributeNameError, b as MAX_STRING_BYTES, c as TooManyAttributesError, d as DECIMAL_SCALE, f as DECIMAL_UNIT, g as MAX_ATTRIBUTES, h as Attributes, i as ConflictingMutationError, j as key, k as decUnits, l as UnknownAttributeTypeError, m as AttributeSchema, n as isValidAttributeName, o as InvalidValueError, p as AttributeInputs, q as U256Value, r as validateAttributeName, s as MissingValueError, t as MAX_NAME_BYTES, u as UntypedValueError, v as I32_MAX, w as addr, x as U256_MAX, y as I32_MIN, z as BoolValue } from "../index-D8LZt-3J.cjs";
+export { AddrValue, AnyArkivValue, ArkivValue, AttributeInputs, AttributeSchema, Attributes, BoolValue, Bytes32Value, BytesValue, ConflictingMutationError, DECIMAL_SCALE, DECIMAL_UNIT, DecValue, I32Value, I32_MAX, I32_MIN, InvalidAttributeNameError, InvalidValueError, KeyValue, MAX_ATTRIBUTES, MAX_NAME_BYTES, MAX_PAYLOAD_BYTES, MAX_STRING_BYTES, MissingValueError, StrValue, TooManyAttributesError, TypeTag, U256Value, U256_MAX, U64Value, U64_MAX, UnknownAttributeTypeError, UntypedValueError, UserTypeTag, ValueInput, addr, bool, bytes32, dec, decFromUnits, decUnits, i32, isArkivValue, isValidAttributeName, key, str, toValue, u256, u64, validateAttributeName };

package/dist/attr/index.d.ts

@@ -0,0 +1,2 @@
+import { A as i32, B as Bytes32Value, C as ValueInput, D as dec, E as bytes32, F as u64, G as StrValue, H as DecValue, I as AddrValue, J as U64Value, K as TypeTag, L as AnyArkivValue, M as str, N as toValue, O as decFromUnits, P as u256, R as ArkivValue, S as U64_MAX, T as bool, U as I32Value, V as BytesValue, W as KeyValue, X as isArkivValue, Y as UserTypeTag, _ as MAX_PAYLOAD_BYTES, a as InvalidAttributeNameError, b as MAX_STRING_BYTES, c as TooManyAttributesError, d as DECIMAL_SCALE, f as DECIMAL_UNIT, g as MAX_ATTRIBUTES, h as Attributes, i as ConflictingMutationError, j as key, k as decUnits, l as UnknownAttributeTypeError, m as AttributeSchema, n as isValidAttributeName, o as InvalidValueError, p as AttributeInputs, q as U256Value, r as validateAttributeName, s as MissingValueError, t as MAX_NAME_BYTES, u as UntypedValueError, v as I32_MAX, w as addr, x as U256_MAX, y as I32_MIN, z as BoolValue } from "../index-DVYFaXNV.js";
+export { AddrValue, AnyArkivValue, ArkivValue, AttributeInputs, AttributeSchema, Attributes, BoolValue, Bytes32Value, BytesValue, ConflictingMutationError, DECIMAL_SCALE, DECIMAL_UNIT, DecValue, I32Value, I32_MAX, I32_MIN, InvalidAttributeNameError, InvalidValueError, KeyValue, MAX_ATTRIBUTES, MAX_NAME_BYTES, MAX_PAYLOAD_BYTES, MAX_STRING_BYTES, MissingValueError, StrValue, TooManyAttributesError, TypeTag, U256Value, U256_MAX, U64Value, U64_MAX, UnknownAttributeTypeError, UntypedValueError, UserTypeTag, ValueInput, addr, bool, bytes32, dec, decFromUnits, decUnits, i32, isArkivValue, isValidAttributeName, key, str, toValue, u256, u64, validateAttributeName };

package/dist/attr/index.js

@@ -0,0 +1,3 @@
+import { A as DECIMAL_UNIT, C as str, E as u64, F as TooManyAttributesError, I as UnknownAttributeTypeError, L as UntypedValueError, M as InvalidAttributeNameError, N as InvalidValueError, O as isArkivValue, P as MissingValueError, S as key, T as u256, _ as bytes32, a as MAX_NAME_BYTES, b as decUnits, d as I32_MIN, f as MAX_STRING_BYTES, g as bool, h as addr, j as ConflictingMutationError, k as DECIMAL_SCALE, m as U64_MAX, n as MAX_PAYLOAD_BYTES, o as isValidAttributeName, p as U256_MAX, s as validateAttributeName, t as MAX_ATTRIBUTES, u as I32_MAX, v as dec, w as toValue, x as i32, y as decFromUnits } from "../attr-BDZ-APg5.js";
+
+export { ConflictingMutationError, DECIMAL_SCALE, DECIMAL_UNIT, I32_MAX, I32_MIN, InvalidAttributeNameError, InvalidValueError, MAX_ATTRIBUTES, MAX_NAME_BYTES, MAX_PAYLOAD_BYTES, MAX_STRING_BYTES, MissingValueError, TooManyAttributesError, U256_MAX, U64_MAX, UnknownAttributeTypeError, UntypedValueError, addr, bool, bytes32, dec, decFromUnits, decUnits, i32, isArkivValue, isValidAttributeName, key, str, toValue, u256, u64, validateAttributeName };