@ensforge/core 0.0.0

package/dist/write/types.d.ts

@@ -0,0 +1,188 @@
+import { EnsProtocol } from "../schemas/protocol.js";
+import { ConfirmationPolicy } from "../config/write-options.js";
+import { AuthorizationError } from "../errors/authorization-error.js";
+import { CodecError } from "../errors/codec-error.js";
+import { ConfigError } from "../errors/config-error.js";
+import { ContractError } from "../errors/contract-error.js";
+import { DnsImportError } from "../errors/dns-import-error.js";
+import { MigrationError } from "../errors/migration-error.js";
+import { NameError } from "../errors/name-error.js";
+import { RegistrationError } from "../errors/registration-error.js";
+import { RenewalError } from "../errors/renewal-error.js";
+import { ReverseNameError } from "../errors/reverse-name-error.js";
+import { RpcError } from "../errors/rpc-error.js";
+import { TransactionError } from "../errors/transaction-error.js";
+import { WalletError } from "../errors/wallet-error.js";
+import { WritePlanError } from "../errors/write-plan-error.js";
+import { EnsWriteIntent } from "../action/write-intent.js";
+import { Schema } from "effect";
+import { Account, Address, Hex, TransactionReceipt, WalletCallReceipt, WalletClient } from "viem";
+//#region src/write/types.d.ts
+declare const WriteMode: Schema.Literals<readonly ["auto", "batch", "sequential"]>;
+type WriteMode = typeof WriteMode.Type;
+declare const WriteAtomicity: Schema.Literals<readonly ["none", "preferred", "required"]>;
+type WriteAtomicity = typeof WriteAtomicity.Type;
+type WriteError = AuthorizationError | CodecError | ConfigError | ContractError | DnsImportError | NameError | MigrationError | RpcError | RegistrationError | RenewalError | ReverseNameError | TransactionError | WalletError | WritePlanError;
+interface WalletOverrides {
+  readonly walletClient?: WalletClient;
+  readonly account?: Account | Address;
+}
+interface PreparedWriteCall {
+  readonly id: string;
+  readonly operation: string;
+  readonly protocol?: EnsProtocol;
+  readonly account: Account | Address;
+  readonly chainId: number;
+  readonly to: Address;
+  readonly data?: Hex;
+  readonly value: bigint;
+}
+interface SimulatedWriteCall {
+  readonly call: PreparedWriteCall;
+  readonly result: Hex | undefined;
+}
+type WriteReceipt = TransactionReceipt | WalletCallReceipt<bigint, "success" | "reverted">;
+type CallExecutionResult = {
+  readonly id: string;
+  readonly operation: string;
+  readonly status: "not-started";
+  readonly hash: null;
+  readonly receipt: null;
+} | {
+  readonly id: string;
+  readonly operation: string;
+  readonly status: "submitted";
+  readonly hash: Hex | null;
+  readonly receipt: null;
+} | {
+  readonly id: string;
+  readonly operation: string;
+  readonly status: "confirmed";
+  readonly hash: Hex | null;
+  readonly receipt: WriteReceipt | null;
+};
+interface WalletCapabilitiesResult {
+  readonly chainId: number;
+  readonly nativeCalls: boolean;
+  readonly atomicity: "supported" | "ready" | "unsupported" | "unavailable";
+  readonly paymasterService: boolean;
+  readonly raw: Readonly<Record<string, unknown>>;
+}
+interface GetCallsStatusParameters extends WalletOverrides {
+  readonly id: string;
+}
+interface CallsStatusResult {
+  readonly id: string;
+  readonly chainId: number;
+  readonly status: "pending" | "success" | "failure" | "unknown";
+  readonly statusCode: number;
+  readonly atomic: boolean;
+  readonly receipts: ReadonlyArray<WriteReceipt>;
+}
+interface ResumeCallsParameters extends WalletOverrides {
+  readonly batch: NativeBatchResult;
+  readonly confirmation?: ConfirmationPolicy;
+}
+interface SequentialCallsResult {
+  readonly mode: "sequential";
+  readonly atomic: false;
+  readonly status: "completed" | "partial";
+  readonly calls: ReadonlyArray<CallExecutionResult>;
+  readonly failure: WriteError | null;
+}
+interface NativeBatchResult {
+  readonly mode: "batch";
+  readonly atomic: boolean;
+  readonly status: "submitted" | "confirmed";
+  readonly id: string;
+  readonly calls: ReadonlyArray<CallExecutionResult>;
+  readonly receipts: ReadonlyArray<WriteReceipt>;
+  readonly capabilities: WalletCapabilitiesResult;
+}
+type SendCallsResult = SequentialCallsResult | NativeBatchResult;
+interface PrepareCallsParameters extends WalletOverrides {
+  readonly calls: ReadonlyArray<EnsWriteIntent<unknown, WriteError>>;
+}
+interface SimulateCallsParameters extends PrepareCallsParameters {}
+type FeeEstimate = {
+  readonly type: "eip1559";
+  readonly maxFeePerGas: bigint;
+  readonly maxPriorityFeePerGas: bigint;
+} | {
+  readonly type: "legacy";
+  readonly gasPrice: bigint;
+};
+type CallEstimate = {
+  readonly status: "estimated";
+  readonly call: PreparedWriteCall;
+  readonly gas: bigint;
+  readonly fee: bigint;
+  readonly value: bigint;
+  readonly maximumCost: bigint;
+} | {
+  readonly status: "unavailable";
+  readonly call: PreparedWriteCall;
+  readonly error: ContractError | RpcError;
+};
+interface EstimateCallsParameters extends PrepareCallsParameters {}
+interface EstimateCallsResult {
+  readonly blockNumber: bigint;
+  readonly fee: FeeEstimate;
+  readonly calls: ReadonlyArray<CallEstimate>;
+  readonly totals: {
+    readonly gas: bigint;
+    readonly fee: bigint;
+    readonly value: bigint;
+    readonly maximumCost: bigint;
+  };
+}
+interface SendCallsParameters extends PrepareCallsParameters {
+  readonly mode?: WriteMode;
+  readonly atomicity?: WriteAtomicity;
+  readonly confirmation?: ConfirmationPolicy;
+  readonly simulation?: "required" | "skip";
+  readonly capabilities?: Readonly<Record<string, unknown>>;
+}
+interface GetWalletCapabilitiesParameters extends WalletOverrides {}
+type WriteWaitCondition = {
+  readonly type: "timestamp";
+  readonly target: bigint;
+} | {
+  readonly type: "block";
+  readonly target: bigint;
+};
+type WriteStage = {
+  readonly type: "calls";
+  readonly id: string;
+  readonly calls: ReadonlyArray<EnsWriteIntent<unknown, WriteError>>;
+  readonly mode?: WriteMode;
+  readonly atomicity?: WriteAtomicity;
+  readonly confirmation?: ConfirmationPolicy;
+} | {
+  readonly type: "wait";
+  readonly id: string;
+  readonly condition: WriteWaitCondition;
+};
+interface WritePlan {
+  readonly id: string;
+  readonly stages: ReadonlyArray<WriteStage>;
+}
+interface WriteStageResult {
+  readonly id: string;
+  readonly result: SendCallsResult;
+}
+interface WritePlanProgress {
+  readonly planId: string;
+  readonly status: "completed" | "waiting" | "partial" | "submitted";
+  readonly completedStages: ReadonlyArray<WriteStageResult>;
+  readonly currentStage: string | null;
+  readonly nextActionAt: bigint | null;
+  readonly failure: WriteError | null;
+}
+interface ExecuteWritePlanParameters extends WalletOverrides {
+  readonly plan: WritePlan;
+  readonly resume?: WritePlanProgress;
+}
+//#endregion
+export { CallEstimate, CallExecutionResult, CallsStatusResult, type ConfirmationPolicy, EstimateCallsParameters, EstimateCallsResult, ExecuteWritePlanParameters, FeeEstimate, GetCallsStatusParameters, GetWalletCapabilitiesParameters, NativeBatchResult, PrepareCallsParameters, PreparedWriteCall, ResumeCallsParameters, SendCallsParameters, SendCallsResult, SequentialCallsResult, SimulateCallsParameters, SimulatedWriteCall, WalletCapabilitiesResult, WalletOverrides, WriteAtomicity, WriteError, WriteMode, WritePlan, WritePlanProgress, WriteReceipt, WriteStage, WriteStageResult, WriteWaitCondition };
+//# sourceMappingURL=types.d.ts.map

