enssdk 1.16.0 → 1.17.0

package/dist/{shared-CZeZrvuq.d.ts → shared-DucmfI3x.d.ts}

@@ -1,4 +1,5 @@
-import { Hex as Hex$1, Address as Address$1 } from 'viem';
+import { Hex } from 'viem';
+import { H as Hex$1 } from './evm-D-quiIO8.js';
 
 /**
  * Base58Check-encoded Bitcoin address (SLIP-44 coin type 0).
@@ -57,7 +58,7 @@ type Email = string;
  * @see https://docs.ens.domains/ensip/1#namehash-algorithm
  * @see https://ensnode.io/docs/reference/terminology#name-node-namehash
  */
-type Node = Hex$1;
+type Node = Hex;
 /**
  * An ENS Name that may or may not be normalized.
  *
@@ -78,7 +79,7 @@ type Name = string;
  * @see https://ensnode.io/docs/reference/terminology#labels-labelhashes-labelhash-function
  * @see https://ensnode.io/ensrainbow/concepts/glossary#labelhash
  */
-type LabelHash = Hex$1;
+type LabelHash = Hex;
 /**
  * A LabelHashPath is an ordered list of LabelHashes that uniquely identify an ENS Name.
  * It is ordered in namegraph TRAVERSAL order (i.e. the opposite order of an ENS Name's labels).
@@ -290,7 +291,7 @@ type SubgraphInterpretedName = Name & {
  * cast the type of the event argument to a _nominally_ typed DNSEncodedName like {@link DNSEncodedLiteralName}
  * or {@link DNSEncodedPartiallyInterpretedName} depending on the context.
  */
-type DNSEncodedName = Hex$1;
+type DNSEncodedName = Hex;
 /**
  * A DNSEncodedName that encodes a name containing 0 or more {@link LiteralLabel}s.
  *
@@ -467,100 +468,6 @@ type RenewalId = string & {
  */
 type CanonicalPath = DomainId[];
 
-/**
- * Represents a Hex string, in the format `0x{string}`.
- */
-type Hex = Hex$1;
-/**
- * Represents an EVM Address, in the format `0x{string}`, which may or may not be checksummed.
- */
-type Address = Address$1;
-/**
- * Represents a normalized (non-checksummed) EVM Address, in the format `0x{string}`, where all
- * characters are lowercase and length is exactly 42.
- *
- * @dev because the Address type is so widely used, nominally typing it would involve a _ton_ of
- *      asNormalizedAddress() casts across the codebase. By avoiding the __brand, we can easily use
- *      EventWithArgs<{ address: NormalizedAddress }> in all of the Ponder event handler args to
- *      declare that the incoming event.args.address is a NormalizedAddress.
- */
-type NormalizedAddress = Address;
-/**
- * Unix timestamp value as bigint.
- *
- * Represents the number of seconds that have elapsed
- * since January 1, 1970 (midnight UTC/GMT).
- *
- * Guaranteed to be an integer. May be zero or negative to represent a time at or
- * before Jan 1, 1970.
- */
-type UnixTimestampBigInt = bigint;
-/**
- * Duration value as bigint.
- *
- * Representing a duration in seconds.
- *
- * Guaranteed to be a non-negative integer.
- */
-type DurationBigInt = bigint;
-/**
- * A value denominated in wei, the smallest unit of Ether (1 ETH = 10^18 wei).
- */
-type Wei = bigint;
-/**
- * Chain ID
- *
- * Represents a unique identifier for a chain.
- * Guaranteed to be a positive integer.
- *
- * Chain id standards are organized by the Ethereum Community @ https://github.com/ethereum-lists/chains
- **/
-type ChainId = number;
-/**
- * Defaultable Chain ID
- *
- * Represents a unique identifier for a chain, or
- * the default chain as defined by ENSIP-19.
- *
- * @see https://docs.ens.domains/ensip/19/#annex-supported-chains
- *
- * Guaranteed to be a non-negative integer.
- **/
-type DefaultableChainId = 0 | ChainId;
-/**
- * Represents an account (contract or EOA) at `address` on chain `chainId`.
- *
- * @see https://chainagnostic.org/CAIPs/caip-10
- */
-interface AccountId {
-    chainId: ChainId;
-    address: NormalizedAddress;
-}
-/**
- * An enum representing the possible CAIP-19 Asset Namespace values.
- *
- * @see https://chainagnostic.org/CAIPs/caip-19
- */
-declare const AssetNamespaces: {
-    readonly ERC721: "erc721";
-    readonly ERC1155: "erc1155";
-};
-type AssetNamespace = (typeof AssetNamespaces)[keyof typeof AssetNamespaces];
-/**
- * A uint256 value that identifies a specific NFT within a NFT contract.
- */
-type TokenId = bigint;
-/**
- * Represents an Asset in `assetNamespace` by `tokenId` in `contract`.
- *
- * @see https://chainagnostic.org/CAIPs/caip-19
- */
-interface AssetId {
-    assetNamespace: AssetNamespace;
-    contract: AccountId;
-    tokenId: TokenId;
-}
-
 /**
  * ABI content type per ENSIP-4.
  *
@@ -578,7 +485,7 @@ type ContentType = bigint;
  *
  * @see https://github.com/ensdomains/ens-contracts/blob/91c966febd7b55494269df830fc6775f040b927b/contracts/resolvers/profiles/InterfaceResolver.sol
  */
