{"id":19107439,"url":"https://github.com/smartcontractkit/operator-ui","last_synced_at":"2025-10-25T13:46:28.765Z","repository":{"id":58479228,"uuid":"532109437","full_name":"smartcontractkit/operator-ui","owner":"smartcontractkit","description":null,"archived":false,"fork":false,"pushed_at":"2025-09-29T22:20:02.000Z","size":3010,"stargazers_count":13,"open_issues_count":2,"forks_count":9,"subscribers_count":12,"default_branch":"main","last_synced_at":"2025-10-09T08:51:44.967Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/smartcontractkit.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":"support/factories/gql/fetchAccountBalances.ts","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-09-02T23:51:45.000Z","updated_at":"2025-09-29T10:43:27.000Z","dependencies_parsed_at":"2024-05-03T18:27:35.692Z","dependency_job_id":"5d14a094-e599-45b7-aa8f-e38667308d6c","html_url":"https://github.com/smartcontractkit/operator-ui","commit_stats":null,"previous_names":[],"tags_count":99,"template":false,"template_full_name":null,"purl":"pkg:github/smartcontractkit/operator-ui","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartcontractkit%2Foperator-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartcontractkit%2Foperator-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartcontractkit%2Foperator-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartcontractkit%2Foperator-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/smartcontractkit","download_url":"https://codeload.github.com/smartcontractkit/operator-ui/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartcontractkit%2Foperator-ui/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280965074,"owners_count":26421548,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-25T02:00:06.499Z","response_time":81,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T04:12:39.539Z","updated_at":"2025-10-25T13:46:28.745Z","avatar_url":"https://github.com/smartcontractkit.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Operator UI\n\nThis package is responsible for rendering the UI of the chainlink node, which allows interactions with node jobs, jobs runs, configuration and any other related tasks.\n\n## Setup\n\nThe GQL schema that lives within `smartcontractkit/chainlink` is used to generate client typings for this repo. See below for a list of options for generating these bindings, either based on a local chainlink repo copy, or remotely off of github.\n\n```sh\n# Assuming that your chainlink repo lives in ../chainlink (relative to this git repo root)\nyarn setup\n\n# If you have your chainlink repo in a different directory\nREPO_PATH=\"$HOME/src/smartcontractkit/chainlink\" yarn setup\n\n# If you want to fetch the schema files from github instead, from the develop branch\n# Note that you need to supply $GH_TOKEN, this is a PAT that needs read access to the\n# smartcontractkit/chainlink repo.\nGH_TOKEN=$GH_TOKEN yarn setup\n\n# If you want a different branch than develop on the smartcontractkit/chainlink repo\nGH_TOKEN=$GH_TOKEN REPO_REF=\"feature/gql_changes\" yarn setup\n```\n\n## Running Chainlink Node\n\nAssuming you already have a local chainlink node listening on port 6688, run:\n\n```\nCHAINLINK_BASEURL=http://localhost:6688 yarn start\n```\n\nNow navigate to http://localhost:3000.\n\nIf sign-in doesn't work, check your network console, it's probably a CORS issue. You may need to run your chainlink node with `[WebServer] AllowOrigins=http://localhost:3000` set in TOML config.\n\n## Running Tests\n\n```\nyarn test\n```\n\n## Contributing\n\n### Versioning\n\nIf your PR creates changes to the operator-ui itself, rather than tests, pipeline changes, etc. Then please create a changeset so that a new release is created, and the changelog is updated. See: https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md#what-is-a-changeset\n\n### If your PR contains GQL Schema Changes\n\nIf your work also involves a modified schema, that means that you have a linked PR open in the `smartcontractkit/chainlink` repo. The way the status checks are setup in both repositories means that there are the following schema enforcements:\n\n#### Chainlink\n\n- A schema change must never be a breaking change\n\n#### Operator UI\n\n- All PR's have their schema's referenced against the `develop` branch of `smartcontractkit/chainlink`\n\nGiven these constraints, the workflow would look like the following:\n\n1. Make changes to the schema, using `yarn setup` to use the local schema to test your changes\n2. After the schema changes are satisfactory, and the resolver changes are implemented, open a PR for these changes in `smartcontractkit/chainlink`\n3. Open a PR for the frontend changes that use the modified schema in `smartcontractkit/operator-ui`, CI should fail since the schema changes in #2 have not been merged to develop yet.\n4. Merge the PR created in #2\n5. CI should now pass for the PR created in #3\n6. Merge in the PR created in #3\n7. An automated pull requested would have been created within `smartcontractkit/chainlink` to update to the just-released version of Operator UI.\n8. Merge the aforementioned PR in.\n\n#### Referencing new Job Spec GQL Schema Fields\n\nNote that while the GQL schema in Chainlink itself may be updated, that change is not immediately reflected in\nOperator UI even after running `yarn setup`. In order to use newly added fields to a particular GQL type,\none must update the corresponding `JOB_PAYLOAD__SPEC` object appropriately.\n\nFor example, if you added a field named `blahNewField` to the `DirectRequestSpec` type in the GQL schema,\nupdate the GQL as follows in `JobView.tsx`:\n\n```ts\nconst JOB_PAYLOAD__SPEC = gql`\n  fragment JobPayload_Spec on JobSpec {\n    ... on CronSpec {\n      schedule\n    }\n    ... on DirectRequestSpec {\n      contractAddress\n      evmChainID\n      minIncomingConfirmations\n      minIncomingConfirmationsEnv\n      minContractPaymentLinkJuels\n      requesters\n      blahNewField # NEW FIELD HERE!\n    }\n    # ...\n`\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmartcontractkit%2Foperator-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmartcontractkit%2Foperator-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmartcontractkit%2Foperator-ui/lists"}