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

package/dist/index-ClgIuxJ8.d.ts

@@ -0,0 +1,159 @@
+import { Address, Hex } from "viem";
+
+//#region src/entity/errors.d.ts
+/** An expiry could not be expressed, or would be rejected by the engine. */
+declare class InvalidExpiryError extends Error {
+  constructor(reason: string);
+}
+/** A `creationFlags` byte could not be built or read. */
+declare class InvalidCreationFlagsError extends Error {
+  constructor(reason: string);
+}
+/** A key salt was outside the `uint128` the wire carries. */
+declare class InvalidSaltError extends Error {
+  constructor(salt: bigint);
+}
+/** No cryptographic randomness was available to generate a salt. */
+declare class NoRandomSourceError extends Error {
+  constructor();
+}
+//#endregion
+//#region src/entity/events.d.ts
+/**
+ * The events the engine emits: one per applied operation, in application order, so an off-chain
+ * replica can replay a transaction operation by operation.
+ */
+declare const ENTITY_EVENTS_ABI: readonly [{
+  readonly name: "EntityCreated";
+  readonly type: "event";
+  readonly inputs: readonly [{
+    readonly type: "bytes32";
+    readonly name: "entityKey";
+    readonly indexed: true;
+  }, {
+    readonly type: "address";
+    readonly name: "owner";
+    readonly indexed: true;
+  }, {
+    readonly type: "uint64";
+    readonly name: "expiresAt";
+  }, {
+    readonly type: "uint8";
+    readonly name: "creationFlags";
+  }];
+}, {
+  readonly name: "EntityPatched";
+  readonly type: "event";
+  readonly inputs: readonly [{
+    readonly type: "bytes32";
+    readonly name: "entityKey";
+    readonly indexed: true;
+  }, {
+    readonly type: "address";
+    readonly name: "owner";
+    readonly indexed: true;
+  }];
+}, {
+  readonly name: "ExpiryExtended";
+  readonly type: "event";
+  readonly inputs: readonly [{
+    readonly type: "bytes32";
+    readonly name: "entityKey";
+    readonly indexed: true;
+  }, {
+    readonly type: "address";
+    readonly name: "owner";
+    readonly indexed: true;
+  }, {
+    readonly type: "uint64";
+    readonly name: "expiresAt";
+  }];
+}, {
+  readonly name: "OwnershipTransferred";
+  readonly type: "event";
+  readonly inputs: readonly [{
+    readonly type: "bytes32";
+    readonly name: "entityKey";
+    readonly indexed: true;
+  }, {
+    readonly type: "address";
+    readonly name: "previousOwner";
+    readonly indexed: true;
+  }, {
+    readonly type: "address";
+    readonly name: "newOwner";
+    readonly indexed: true;
+  }];
+}, {
+  readonly name: "EntityDeleted";
+  readonly type: "event";
+  readonly inputs: readonly [{
+    readonly type: "bytes32";
+    readonly name: "entityKey";
+    readonly indexed: true;
+  }, {
+    readonly type: "address";
+    readonly name: "owner";
+    readonly indexed: true;
+  }];
+}];
+/** The name of each event in {@link ENTITY_EVENTS_ABI}. */
+type EntityEventName = (typeof ENTITY_EVENTS_ABI)[number]["name"];
+//#endregion
+//#region src/entity/key.d.ts
+/** The widest salt the `uint128` wire field carries. */
+declare const MAX_SALT: bigint;
+/**
+ * A cryptographically random 128-bit salt — what {@link CreateEntityParameters.salt} defaults to.
+ *
+ * The salt exists for unpredictability, not uniqueness: the per-owner nonce already guarantees
+ * distinct keys. Random bits mean only the creator can predict the key of an entity they are about
+ * to create, so nobody else can reference or squat it in advance.
+ *
+ * @throws {NoRandomSourceError} If the runtime has no `crypto.getRandomValues`.
+ */
+declare function randomSalt(): bigint;
+/**
+ * The key an entity will be created with, derived exactly as the engine derives it:
+ * `keccak256(domain ++ owner ++ nonce ++ salt)`.
+ *
+ * Deriving it client-side is what lets a batch compose: predict the key of a create, then have a
+ * later operation in the same transaction reference it, or store it as a `key` attribute on a
+ * sibling entity.
+ */
+declare function predictEntityKey({
+  owner,
+  nonce,
+  salt,
+  chainId
+}: {
+  /** The account creating the entity. */
+  owner: Address;
+  /**
+   * The owner's entity-nonce at creation time. Each create in a batch consumes one, so the *n*th
+   * create in a batch uses `nonce + n`.
+   */
+  nonce: bigint;
+  /** The salt the create will carry. */
+  salt: bigint;
+  /** The chain the entity is being created on — half of the derivation domain. */
+  chainId: number;
+}): Hex;
+//#endregion
+//#region src/entity/params.d.ts
+/**
+ * Max uint64 value
+ */
+declare const MAX_EXPIRES_AT: bigint;
+/** The operation tags of the `execute` ABI's tagged union. */
+declare const OperationType: {
+  readonly Create: 1;
+  readonly Patch: 2;
+  readonly ExtendExpiry: 3;
+  readonly TransferOwnership: 4;
+  readonly Delete: 5;
+};
+type OperationType = (typeof OperationType)[keyof typeof OperationType];
+//#endregion
+export { randomSalt as a, InvalidCreationFlagsError as c, NoRandomSourceError as d, predictEntityKey as i, InvalidExpiryError as l, OperationType as n, ENTITY_EVENTS_ABI as o, MAX_SALT as r, EntityEventName as s, MAX_EXPIRES_AT as t, InvalidSaltError as u };
+//# sourceMappingURL=index-ClgIuxJ8.d.ts.map