-type InterfaceId = Hex;
+type InterfaceId = Hex$1;
 /**
  * IVersionableResolver record version. Bumped by `VersionChanged`, which invalidates all prior
  * records for the node.
@@ -644,4 +551,4 @@ type AccountIdString = string;
  */
 type AssetIdString = string;
 
-export { type Email as $, type Address as A, type BeautifiedLabel as B, type ChainId as C, type DNSEncodedLiteralName as D, type ENSv1RegistryId as E, type AssetNamespace as F, AssetNamespaces as G, type BinanceAddress as H, type InterpretedLabel as I, type BitcoinAddress as J, type BitcoinCashAddress as K, type LiteralLabel as L, type CanonicalPath as M, type NormalizedAddress as N, type ChainIdString as O, type PermissionsId as P, type ContentType as Q, type RegistrationId as R, type StorageId as S, type TokenId as T, type UnindexedDomainId as U, type DNSEncodedPartiallyInterpretedName as V, type DatetimeISO8601 as W, type DefaultableChainId as X, type DogecoinAddress as Y, type Duration as Z, type DurationBigInt as _, type InterpretedName as a, type Hex as a0, type JsonValue as a1, type LitecoinAddress as a2, type MonacoinAddress as a3, type RecordVersion as a4, type RippleAddress as a5, type RootstockAddress as a6, type SolanaAddress as a7, type SubgraphInterpretedLabel as a8, type SubgraphInterpretedName as a9, type UnixTimestamp as aa, type UnixTimestampBigInt as ab, type UrlString as ac, type Wei as ad, type BeautifiedName as b, type AccountId as c, type AccountIdString as d, type AssetId as e, type AssetIdString as f, type Node as g, type DNSEncodedName as h, type Name as i, type ENSv2RegistryId as j, type ENSv1DomainId as k, type ENSv1VirtualRegistryId as l, type ENSv2DomainId as m, type PermissionsResourceId as n, type PermissionsUserId as o, type DomainId as p, type RenewalId as q, type ResolverId as r, type ResolverRecordsId as s, type LabelHash as t, type RegistryId as u, type InterfaceId as v, type Label as w, type LiteralName as x, type LabelHashPath as y, type EncodedLabelHash as z };
+export type { UnixTimestamp as $, AccountIdString as A, BeautifiedLabel as B, CanonicalPath as C, DNSEncodedLiteralName as D, ENSv1RegistryId as E, ContentType as F, DNSEncodedPartiallyInterpretedName as G, DatetimeISO8601 as H, InterpretedLabel as I, DogecoinAddress as J, Duration as K, LiteralLabel as L, Email as M, Node as N, JsonValue as O, PermissionsId as P, LitecoinAddress as Q, RegistrationId as R, StorageId as S, MonacoinAddress as T, UnindexedDomainId as U, RecordVersion as V, RippleAddress as W, RootstockAddress as X, SolanaAddress as Y, SubgraphInterpretedLabel as Z, SubgraphInterpretedName as _, InterpretedName as a, UrlString as a0, BeautifiedName as b, AssetIdString as c, DNSEncodedName as d, Name as e, ENSv2RegistryId as f, ENSv1DomainId as g, ENSv1VirtualRegistryId as h, ENSv2DomainId as i, PermissionsResourceId as j, PermissionsUserId as k, DomainId as l, RenewalId as m, ResolverId as n, ResolverRecordsId as o, LabelHash as p, RegistryId as q, InterfaceId as r, Label as s, LiteralName as t, LabelHashPath as u, EncodedLabelHash as v, BinanceAddress as w, BitcoinAddress as x, BitcoinCashAddress as y, ChainIdString as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "enssdk",
-  "version": "1.16.0",
+  "version": "1.17.0",
   "type": "module",
   "description": "The foundational ENS development library",
   "license": "MIT",
@@ -28,6 +28,10 @@
       "types": "./dist/core/index.d.ts",
       "default": "./dist/core/index.js"
     },
