Permissions By Contract

Roles and users granted on resources for a registrar or registry contract.

omnigraphenssdkenskitcurl

Run in ENSAdmin Open an interactive playground to execute this example on our sepolia-v2 ENSNode instance.

GraphQL

query PermissionsByContract(
  $contract: AccountIdInput!
) {
  permissions(by: { contract: $contract }) {
    resources {
      edges {
        node {
          resource
          users {
            edges {
              node {
                id
                user { address }
                roles
              }
            }
          }
        }
      }
    }
    events { totalCount edges { node { topics data timestamp } } }
  }
}

Variables

{
  "contract": {
    "chainId": 99911155111,
    "address": "0x26e5e80e8f36607ef401443fb34eea363c86e8f7"
  }
}

Output

{
  "data": {
    "permissions": {
      "events": {
        "totalCount": 1,
        "edges": [
          {
            "node": {
              "topics": [
                "0x0d35bf721a39b614de00ca5038e1deb0cb0c69a278645e83405a7226cf80ba3c",
                "0x0000000000000000000000000000000000000000000000000000000000000000",
                "0x000000000000000000000000ffffffffff52d316b7bd028358089bc8066b8f80"
              ],
              "data": "0x00000000000000000000000000000000000000000000000000000000000000001111111111111111111111111111111111111111111111111111111111111111",
              "timestamp": "1777666931"
            }
          }
        ]
      },
      "resources": {
        "edges": [
          {
            "node": {
              "resource": "0",
              "users": {
                "edges": [
                  {
                    "node": {
                      "id": "99911155111-0x26e5e80e8f36607ef401443fb34eea363c86e8f7-0-0xffffffffff52d316b7bd028358089bc8066b8f80",
                      "roles": "7719472615821079694904732333912527190217998977709370935963838933860875309329",
                      "user": {
                        "address": "0xffffffffff52d316b7bd028358089bc8066b8f80"
                      }
                    }
                  }
                ]
              }
            }
          }
        ]
      }
    }
  }
}

Output matches a GraphQL Response snapshot; live output depends on your ENSNode instance.

Run in StackBlitz Opens an editable StackBlitz project with this snippet.

TypeScript

import { createEnsNodeClient } from "enssdk/core";
import { graphql, omnigraph } from "enssdk/omnigraph";

const client = createEnsNodeClient({
  url: process.env.ENSNODE_URL || "https://api.v2-sepolia.ensnode.io"
}).extend(omnigraph);

const PermissionsByContractQuery = graphql(`
  query PermissionsByContract(
    $contract: AccountIdInput!
  ) {
    permissions(by: { contract: $contract }) {
      resources {
        edges {
          node {
            resource
            users {
              edges {
                node {
                  id
                  user { address }
                  roles
                }
              }
            }
          }
        }
      }
      events { totalCount edges { node { topics data timestamp } } }
    }
  }
`);

const result = await client.omnigraph.query({
  query: PermissionsByContractQuery,
  variables:   {
    contract: {
      "chainId": 99911155111,
      "address": "0x26e5e80e8f36607ef401443fb34eea363c86e8f7"
    },
  },
});

if (result.errors) throw new Error(JSON.stringify(result.errors));
console.log(JSON.stringify(result.data, null, 2));

Output

{
  "data": {
    "permissions": {
      "events": {
        "totalCount": 1,
        "edges": [
          {
            "node": {
              "topics": [
                "0x0d35bf721a39b614de00ca5038e1deb0cb0c69a278645e83405a7226cf80ba3c",
                "0x0000000000000000000000000000000000000000000000000000000000000000",
                "0x000000000000000000000000ffffffffff52d316b7bd028358089bc8066b8f80"
              ],
              "data": "0x00000000000000000000000000000000000000000000000000000000000000001111111111111111111111111111111111111111111111111111111111111111",
              "timestamp": "1777666931"
            }
          }
        ]
      },
      "resources": {
        "edges": [
          {
            "node": {
              "resource": "0",
              "users": {
                "edges": [
                  {
                    "node": {
                      "id": "99911155111-0x26e5e80e8f36607ef401443fb34eea363c86e8f7-0-0xffffffffff52d316b7bd028358089bc8066b8f80",
                      "roles": "7719472615821079694904732333912527190217998977709370935963838933860875309329",
                      "user": {
                        "address": "0xffffffffff52d316b7bd028358089bc8066b8f80"
                      }
                    }
                  }
                ]
              }
            }
          }
        ]
      }
    }
  }
}