package/dist/write/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","names":[],"sources":["../../src/write/types.ts"],"mappings":";;;;;;;;;;;;;;;;;;;;cA6Ba,WAAS,OAAA;KACV,mBAAmB,UAAU;cAE5B,gBAAc,OAAA;KACf,wBAAwB,eAAe;KAEvC,aACR,qBACA,aACA,cACA,gBACA,iBACA,YACA,iBACA,WACA,oBACA,eACA,mBACA,mBACA,cACA;UAEa;WACN,eAAe;WACf,UAAU,UAAU;;UAGd;WACN;WACA;WACA,WAAW;WACX,SAAS,UAAU;WACnB;WACA,IAAI;WACJ,OAAO;WACP;;UAGM;WACN,MAAM;WACN,QAAQ;;KAGP,eAAe,qBAAqB;KAEpC;WAEG;WACA;WACA;WACA;WACA;;WAGA;WACA;WACA;WACA,MAAM;WACN;;WAGA;WACA;WACA;WACA,MAAM;WACN,SAAS;;UAGP;WACN;WACA;WACA;WACA;WACA,KAAK,SAAS;;UAGR,iCAAiC;WACvC;;UAGM;WACN;WACA;WACA;WACA;WACA;WACA,UAAU,cAAc;;UAGlB,8BAA8B;WACpC,OAAO;WACP,eAAe;;UAGT;WACN;WACA;WACA;WACA,OAAO,cAAc;WACrB,SAAS;;UAGH;WACN;WACA;WACA;WACA;WACA,OAAO,cAAc;WACrB,UAAU,cAAc;WACxB,cAAc;;KAGb,kBAAkB,wBAAwB;UAErC,+BAA+B;WACrC,OAAO,cAAc,wBAAwB;;UAGvC,gCAAgC;KAErC;WAEG;WACA;WACA;;WAGA;WACA;;KAGH;WAEG;WACA,MAAM;WACN;WACA;WACA;WACA;;WAGA;WACA,MAAM;WACN,OAAO,gBAAgB;;UAGrB,gCAAgC;UAEhC;WACN;WACA,KAAK;WACL,OAAO,cAAc;WACrB;aACE;aACA;aACA;aACA;;;UAII,4BAA4B;WAClC,OAAO;WACP,YAAY;WACZ,eAAe;WACf;WACA,eAAe,SAAS;;UAGlB,wCAAwC;KAE7C;WACG;WAA4B;;WAC5B;WAAwB;;KAE3B;WAEG;WACA;WACA,OAAO,cAAc,wBAAwB;WAC7C,OAAO;WACP,YAAY;WACZ,eAAe;;WAGf;WACA;WACA,WAAW;;UAGT;WACN;WACA,QAAQ,cAAc;;UAGhB;WACN;WACA,QAAQ;;UAGF;WACN;WACA;WACA,iBAAiB,cAAc;WAC/B;WACA;WACA,SAAS;;UAGH,mCAAmC;WACzC,MAAM;WACN,SAAS"}