+    "./efp": {
+      "types": "./dist/efp/index.d.ts",
+      "default": "./dist/efp/index.js"
+    },
     "./omnigraph": {
       "types": "./dist/omnigraph/index.d.ts",
       "default": "./dist/omnigraph/index.js"
@@ -56,7 +60,7 @@
     "typescript": "^5.7.3",
     "viem": "^2.50.3",
     "vitest": "^4.1.0",
-    "@ensnode/shared-configs": "1.16.0"
+    "@ensnode/shared-configs": "1.17.0"
   },
   "scripts": {
     "prepublish": "tsup",

package/src/omnigraph/generated/schema.graphql

@@ -17,6 +17,11 @@ type Account {
   """
   domains(after: String, before: String, first: Int, last: Int, order: DomainsOrderInput, where: AccountDomainsWhereInput): AccountDomainsConnection
 
+  """
+  This Account's Ethereum Follow Protocol (EFP) presence: its lists, validated primary list, and account metadata. Null when the connected ENSIndexer does not have the `efp` plugin enabled.
+  """
+  efp: AccountEfp
+
   """
   All Events for which this Account is the HCA-aware `sender` (i.e. `Event.sender`).
   """
@@ -84,6 +89,81 @@ input AccountDomainsWhereInput {
   version: ENSProtocolVersion
 }
 
+"""An account's Ethereum Follow Protocol (EFP) presence."""
+type AccountEfp {
+  """
+  The accounts that follow this account: those whose validated primary EFP list holds this account as a non-`block`/`mute` record.
+  """
+  followers(after: String, before: String, first: Int, last: Int): AccountEfpFollowersConnection
+
+  """
+  The accounts this account follows: the address records in its validated primary EFP list, excluding `block`/`mute`-tagged records. Empty when the account has no validated primary list.
+  """
+  following(after: String, before: String, first: Int, last: Int): AccountEfpFollowingConnection
+
+  """
+  The EFP lists this account is the `user` of (the lists representing it).
+  """
+  lists(after: String, before: String, first: Int, last: Int): AccountEfpListsConnection
+
+  """
+  Get one of this account's EFP account-metadata values by key (e.g. "primary-list").
+  """
+  metadata(key: String!): EfpAccountMetadata
+
+  """All of this account's EFP account-metadata entries."""
+  metadatas(after: String, before: String, first: Int, last: Int): AccountEfpMetadatasConnection
+
+  """
+  The account's validated primary EFP list: the list named by its `primary-list` metadata, returned only if that list's `user` role matches the account (the EFP two-step Primary List validation). Null if unset or unvalidated.
+  """
+  primaryList: EfpList
+}
+
+type AccountEfpFollowersConnection {
+  edges: [AccountEfpFollowersConnectionEdge!]!
+  pageInfo: PageInfo!
+  totalCount: Int!
+}
+
+type AccountEfpFollowersConnectionEdge {
+  cursor: String!
+  node: Account!
+}
+
+type AccountEfpFollowingConnection {
+  edges: [AccountEfpFollowingConnectionEdge!]!
+  pageInfo: PageInfo!
+  totalCount: Int!
+}
+
+type AccountEfpFollowingConnectionEdge {
+  cursor: String!
+  node: Account!
+}
+
+type AccountEfpListsConnection {
+  edges: [AccountEfpListsConnectionEdge!]!
+  pageInfo: PageInfo!
+  totalCount: Int!
+}
+
+type AccountEfpListsConnectionEdge {
+  cursor: String!
+  node: EfpList!
+}
+
+type AccountEfpMetadatasConnection {
+  edges: [AccountEfpMetadatasConnectionEdge!]!
+  pageInfo: PageInfo!
+  totalCount: Int!
+}
+
+type AccountEfpMetadatasConnectionEdge {
+  cursor: String!
+  node: EfpAccountMetadata!
+}
+
 type AccountEventsConnection {
   edges: [AccountEventsConnectionEdge!]!
   pageInfo: PageInfo!
@@ -911,6 +991,191 @@ type ENSv2RegistryReservation implements Registration {
   unregistrant: Account
 }
 
+"""
+An EFP `(address, key) -> value` account-metadata entry (e.g. "primary-list").
+"""
+type EfpAccountMetadata {
+  """The account this metadata belongs to."""
+  address: Address!
+
+  """The CAIP-10 account id of the AccountMetadata contract."""
+  contract: AccountId!
+
+  """When this metadata entry was first indexed (Unix timestamp, seconds)."""
+  createdAt: BigInt!
+  id: ID!
+
+  """The metadata key (UTF-8 string)."""
+  key: String!
+
+  """When this metadata entry was last updated (Unix timestamp, seconds)."""
+  updatedAt: BigInt!
+
+  """The metadata value (raw bytes)."""
+  value: Hex!
+}
+
+"""An EFP list NFT (a ListRegistry token) and the records it holds."""
+type EfpList {
+  """When this list was first indexed (Unix timestamp, seconds)."""
+  createdAt: BigInt!
+
+  """The address allowed to administer this list."""
+  manager: Address
+
+  """The list NFT's AccountId."""
+  nft: AccountId!
+
+  """The current ERC-721 owner of the list NFT."""
+  owner: Address!
+
+  """The records currently in this list (the addresses it follows)."""
+  records(after: String, before: String, first: Int, last: Int): EfpListRecordsConnection
+
+  """
+  The decoded onchain location of this list's records, or null if not known.
+  """
+  storageLocation: EfpListStorageLocation
+
+  """The ERC-721 TokenId of the list NFT."""
+  tokenId: TokenId!
+
+  """When this list was last updated (Unix timestamp, seconds)."""
+  updatedAt: BigInt!
+
+  """The address allowed to post records to this list."""
+  user: Address
+}
+
+"""Identify an EFP list by its NFT token id."""
+input EfpListByInput {
+  """The ERC-721 token id of the list NFT."""
+  tokenId: TokenId!
+}
+
+"""
+A single record within an EFP list (an address it follows), with its tags.
+"""
+type EfpListRecord {
+  """
+  The Account this record points to (its `recordData`). Always resolvable: an Account exists for any address (see `query.account`), so a record's target can always be walked into its ENS names and own EFP presence.
+  """
+  account: Account!
+
+  """
+  The CAIP-10 account id of the ListRecords contract holding this record.
+  """
+  contract: AccountId!
+
+  """When this record was first indexed (Unix timestamp, seconds)."""
+  createdAt: BigInt!
+  id: ID!
+
+  """The EFP list this record belongs to."""
+  list: EfpList
+
+  """
+  Canonical record bytes (version | type | address), 0x-prefixed (exactly 22 bytes), with any trailing junk after the 20-byte address truncated.
+  """
+  record: Hex!
+
+  """
+  The followed/target address (the record's 20-byte payload). EFP indexes only address records (recordType 1).
+  """
+  recordData: Address!
+
+  """The EFP record type (1 = address)."""
+  recordType: Int!
+
+  """The list's storage slot (bytes32) within the ListRecords contract."""
+  slot: Hex!
+
+  """UTF-8 tags attached to this record (e.g. "close-friend", "block")."""
+  tags: [String!]!
+}
+
+type EfpListRecordsConnection {
+  edges: [EfpListRecordsConnectionEdge!]!
+  pageInfo: PageInfo!
+  totalCount: Int!
+}
+
+type EfpListRecordsConnectionEdge {
+  cursor: String!
+  node: EfpListRecord!
+}
+
+"""Filter EFP list records."""
+input EfpListRecordsWhereInput {
+  """
+  The target address of an address record (recordType 1). Filtering by this answers 'which lists follow this address?'.
+  """
+  recordData: Address
+
+  """The EFP record type (1 = address)."""
+  recordType: Int
+}
+
+"""
+The decoded onchain location of a list's records: a (chainId, ListRecords contract address, slot) tuple.
+"""
+type EfpListStorageLocation {
+  """The ListRecords contract address holding the list's records."""
+  address: Address!
+  chainId: ChainId!
+
+  """The list's storage slot (bytes32) within the ListRecords contract."""
+  slot: Hex!
+}
+
+"""Filter EFP lists by their owner, user, or manager address."""
+input EfpListsWhereInput {
+  """The address allowed to administer the list."""
+  manager: Address
+
+  """The ERC-721 owner of the list NFT."""
+  owner: Address
+
+  """The address allowed to post records."""
+  user: Address
+}
+
+"""Queries for Ethereum Follow Protocol (EFP) data."""
+type EfpQuery {
+  """Get an EFP list by its NFT token id."""
+  list(by: EfpListByInput!): EfpList
+
+  """
+  Find EFP list records. Filter by `recordData` to answer 'which lists follow this address?'.
+  """
+  listRecords(after: String, before: String, first: Int, last: Int, where: EfpListRecordsWhereInput): EfpQueryListRecordsConnection
+
+  """Find EFP lists, optionally filtered by owner / user / manager."""
+  lists(after: String, before: String, first: Int, last: Int, where: EfpListsWhereInput): EfpQueryListsConnection
+}
+
+type EfpQueryListRecordsConnection {
+  edges: [EfpQueryListRecordsConnectionEdge!]!
+  pageInfo: PageInfo!
+  totalCount: Int!
+}
+
+type EfpQueryListRecordsConnectionEdge {
+  cursor: String!
+  node: EfpListRecord!
+}
+
+type EfpQueryListsConnection {
+  edges: [EfpQueryListsConnectionEdge!]!
+  pageInfo: PageInfo!
+  totalCount: Int!
+}
+
+type EfpQueryListsConnectionEdge {
+  cursor: String!
+  node: EfpList!
+}
+
 """Email represents a validated contact email address."""
 scalar Email
 
@@ -1520,6 +1785,11 @@ type Query {
   """
   domains(after: String, before: String, first: Int, last: Int, order: DomainsOrderInput, where: DomainsWhereInput!): QueryDomainsConnection
 
+  """
+  Ethereum Follow Protocol (EFP) queries. Null when the connected ENSIndexer does not have the `efp` plugin enabled.
+  """
+  efp: EfpQuery
+
   """Identify Permissions by ID or AccountId."""
   permissions(by: PermissionsIdInput!): Permissions
 
@@ -2001,6 +2271,9 @@ type ThreeDNSRegistration implements Registration {
   unregistrant: Account
 }
 
+"""TokenId represents an enssdk#TokenId."""
+scalar TokenId
+
 """
 A resolvable-but-unindexed Domain: not present in the index, but resolvable because an ancestor in its namegraph path has an ENSIP-10 wildcard Resolver (e.g. off-chain / CCIP-Read names, unindexed 3DNS names, wildcard subnames).
 """