Output matches a GraphQL Response snapshot; live output depends on your ENSNode instance.

enssdk package manager setup

npm pnpm

# 1. Create project
mkdir -p my-ens-script/src && cd my-ens-script
npm init -y && touch src/index.ts
npm pkg set type=module scripts.start="tsx src/index.ts"
# 2. Install dependencies
npm install enssdk@1.13.1 && npm install -D tsx typescript @types/node
# 3. Paste the TypeScript snippet above into src/index.ts
# 4. Run
ENSNODE_URL=https://api.v2-sepolia.ensnode.io npm start

# 1. Create project
mkdir -p my-ens-script/src && cd my-ens-script
pnpm init && touch src/index.ts
pnpm pkg set type=module scripts.start="tsx src/index.ts"
# 2. Install dependencies
pnpm add enssdk@1.13.1 && pnpm add -D tsx typescript @types/node
# 3. Paste the TypeScript snippet above into src/index.ts
# 4. Run
ENSNODE_URL=https://api.v2-sepolia.ensnode.io pnpm start

See the enssdk docs for gql.tada plugin and tsconfig setup.

Run in StackBlitz Opens an editable StackBlitz project with this snippet.

TSX (React)

import { OmnigraphProvider, useOmnigraphQuery, graphql } from "enskit/react/omnigraph";
import { createEnsNodeClient } from "enssdk/core";
import { omnigraph } from "enssdk/omnigraph";

const client = createEnsNodeClient({
  url: import.meta.env.VITE_ENSNODE_URL || "https://api.v2-sepolia.ensnode.io"
}).extend(omnigraph);

const PermissionsByContractQuery = graphql(`
  query PermissionsByContract(
    $contract: AccountIdInput!
  ) {
    permissions(by: { contract: $contract }) {
      resources {
        edges {
          node {
            resource
            users {
              edges {
                node {
                  id
                  user { address }
                  roles
                }
              }
            }
          }
        }
      }
      events { totalCount edges { node { topics data timestamp } } }
    }
  }
`);

function PermissionsByContractResult() {
  const [result] = useOmnigraphQuery({
    query: PermissionsByContractQuery,
    variables:     {
      contract: {
        "chainId": 99911155111,
        "address": "0x26e5e80e8f36607ef401443fb34eea363c86e8f7"
      },
    },
  });
  const { data, fetching, error } = result;
  if (!data && fetching) return <p>Loading…</p>;
  if (error) return <p>Error: {error.message}</p>;
  if (!data) return <p>No data returned.</p>;
  const formatted = JSON.stringify(
    data,
    (_, value) => (typeof value === "bigint" ? value.toString() : value),
    2,
  );
  return <code>{formatted}</code>;
}

export default function App() {
  return (
    <OmnigraphProvider client={client}>
      <PermissionsByContractResult />
    </OmnigraphProvider>
  );
}

Output