package/dist/write/types.js

@@ -0,0 +1,17 @@
+import { Schema } from "effect";
+
+//#region src/write/types.ts
+const WriteMode = Schema.Literals([
+	"auto",
+	"batch",
+	"sequential"
+]);
+const WriteAtomicity = Schema.Literals([
+	"none",
+	"preferred",
+	"required"
+]);
+
+//#endregion
+export { WriteAtomicity, WriteMode };
+//# sourceMappingURL=types.js.map

package/dist/write/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","names":[],"sources":["../../src/write/types.ts"],"sourcesContent":["import type {\n  Account,\n  Address,\n  Hex,\n  TransactionReceipt,\n  WalletCallReceipt,\n  WalletClient,\n} from \"viem\";\n\nimport type { EnsWriteIntent } from \"../action/write-intent.js\";\nimport type { ConfirmationPolicy } from \"../config/write-options.js\";\nimport type { AuthorizationError } from \"../errors/authorization-error.js\";\nimport type { CodecError } from \"../errors/codec-error.js\";\nimport type { ConfigError } from \"../errors/config-error.js\";\nimport type { ContractError } from \"../errors/contract-error.js\";\nimport type { DnsImportError } from \"../errors/dns-import-error.js\";\nimport type { MigrationError } from \"../errors/migration-error.js\";\nimport type { NameError } from \"../errors/name-error.js\";\nimport type { RegistrationError } from \"../errors/registration-error.js\";\nimport type { RenewalError } from \"../errors/renewal-error.js\";\nimport type { ReverseNameError } from \"../errors/reverse-name-error.js\";\nimport type { RpcError } from \"../errors/rpc-error.js\";\nimport type { TransactionError } from \"../errors/transaction-error.js\";\nimport type { WalletError } from \"../errors/wallet-error.js\";\nimport type { WritePlanError } from \"../errors/write-plan-error.js\";\nimport type { EnsProtocol } from \"../schemas/protocol.js\";\n\nexport type { ConfirmationPolicy } from \"../config/write-options.js\";\n\nexport const WriteMode = Schema.Literals([\"auto\", \"batch\", \"sequential\"]);\nexport type WriteMode = typeof WriteMode.Type;\n\nexport const WriteAtomicity = Schema.Literals([\"none\", \"preferred\", \"required\"]);\nexport type WriteAtomicity = typeof WriteAtomicity.Type;\n\nexport type WriteError =\n  | AuthorizationError\n  | CodecError\n  | ConfigError\n  | ContractError\n  | DnsImportError\n  | NameError\n  | MigrationError\n  | RpcError\n  | RegistrationError\n  | RenewalError\n  | ReverseNameError\n  | TransactionError\n  | WalletError\n  | WritePlanError;\n\nexport interface WalletOverrides {\n  readonly walletClient?: WalletClient;\n  readonly account?: Account | Address;\n}\n\nexport interface PreparedWriteCall {\n  readonly id: string;\n  readonly operation: string;\n  readonly protocol?: EnsProtocol;\n  readonly account: Account | Address;\n  readonly chainId: number;\n  readonly to: Address;\n  readonly data?: Hex;\n  readonly value: bigint;\n}\n\nexport interface SimulatedWriteCall {\n  readonly call: PreparedWriteCall;\n  readonly result: Hex | undefined;\n}\n\nexport type WriteReceipt = TransactionReceipt | WalletCallReceipt<bigint, \"success\" | \"reverted\">;\n\nexport type CallExecutionResult =\n  | {\n      readonly id: string;\n      readonly operation: string;\n      readonly status: \"not-started\";\n      readonly hash: null;\n      readonly receipt: null;\n    }\n  | {\n      readonly id: string;\n      readonly operation: string;\n      readonly status: \"submitted\";\n      readonly hash: Hex | null;\n      readonly receipt: null;\n    }\n  | {\n      readonly id: string;\n      readonly operation: string;\n      readonly status: \"confirmed\";\n      readonly hash: Hex | null;\n      readonly receipt: WriteReceipt | null;\n    };\n\nexport interface WalletCapabilitiesResult {\n  readonly chainId: number;\n  readonly nativeCalls: boolean;\n  readonly atomicity: \"supported\" | \"ready\" | \"unsupported\" | \"unavailable\";\n  readonly paymasterService: boolean;\n  readonly raw: Readonly<Record<string, unknown>>;\n}\n\nexport interface GetCallsStatusParameters extends WalletOverrides {\n  readonly id: string;\n}\n\nexport interface CallsStatusResult {\n  readonly id: string;\n  readonly chainId: number;\n  readonly status: \"pending\" | \"success\" | \"failure\" | \"unknown\";\n  readonly statusCode: number;\n  readonly atomic: boolean;\n  readonly receipts: ReadonlyArray<WriteReceipt>;\n}\n\nexport interface ResumeCallsParameters extends WalletOverrides {\n  readonly batch: NativeBatchResult;\n  readonly confirmation?: ConfirmationPolicy;\n}\n\nexport interface SequentialCallsResult {\n  readonly mode: \"sequential\";\n  readonly atomic: false;\n  readonly status: \"completed\" | \"partial\";\n  readonly calls: ReadonlyArray<CallExecutionResult>;\n  readonly failure: WriteError | null;\n}\n\nexport interface NativeBatchResult {\n  readonly mode: \"batch\";\n  readonly atomic: boolean;\n  readonly status: \"submitted\" | \"confirmed\";\n  readonly id: string;\n  readonly calls: ReadonlyArray<CallExecutionResult>;\n  readonly receipts: ReadonlyArray<WriteReceipt>;\n  readonly capabilities: WalletCapabilitiesResult;\n}\n\nexport type SendCallsResult = SequentialCallsResult | NativeBatchResult;\n\nexport interface PrepareCallsParameters extends WalletOverrides {\n  readonly calls: ReadonlyArray<EnsWriteIntent<unknown, WriteError>>;\n}\n\nexport interface SimulateCallsParameters extends PrepareCallsParameters {}\n\nexport type FeeEstimate =\n  | {\n      readonly type: \"eip1559\";\n      readonly maxFeePerGas: bigint;\n      readonly maxPriorityFeePerGas: bigint;\n    }\n  | {\n      readonly type: \"legacy\";\n      readonly gasPrice: bigint;\n    };\n\nexport type CallEstimate =\n  | {\n      readonly status: \"estimated\";\n      readonly call: PreparedWriteCall;\n      readonly gas: bigint;\n      readonly fee: bigint;\n      readonly value: bigint;\n      readonly maximumCost: bigint;\n    }\n  | {\n      readonly status: \"unavailable\";\n      readonly call: PreparedWriteCall;\n      readonly error: ContractError | RpcError;\n    };\n\nexport interface EstimateCallsParameters extends PrepareCallsParameters {}\n\nexport interface EstimateCallsResult {\n  readonly blockNumber: bigint;\n  readonly fee: FeeEstimate;\n  readonly calls: ReadonlyArray<CallEstimate>;\n  readonly totals: {\n    readonly gas: bigint;\n    readonly fee: bigint;\n    readonly value: bigint;\n    readonly maximumCost: bigint;\n  };\n}\n\nexport interface SendCallsParameters extends PrepareCallsParameters {\n  readonly mode?: WriteMode;\n  readonly atomicity?: WriteAtomicity;\n  readonly confirmation?: ConfirmationPolicy;\n  readonly simulation?: \"required\" | \"skip\";\n  readonly capabilities?: Readonly<Record<string, unknown>>;\n}\n\nexport interface GetWalletCapabilitiesParameters extends WalletOverrides {}\n\nexport type WriteWaitCondition =\n  | { readonly type: \"timestamp\"; readonly target: bigint }\n  | { readonly type: \"block\"; readonly target: bigint };\n\nexport type WriteStage =\n  | {\n      readonly type: \"calls\";\n      readonly id: string;\n      readonly calls: ReadonlyArray<EnsWriteIntent<unknown, WriteError>>;\n      readonly mode?: WriteMode;\n      readonly atomicity?: WriteAtomicity;\n      readonly confirmation?: ConfirmationPolicy;\n    }\n  | {\n      readonly type: \"wait\";\n      readonly id: string;\n      readonly condition: WriteWaitCondition;\n    };\n\nexport interface WritePlan {\n  readonly id: string;\n  readonly stages: ReadonlyArray<WriteStage>;\n}\n\nexport interface WriteStageResult {\n  readonly id: string;\n  readonly result: SendCallsResult;\n}\n\nexport interface WritePlanProgress {\n  readonly planId: string;\n  readonly status: \"completed\" | \"waiting\" | \"partial\" | \"submitted\";\n  readonly completedStages: ReadonlyArray<WriteStageResult>;\n  readonly currentStage: string | null;\n  readonly nextActionAt: bigint | null;\n  readonly failure: WriteError | null;\n}\n\nexport interface ExecuteWritePlanParameters extends WalletOverrides {\n  readonly plan: WritePlan;\n  readonly resume?: WritePlanProgress;\n}\nimport { Schema } from \"effect\";\n"],"mappings":";;;AA6BA,MAAa,YAAY,OAAO,SAAS;CAAC;CAAQ;CAAS;AAAY,CAAC;AAGxE,MAAa,iBAAiB,OAAO,SAAS;CAAC;CAAQ;CAAa;AAAU,CAAC"}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@ensforge/core",
+  "version": "0.0.0",
+  "description": "Type-safe actions and utilities for ENS",
+  "keywords": [
+    "ens",
+    "ethereum",
+    "name-service",
+    "sdk",
+    "typescript",
+    "viem",
+    "wagmi",
+    "web3"
+  ],
+  "homepage": "https://github.com/envoy1084/ensforge#readme",
+  "bugs": "https://github.com/envoy1084/ensforge/issues",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/envoy1084/ensforge.git",
+    "directory": "packages/core"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "imports": {
+    "#/*": "./dist/*.js"
+  },
+  "exports": {
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "dependencies": {
+    "@ensdomains/address-encoder": "1.1.4",
+    "@ensdomains/content-hash": "3.1.1",
+    "cborg": "6.1.1",
+    "fflate": "0.8.3",
+    "@ensforge/contracts": "0.0.0"
+  },
+  "peerDependencies": {
+    "effect": "^4.0.0-rc.112",
+    "viem": "^2.56.0",
+    "wagmi": "^3.0.0"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "bench": "vitest bench --run bench",
+    "dev": "tsdown --watch",
+    "lint": "oxlint --deny-warnings .",
+    "pack:check": "publint && attw --pack . --profile esm-only --exclude-entrypoints ./testing",
+    "test": "vitest run --passWithNoTests",
+    "test:integration": "vitest run --config vitest.integration.config.ts",
+    "test:watch": "vitest --passWithNoTests",
+    "typecheck": "tsc --noEmit"
+  }
+}