package/dist/index-ClgIuxJ8.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-ClgIuxJ8.d.ts","names":[],"sources":["../src/entity/errors.ts","../src/entity/events.ts","../src/entity/key.ts","../src/entity/params.ts"],"sourcesContent":[],"mappings":";;;;cACa,kBAAA,SAA2B,KAAA;;AAAxC;AAQA;AAQa,cARA,yBAAA,SAAkC,KAAA,CAQJ;EAW9B,WAAA,CAAA,MAAA,EAAA,MAAoB;;;cAXpB,gBAAA,SAAyB,KAAA;ECXzB,WAAA,CAAA,IAAA,EAAA,MAMX;AAGF;;cDaa,mBAAA,SAA4B,KAAA;;AEvBzC;;;;;;AFJA;AAQa,cCHA,iBDG0B,EAAA,SAAa,CAAA;EAQvC,SAAA,IAAA,EAAA,eAAyB;EAWzB,SAAA,IAAA,EAAA,OAAoB;;;;ICtBpB,SAAA,OAMX,EAAA,IAAA;EAGU,CAAA,EAAA;;;;ECVC,CAAA,EAAA;IAWG,SAAU,IAAA,EAAA,QAAA;IA2BV,SAAA,IAAA,EAAgB,WAAA;EAC9B,CAAA,EAAA;IACA,SAAA,IAAA,EAAA,OAAA;IACA,SAAA,IAAA,EAAA,eAAA;EACA,CAAA,CAAA;CAGO,EAAA;EAUL,SAAA,IAAA,EAAA,eAAA;EAAG,SAAA,IAAA,EAAA,OAAA;;;;ICzDM,SAAA,OAA+B,EAAA,IAAA;EAG/B,CAAA,EAAA;IAQD,SAAA,IAAa,EAAA,SAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KFCxB,eAAA,WAA0B;;;;cCVzB;AFJb;AAQA;AAQA;AAWA;;;;ACtBA;AASA;iBCCgB,UAAA,CAAA;AAXhB;AAWA;AA2BA;;;;;;AAiBI,iBAjBY,gBAAA,CAiBZ;EAAA,KAAA;EAAA,KAAA;EAAA,IAAA;EAAA;CAAA,EAAA;EAAG;SAVE;;;AC/CT;AAGA;EAQY,KAAA,EAAA,MAAA;;;;;ID8CR;;;;;;AF3DS,cGEA,cHFmB,EAAQ,MAAK;AAQ7C;AAQa,cGXA,aHWyB,EAAA;EAWzB,SAAA,MAAA,EAAA,CAAA;;;;ECtBA,SAAA,MAAA,EAAA,CAAA;AASb,CAAA;KEDY,aAAA,WAAwB,4BAA4B"}