{
  "data": {
    "permissions": {
      "events": {
        "totalCount": 1,
        "edges": [
          {
            "node": {
              "topics": [
                "0x0d35bf721a39b614de00ca5038e1deb0cb0c69a278645e83405a7226cf80ba3c",
                "0x0000000000000000000000000000000000000000000000000000000000000000",
                "0x000000000000000000000000ffffffffff52d316b7bd028358089bc8066b8f80"
              ],
              "data": "0x00000000000000000000000000000000000000000000000000000000000000001111111111111111111111111111111111111111111111111111111111111111",
              "timestamp": "1777666931"
            }
          }
        ]
      },
      "resources": {
        "edges": [
          {
            "node": {
              "resource": "0",
              "users": {
                "edges": [
                  {
                    "node": {
                      "id": "99911155111-0x26e5e80e8f36607ef401443fb34eea363c86e8f7-0-0xffffffffff52d316b7bd028358089bc8066b8f80",
                      "roles": "7719472615821079694904732333912527190217998977709370935963838933860875309329",
                      "user": {
                        "address": "0xffffffffff52d316b7bd028358089bc8066b8f80"
                      }
                    }
                  }
                ]
              }
            }
          }
        ]
      }
    }
  }
}

Output matches a GraphQL Response snapshot; live output depends on your ENSNode instance.

enskit package manager setup

npm pnpm

# 1. Create project
npm create vite@latest my-ens-app -- --template react-ts --no-interactive --no-immediate
cd my-ens-app
# 2. Install dependencies
npm install
npm install enskit@1.13.1 enssdk@1.13.1
# 3. Copy the TSX snippet above into src/App.tsx
# 4. Run
VITE_ENSNODE_URL=https://api.v2-sepolia.ensnode.io npm run dev

# 1. Create project
pnpm create vite@latest my-ens-app --template react-ts --no-interactive --no-immediate
cd my-ens-app
# 2. Install dependencies
pnpm install
pnpm add enskit@1.13.1 enssdk@1.13.1
# 3. Copy the TSX snippet above into src/App.tsx
# 4. Run
VITE_ENSNODE_URL=https://api.v2-sepolia.ensnode.io pnpm run dev

See the enskit docs for gql.tada plugin and provider setup.

cURL

# POST JSON to your ENSNode Omnigraph endpoint (same path enssdk uses).
curl -sS -X POST "https://api.v2-sepolia.ensnode.io/api/omnigraph" \
  -H "Content-Type: application/json" \
  -d @- <<'EOF'
{
  "query": "query PermissionsByContract( $contract: AccountIdInput! ) { permissions(by: { contract: $contract }) { resources { edges { node { resource users { edges { node { id user { address } roles } } } } } } events { totalCount edges { node { topics data timestamp } } } } }",
  "variables": {
    "contract": {
      "chainId": 99911155111,
      "address": "0x26e5e80e8f36607ef401443fb34eea363c86e8f7"
    }
  }
}
EOF

Response

{
  "data": {
    "permissions": {
      "events": {
        "totalCount": 1,
        "edges": [
          {
            "node": {
              "topics": [
                "0x0d35bf721a39b614de00ca5038e1deb0cb0c69a278645e83405a7226cf80ba3c",
                "0x0000000000000000000000000000000000000000000000000000000000000000",
                "0x000000000000000000000000ffffffffff52d316b7bd028358089bc8066b8f80"
              ],
              "data": "0x00000000000000000000000000000000000000000000000000000000000000001111111111111111111111111111111111111111111111111111111111111111",
              "timestamp": "1777666931"
            }
          }
        ]
      },
      "resources": {
        "edges": [
          {
            "node": {
              "resource": "0",
              "users": {
                "edges": [
                  {
                    "node": {
                      "id": "99911155111-0x26e5e80e8f36607ef401443fb34eea363c86e8f7-0-0xffffffffff52d316b7bd028358089bc8066b8f80",
                      "roles": "7719472615821079694904732333912527190217998977709370935963838933860875309329",
                      "user": {
                        "address": "0xffffffffff52d316b7bd028358089bc8066b8f80"
                      }
                    }
                  }
                ]
              }
            }
          }
        ]
      }
    }
  }
}

Output matches a GraphQL Response snapshot; live output depends on your ENSNode instance.

Back to Examples