@ensforge/sdk 0.1.0 → 0.2.0

package/README.md

@@ -13,7 +13,7 @@ A type-safe client for building ENS applications.
 ## Installation
 
 ```sh
-pnpm add @ensforge/sdk
+pnpm add @ensforge/sdk effect@rc viem
 ```
 
 ## Overview
@@ -43,6 +43,14 @@ const text = await sdk.records.getText({ name: "ens.eth", key: "url" });
 const price = await sdk.registration.getRegistrationPrice({ name: "example.eth", duration });
 ```
 
+Import action-specific types from the corresponding group entrypoint. This keeps editor type
+loading focused while method calls remain fully inferred.
+
+```ts
+import type { GetOwnerParameters } from "@ensforge/sdk/name";
+import type { SetTextParameters } from "@ensforge/sdk/records";
+```
+
 Compatible reads can be executed together:
 
 ```ts
@@ -56,7 +64,9 @@ const profile = await sdk.batch.readBatch({
 Use an existing Wagmi config instead of supplying viem clients:
 
 ```ts
-const sdk = new Ensforge({
+import { createEnsforge } from "@ensforge/sdk/wagmi";
+
+const sdk = createEnsforge({
   network: "mainnet",
   wagmiConfig,
 });

package/dist/batch.d.ts

@@ -0,0 +1,3 @@
+import { BatchActions } from "./groups/batch.js";
+export type * from "@ensforge/core/batch";
+export type { BatchActions };

package/dist/capabilities.d.ts

@@ -0,0 +1,3 @@
+import { CapabilitiesActions } from "./groups/capabilities.js";
+export type * from "@ensforge/core/capabilities";
+export type { CapabilitiesActions };

package/dist/dns.d.ts

@@ -0,0 +1,3 @@
+import { DnsActions } from "./groups/dns.js";
+export type * from "@ensforge/core/dns";
+export type { DnsActions };

package/dist/ensforge.d.ts

@@ -31,7 +31,7 @@ declare class Ensforge {
   readonly reverse: ReverseActions;
   readonly subnames: SubnameActions;
   readonly wrapping: WrappingActions;
-  constructor(parameters: CreateConfigParameters);
+  constructor(parameters: CreateConfigParameters | EnsforgeConfig);
 }
 //#endregion
 export { Ensforge };

package/dist/ensforge.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ensforge.d.ts","names":[],"sources":["../src/ensforge.ts"],"mappings":";;;;;;;;;;;;;;;;;cAiCa;WACF,QAAQ;WACR,OAAO;WACP,cAAc;WACd,KAAK;WACL,QAAQ;WACR,WAAW;WACX,MAAM;WACN,WAAW;WACX,aAAa;WACb,SAAS;WACT,cAAc;WACd,YAAY;WACZ,SAAS;WACT,UAAU;WACV,UAAU;EAEP,YAAA,YAAY"}
+{"version":3,"file":"ensforge.d.ts","names":[],"sources":["../src/ensforge.ts"],"mappings":";;;;;;;;;;;;;;;;;cAsCa;WACF,QAAQ;WACR,OAAO;WACP,cAAc;WACd,KAAK;WACL,QAAQ;WACR,WAAW;WACX,MAAM;WACN,WAAW;WACX,aAAa;WACb,SAAS;WACT,cAAc;WACd,YAAY;WACZ,SAAS;WACT,UAAU;WACV,UAAU;EAEP,YAAA,YAAY,yBAAyB"}

package/dist/ensforge.js

@@ -12,7 +12,7 @@ import { makeResolutionActions } from "./groups/resolution.js";
 import { makeReverseActions } from "./groups/reverse.js";
 import { makeSubnameActions } from "./groups/subnames.js";
 import { makeWrappingActions } from "./groups/wrapping.js";
-import { createConfig } from "@ensforge/core";
+import { EnsforgeConfigTypeId, createConfig } from "@ensforge/core";
 
 //#region src/ensforge.ts
 var Ensforge = class {
@@ -32,7 +32,7 @@ var Ensforge = class {
 	subnames;
 	wrapping;
 	constructor(parameters) {
-		const config = createConfig(parameters);
+		const config = EnsforgeConfigTypeId in parameters ? parameters : createConfig(parameters);
 		this.config = config;
 		this.batch = makeBatchActions(config);
 		this.capabilities = makeCapabilitiesActions(config);

package/dist/ensforge.js.map

@@ -1 +1 @@
-{"version":3,"file":"ensforge.js","names":[],"sources":["../src/ensforge.ts"],"sourcesContent":["import { createConfig, type CreateConfigParameters, type EnsforgeConfig } from \"@ensforge/core\";\n\nimport {\n  makeBatchActions,\n  makeCapabilitiesActions,\n  makeDnsActions,\n  makeEventsActions,\n  makeMigrationActions,\n  makeNameActions,\n  makeOwnershipActions,\n  makePermissionsActions,\n  makeRecordsActions,\n  makeRegistrationActions,\n  makeResolutionActions,\n  makeReverseActions,\n  makeSubnameActions,\n  makeWrappingActions,\n  type BatchActions,\n  type CapabilitiesActions,\n  type DnsActions,\n  type EventsActions,\n  type MigrationActions,\n  type NameActions,\n  type OwnershipActions,\n  type PermissionsActions,\n  type RecordsActions,\n  type RegistrationActions,\n  type ResolutionActions,\n  type ReverseActions,\n  type SubnameActions,\n  type WrappingActions,\n} from \"./groups/index.js\";\n\nexport class Ensforge {\n  readonly config: EnsforgeConfig;\n  readonly batch: BatchActions;\n  readonly capabilities: CapabilitiesActions;\n  readonly dns: DnsActions;\n  readonly events: EventsActions;\n  readonly migration: MigrationActions;\n  readonly name: NameActions;\n  readonly ownership: OwnershipActions;\n  readonly permissions: PermissionsActions;\n  readonly records: RecordsActions;\n  readonly registration: RegistrationActions;\n  readonly resolution: ResolutionActions;\n  readonly reverse: ReverseActions;\n  readonly subnames: SubnameActions;\n  readonly wrapping: WrappingActions;\n\n  constructor(parameters: CreateConfigParameters) {\n    const config = createConfig(parameters);\n\n    this.config = config;\n    this.batch = makeBatchActions(config);\n    this.capabilities = makeCapabilitiesActions(config);\n    this.dns = makeDnsActions(config);\n    this.events = makeEventsActions(config);\n    this.migration = makeMigrationActions(config);\n    this.name = makeNameActions(config);\n    this.ownership = makeOwnershipActions(config);\n    this.permissions = makePermissionsActions(config);\n    this.records = makeRecordsActions(config);\n    this.registration = makeRegistrationActions(config);\n    this.resolution = makeResolutionActions(config);\n    this.reverse = makeReverseActions(config);\n    this.subnames = makeSubnameActions(config);\n    this.wrapping = makeWrappingActions(config);\n\n    Object.freeze(this);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AAiCA,IAAa,WAAb,MAAsB;CACpB,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CAET,YAAY,YAAoC;EAC9C,MAAM,SAAS,aAAa,UAAU;EAEtC,KAAK,SAAS;EACd,KAAK,QAAQ,iBAAiB,MAAM;EACpC,KAAK,eAAe,wBAAwB,MAAM;EAClD,KAAK,MAAM,eAAe,MAAM;EAChC,KAAK,SAAS,kBAAkB,MAAM;EACtC,KAAK,YAAY,qBAAqB,MAAM;EAC5C,KAAK,OAAO,gBAAgB,MAAM;EAClC,KAAK,YAAY,qBAAqB,MAAM;EAC5C,KAAK,cAAc,uBAAuB,MAAM;EAChD,KAAK,UAAU,mBAAmB,MAAM;EACxC,KAAK,eAAe,wBAAwB,MAAM;EAClD,KAAK,aAAa,sBAAsB,MAAM;EAC9C,KAAK,UAAU,mBAAmB,MAAM;EACxC,KAAK,WAAW,mBAAmB,MAAM;EACzC,KAAK,WAAW,oBAAoB,MAAM;EAE1C,OAAO,OAAO,IAAI;CACpB;AACF"}
+{"version":3,"file":"ensforge.js","names":[],"sources":["../src/ensforge.ts"],"sourcesContent":["import {\n  createConfig,\n  EnsforgeConfigTypeId,\n  type CreateConfigParameters,\n  type EnsforgeConfig,\n} from \"@ensforge/core\";\n\nimport {\n  makeBatchActions,\n  makeCapabilitiesActions,\n  makeDnsActions,\n  makeEventsActions,\n  makeMigrationActions,\n  makeNameActions,\n  makeOwnershipActions,\n  makePermissionsActions,\n  makeRecordsActions,\n  makeRegistrationActions,\n  makeResolutionActions,\n  makeReverseActions,\n  makeSubnameActions,\n  makeWrappingActions,\n  type BatchActions,\n  type CapabilitiesActions,\n  type DnsActions,\n  type EventsActions,\n  type MigrationActions,\n  type NameActions,\n  type OwnershipActions,\n  type PermissionsActions,\n  type RecordsActions,\n  type RegistrationActions,\n  type ResolutionActions,\n  type ReverseActions,\n  type SubnameActions,\n  type WrappingActions,\n} from \"./groups/index.js\";\n\nexport class Ensforge {\n  readonly config: EnsforgeConfig;\n  readonly batch: BatchActions;\n  readonly capabilities: CapabilitiesActions;\n  readonly dns: DnsActions;\n  readonly events: EventsActions;\n  readonly migration: MigrationActions;\n  readonly name: NameActions;\n  readonly ownership: OwnershipActions;\n  readonly permissions: PermissionsActions;\n  readonly records: RecordsActions;\n  readonly registration: RegistrationActions;\n  readonly resolution: ResolutionActions;\n  readonly reverse: ReverseActions;\n  readonly subnames: SubnameActions;\n  readonly wrapping: WrappingActions;\n\n  constructor(parameters: CreateConfigParameters | EnsforgeConfig) {\n    const config = EnsforgeConfigTypeId in parameters ? parameters : createConfig(parameters);\n\n    this.config = config;\n    this.batch = makeBatchActions(config);\n    this.capabilities = makeCapabilitiesActions(config);\n    this.dns = makeDnsActions(config);\n    this.events = makeEventsActions(config);\n    this.migration = makeMigrationActions(config);\n    this.name = makeNameActions(config);\n    this.ownership = makeOwnershipActions(config);\n    this.permissions = makePermissionsActions(config);\n    this.records = makeRecordsActions(config);\n    this.registration = makeRegistrationActions(config);\n    this.resolution = makeResolutionActions(config);\n    this.reverse = makeReverseActions(config);\n    this.subnames = makeSubnameActions(config);\n    this.wrapping = makeWrappingActions(config);\n\n    Object.freeze(this);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AAsCA,IAAa,WAAb,MAAsB;CACpB,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CACT,AAAS;CAET,YAAY,YAAqD;EAC/D,MAAM,SAAS,wBAAwB,aAAa,aAAa,aAAa,UAAU;EAExF,KAAK,SAAS;EACd,KAAK,QAAQ,iBAAiB,MAAM;EACpC,KAAK,eAAe,wBAAwB,MAAM;EAClD,KAAK,MAAM,eAAe,MAAM;EAChC,KAAK,SAAS,kBAAkB,MAAM;EACtC,KAAK,YAAY,qBAAqB,MAAM;EAC5C,KAAK,OAAO,gBAAgB,MAAM;EAClC,KAAK,YAAY,qBAAqB,MAAM;EAC5C,KAAK,cAAc,uBAAuB,MAAM;EAChD,KAAK,UAAU,mBAAmB,MAAM;EACxC,KAAK,eAAe,wBAAwB,MAAM;EAClD,KAAK,aAAa,sBAAsB,MAAM;EAC9C,KAAK,UAAU,mBAAmB,MAAM;EACxC,KAAK,WAAW,mBAAmB,MAAM;EACzC,KAAK,WAAW,oBAAoB,MAAM;EAE1C,OAAO,OAAO,IAAI;CACpB;AACF"}

package/dist/events.d.ts

@@ -0,0 +1,3 @@
+import { EventsActions } from "./groups/events.js";
+export type * from "@ensforge/core/events";
+export type { EventsActions };

package/dist/groups/batch.d.ts

@@ -1,20 +1,18 @@
 import { BoundAction, BoundReadBatch, BoundReadBatchSettled } from "../internal/bind-action.js";
-import "../index.js";
-import { EnsforgeConfig } from "@ensforge/core";
+import { EnsforgeConfig, estimateCalls, executeWritePlan, getCallsStatus, getWalletCapabilities, prepareCalls, resumeCalls, sendCalls, simulateCalls } from "@ensforge/core";
 //#region src/groups/batch.d.ts
-declare const makeBatchActions: (config: EnsforgeConfig) => Readonly<{
-  estimateCalls: BoundAction<import("@ensforge/core").EnsAction<import("@ensforge/core").EstimateCallsParameters, import("@ensforge/core").EstimateCallsResult, import("@ensforge/core").WriteError>>;
-  executeWritePlan: BoundAction<import("@ensforge/core").EnsAction<import("@ensforge/core").ExecuteWritePlanParameters, import("@ensforge/core").WritePlanProgress, import("@ensforge/core").WriteError>>;
-  getCallsStatus: BoundAction<import("@ensforge/core").EnsAction<import("@ensforge/core").GetCallsStatusParameters, import("@ensforge/core").CallsStatusResult, import("@ensforge/core").WriteError>>;
-  getWalletCapabilities: BoundAction<import("@ensforge/core").EnsAction<import("@ensforge/core").GetWalletCapabilitiesParameters, import("@ensforge/core").WalletCapabilitiesResult, import("@ensforge/core").ConfigError | import("@ensforge/core").WalletError>>;
-  prepareCalls: BoundAction<import("@ensforge/core").EnsAction<import("@ensforge/core").PrepareCallsParameters, readonly import("@ensforge/core").PreparedWriteCall[], import("@ensforge/core").WriteError>>;
-  readBatch: BoundReadBatch;
-  readBatchSettled: BoundReadBatchSettled;
-  resumeCalls: BoundAction<import("@ensforge/core").EnsAction<import("@ensforge/core").ResumeCallsParameters, import("@ensforge/core").NativeBatchResult, import("@ensforge/core").WriteError>>;
-  sendCalls: BoundAction<import("@ensforge/core").EnsAction<import("@ensforge/core").SendCallsParameters, import("@ensforge/core").SendCallsResult, import("@ensforge/core").WriteError>>;
-  simulateCalls: BoundAction<import("@ensforge/core").EnsAction<import("@ensforge/core").SimulateCallsParameters, readonly import("@ensforge/core").SimulatedWriteCall[], import("@ensforge/core").WriteError>>;
-}>;
-type BatchActions = ReturnType<typeof makeBatchActions>;
+interface BatchActions {
+  readonly estimateCalls: BoundAction<typeof estimateCalls>;
+  readonly executeWritePlan: BoundAction<typeof executeWritePlan>;
+  readonly getCallsStatus: BoundAction<typeof getCallsStatus>;
+  readonly getWalletCapabilities: BoundAction<typeof getWalletCapabilities>;
+  readonly prepareCalls: BoundAction<typeof prepareCalls>;
+  readonly readBatch: BoundReadBatch;
+  readonly readBatchSettled: BoundReadBatchSettled;
+  readonly resumeCalls: BoundAction<typeof resumeCalls>;
+  readonly sendCalls: BoundAction<typeof sendCalls>;
+  readonly simulateCalls: BoundAction<typeof simulateCalls>;
+}
 //#endregion
-export { BatchActions, makeBatchActions };
+export { BatchActions };
 //# sourceMappingURL=batch.d.ts.map

package/dist/groups/batch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"batch.d.ts","names":[],"sources":["../../src/groups/batch.ts"],"mappings":";;;;cAgBa,mBAAoB,QAAQ,mBAAc;iBAAd;;;;;;;;;;;KAc7B,eAAe,kBAAkB"}
+{"version":3,"file":"batch.d.ts","names":[],"sources":["../../src/groups/batch.ts"],"mappings":";;;UAqBiB;WACN,eAAe,mBAAmB;WAClC,kBAAkB,mBAAmB;WACrC,gBAAgB,mBAAmB;WACnC,uBAAuB,mBAAmB;WAC1C,cAAc,mBAAmB;WACjC,WAAW;WACX,kBAAkB;WAClB,aAAa,mBAAmB;WAChC,WAAW,mBAAmB;WAC9B,eAAe,mBAAmB"}

package/dist/groups/batch.js.map

@@ -1 +1 @@
-{"version":3,"file":"batch.js","names":[],"sources":["../../src/groups/batch.ts"],"sourcesContent":["import {\n  estimateCalls,\n  executeWritePlan,\n  getCallsStatus,\n  getWalletCapabilities,\n  prepareCalls,\n  readBatch,\n  readBatchSettled,\n  resumeCalls,\n  sendCalls,\n  simulateCalls,\n  type EnsforgeConfig,\n} from \"@ensforge/core\";\n\nimport { bindAction } from \"../internal/bind-action.js\";\n\nexport const makeBatchActions = (config: EnsforgeConfig) =>\n  Object.freeze({\n    estimateCalls: bindAction(config, estimateCalls),\n    executeWritePlan: bindAction(config, executeWritePlan),\n    getCallsStatus: bindAction(config, getCallsStatus),\n    getWalletCapabilities: bindAction(config, getWalletCapabilities),\n    prepareCalls: bindAction(config, prepareCalls),\n    readBatch: bindAction(config, readBatch),\n    readBatchSettled: bindAction(config, readBatchSettled),\n    resumeCalls: bindAction(config, resumeCalls),\n    sendCalls: bindAction(config, sendCalls),\n    simulateCalls: bindAction(config, simulateCalls),\n  });\n\nexport type BatchActions = ReturnType<typeof makeBatchActions>;\n"],"mappings":";;;;AAgBA,MAAa,oBAAoB,WAC/B,OAAO,OAAO;CACZ,eAAe,WAAW,QAAQ,aAAa;CAC/C,kBAAkB,WAAW,QAAQ,gBAAgB;CACrD,gBAAgB,WAAW,QAAQ,cAAc;CACjD,uBAAuB,WAAW,QAAQ,qBAAqB;CAC/D,cAAc,WAAW,QAAQ,YAAY;CAC7C,WAAW,WAAW,QAAQ,SAAS;CACvC,kBAAkB,WAAW,QAAQ,gBAAgB;CACrD,aAAa,WAAW,QAAQ,WAAW;CAC3C,WAAW,WAAW,QAAQ,SAAS;CACvC,eAAe,WAAW,QAAQ,aAAa;AACjD,CAAC"}
+{"version":3,"file":"batch.js","names":[],"sources":["../../src/groups/batch.ts"],"sourcesContent":["import {\n  estimateCalls,\n  executeWritePlan,\n  getCallsStatus,\n  getWalletCapabilities,\n  prepareCalls,\n  readBatch,\n  readBatchSettled,\n  resumeCalls,\n  sendCalls,\n  simulateCalls,\n  type EnsforgeConfig,\n} from \"@ensforge/core\";\n\nimport {\n  bindAction,\n  type BoundAction,\n  type BoundReadBatch,\n  type BoundReadBatchSettled,\n} from \"../internal/bind-action.js\";\n\nexport interface BatchActions {\n  readonly estimateCalls: BoundAction<typeof estimateCalls>;\n  readonly executeWritePlan: BoundAction<typeof executeWritePlan>;\n  readonly getCallsStatus: BoundAction<typeof getCallsStatus>;\n  readonly getWalletCapabilities: BoundAction<typeof getWalletCapabilities>;\n  readonly prepareCalls: BoundAction<typeof prepareCalls>;\n  readonly readBatch: BoundReadBatch;\n  readonly readBatchSettled: BoundReadBatchSettled;\n  readonly resumeCalls: BoundAction<typeof resumeCalls>;\n  readonly sendCalls: BoundAction<typeof sendCalls>;\n  readonly simulateCalls: BoundAction<typeof simulateCalls>;\n}\n\nexport const makeBatchActions = (config: EnsforgeConfig): BatchActions =>\n  Object.freeze({\n    estimateCalls: bindAction(config, estimateCalls),\n    executeWritePlan: bindAction(config, executeWritePlan),\n    getCallsStatus: bindAction(config, getCallsStatus),\n    getWalletCapabilities: bindAction(config, getWalletCapabilities),\n    prepareCalls: bindAction(config, prepareCalls),\n    readBatch: bindAction(config, readBatch),\n    readBatchSettled: bindAction(config, readBatchSettled),\n    resumeCalls: bindAction(config, resumeCalls),\n    sendCalls: bindAction(config, sendCalls),\n    simulateCalls: bindAction(config, simulateCalls),\n  });\n"],"mappings":";;;;AAkCA,MAAa,oBAAoB,WAC/B,OAAO,OAAO;CACZ,eAAe,WAAW,QAAQ,aAAa;CAC/C,kBAAkB,WAAW,QAAQ,gBAAgB;CACrD,gBAAgB,WAAW,QAAQ,cAAc;CACjD,uBAAuB,WAAW,QAAQ,qBAAqB;CAC/D,cAAc,WAAW,QAAQ,YAAY;CAC7C,WAAW,WAAW,QAAQ,SAAS;CACvC,kBAAkB,WAAW,QAAQ,gBAAgB;CACrD,aAAa,WAAW,QAAQ,WAAW;CAC3C,WAAW,WAAW,QAAQ,SAAS;CACvC,eAAe,WAAW,QAAQ,aAAa;AACjD,CAAC"}