package/dist/index-D0CmtiWT.d.cts

@@ -0,0 +1,159 @@
+import { Address, Hex } from "viem";
+
+//#region src/entity/errors.d.ts
+/** An expiry could not be expressed, or would be rejected by the engine. */
+declare class InvalidExpiryError extends Error {
+  constructor(reason: string);
+}
+/** A `creationFlags` byte could not be built or read. */
+declare class InvalidCreationFlagsError extends Error {
+  constructor(reason: string);
+}
+/** A key salt was outside the `uint128` the wire carries. */
+declare class InvalidSaltError extends Error {
+  constructor(salt: bigint);
+}
+/** No cryptographic randomness was available to generate a salt. */
+declare class NoRandomSourceError extends Error {
+  constructor();
+}
+//#endregion
+//#region src/entity/events.d.ts
+/**
+ * The events the engine emits: one per applied operation, in application order, so an off-chain
+ * replica can replay a transaction operation by operation.
+ */
+declare const ENTITY_EVENTS_ABI: readonly [{
+  readonly name: "EntityCreated";
+  readonly type: "event";
+  readonly inputs: readonly [{
+    readonly type: "bytes32";
+    readonly name: "entityKey";
+    readonly indexed: true;
+  }, {
+    readonly type: "address";
+    readonly name: "owner";
+    readonly indexed: true;
+  }, {
+    readonly type: "uint64";
+    readonly name: "expiresAt";
+  }, {
+    readonly type: "uint8";
+    readonly name: "creationFlags";
+  }];
+}, {
+  readonly name: "EntityPatched";
+  readonly type: "event";
+  readonly inputs: readonly [{
+    readonly type: "bytes32";
+    readonly name: "entityKey";
+    readonly indexed: true;
+  }, {
+    readonly type: "address";
+    readonly name: "owner";
+    readonly indexed: true;
+  }];
+}, {
+  readonly name: "ExpiryExtended";
+  readonly type: "event";
+  readonly inputs: readonly [{
+    readonly type: "bytes32";
+    readonly name: "entityKey";
+    readonly indexed: true;
+  }, {
+    readonly type: "address";
+    readonly name: "owner";
+    readonly indexed: true;
+  }, {
+    readonly type: "uint64";
+    readonly name: "expiresAt";
+  }];
+}, {
+  readonly name: "OwnershipTransferred";
+  readonly type: "event";
+  readonly inputs: readonly [{
+    readonly type: "bytes32";
+    readonly name: "entityKey";
+    readonly indexed: true;
+  }, {
+    readonly type: "address";
+    readonly name: "previousOwner";
+    readonly indexed: true;
+  }, {
+    readonly type: "address";
+    readonly name: "newOwner";
+    readonly indexed: true;
+  }];
+}, {
+  readonly name: "EntityDeleted";
+  readonly type: "event";
+  readonly inputs: readonly [{
+    readonly type: "bytes32";
+    readonly name: "entityKey";
+    readonly indexed: true;
+  }, {
+    readonly type: "address";
+    readonly name: "owner";
+    readonly indexed: true;
+  }];
+}];
+/** The name of each event in {@link ENTITY_EVENTS_ABI}. */
+type EntityEventName = (typeof ENTITY_EVENTS_ABI)[number]["name"];
+//#endregion
+//#region src/entity/key.d.ts
+/** The widest salt the `uint128` wire field carries. */
+declare const MAX_SALT: bigint;
+/**
+ * A cryptographically random 128-bit salt — what {@link CreateEntityParameters.salt} defaults to.
+ *
+ * The salt exists for unpredictability, not uniqueness: the per-owner nonce already guarantees
+ * distinct keys. Random bits mean only the creator can predict the key of an entity they are about
+ * to create, so nobody else can reference or squat it in advance.
+ *
+ * @throws {NoRandomSourceError} If the runtime has no `crypto.getRandomValues`.
+ */
+declare function randomSalt(): bigint;
+/**
+ * The key an entity will be created with, derived exactly as the engine derives it:
+ * `keccak256(domain ++ owner ++ nonce ++ salt)`.
+ *
+ * Deriving it client-side is what lets a batch compose: predict the key of a create, then have a
+ * later operation in the same transaction reference it, or store it as a `key` attribute on a
+ * sibling entity.
+ */
+declare function predictEntityKey({
+  owner,
+  nonce,
+  salt,
+  chainId
+}: {
+  /** The account creating the entity. */
+  owner: Address;
+  /**
+   * The owner's entity-nonce at creation time. Each create in a batch consumes one, so the *n*th
+   * create in a batch uses `nonce + n`.
+   */
+  nonce: bigint;
+  /** The salt the create will carry. */
+  salt: bigint;
+  /** The chain the entity is being created on — half of the derivation domain. */
+  chainId: number;
+}): Hex;
+//#endregion
+//#region src/entity/params.d.ts
+/**
+ * Max uint64 value
+ */
+declare const MAX_EXPIRES_AT: bigint;
+/** The operation tags of the `execute` ABI's tagged union. */
+declare const OperationType: {
+  readonly Create: 1;
+  readonly Patch: 2;
+  readonly ExtendExpiry: 3;
+  readonly TransferOwnership: 4;
+  readonly Delete: 5;
+};
+type OperationType = (typeof OperationType)[keyof typeof OperationType];
+//#endregion
+export { randomSalt as a, InvalidCreationFlagsError as c, NoRandomSourceError as d, predictEntityKey as i, InvalidExpiryError as l, OperationType as n, ENTITY_EVENTS_ABI as o, MAX_SALT as r, EntityEventName as s, MAX_EXPIRES_AT as t, InvalidSaltError as u };
+//# sourceMappingURL=index-D0CmtiWT.d.cts.map

package/dist/index-D0CmtiWT.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-D0CmtiWT.d.cts","names":[],"sources":["../src/entity/errors.ts","../src/entity/events.ts","../src/entity/key.ts","../src/entity/params.ts"],"sourcesContent":[],"mappings":";;;;cACa,kBAAA,SAA2B,KAAA;;AAAxC;AAQA;AAQa,cARA,yBAAA,SAAkC,KAAA,CAQJ;EAW9B,WAAA,CAAA,MAAA,EAAA,MAAoB;;;cAXpB,gBAAA,SAAyB,KAAA;ECXzB,WAAA,CAAA,IAAA,EAAA,MAMX;AAGF;;cDaa,mBAAA,SAA4B,KAAA;;AEvBzC;;;;;;AFJA;AAQa,cCHA,iBDG0B,EAAA,SAAQ,CAAA;EAQlC,SAAA,IAAA,EAAA,eAAiB;EAWjB,SAAA,IAAA,EAAA,OAAoB;;;;ICtBpB,SAAA,OAMX,EAAA,IAAA;EAGU,CAAA,EAAA;;;;ECVC,CAAA,EAAA;IAWG,SAAU,IAAA,EAAA,QAAA;IA2BV,SAAA,IAAA,EAAgB,WAAA;EAC9B,CAAA,EAAA;IACA,SAAA,IAAA,EAAA,OAAA;IACA,SAAA,IAAA,EAAA,eAAA;EACA,CAAA,CAAA;CAGO,EAAA;EAUL,SAAA,IAAA,EAAA,eAAA;EAAG,SAAA,IAAA,EAAA,OAAA;;;;ICzDM,SAAA,OAA+B,EAAA,IAAA;EAG/B,CAAA,EAAA;IAQD,SAAA,IAAa,EAAA,SAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KFCb,eAAA,WAA0B;;;;cCVzB;AFJb;AAQA;AAQA;AAWA;;;;ACtBA;AASA;iBCCgB,UAAA,CAAA;AAXhB;AAWA;AA2BA;;;;;;AAiBI,iBAjBY,gBAAA,CAiBZ;EAAA,KAAA;EAAA,KAAA;EAAA,IAAA;EAAA;CAAA,EAAA;EAAG;SAVE;;;AC/CT;AAGA;EAQY,KAAA,EAAA,MAAA;;;;;ID8CR;;;;;;AF3DS,cGEA,cHFmB,EAAA,MAAQ;AAQxC;AAQa,cGXA,aHWiB,EAAQ;EAWzB,SAAA,MAAA,EAAA,CAAA;;;;ECtBA,SAAA,MAAA,EAAA,CAAA;AASb,CAAA;KEDY,aAAA,WAAwB,4BAA4B"}