{"id":35484199,"url":"https://github.com/openzeppelin/openzeppelin-ui","last_synced_at":"2026-04-07T07:03:08.958Z","repository":{"id":331441322,"uuid":"1126240721","full_name":"OpenZeppelin/openzeppelin-ui","owner":"OpenZeppelin","description":"OpenZeppelin UI - React components and utilities for blockchain applications","archived":false,"fork":false,"pushed_at":"2026-02-15T10:25:52.000Z","size":75159,"stargazers_count":3,"open_issues_count":5,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-15T16:31:34.504Z","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":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OpenZeppelin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":"SECURITY.md","support":null,"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":"2026-01-01T13:21:06.000Z","updated_at":"2026-02-15T10:19:56.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/OpenZeppelin/openzeppelin-ui","commit_stats":null,"previous_names":["openzeppelin/openzeppelin-ui"],"tags_count":32,"template":false,"template_full_name":null,"purl":"pkg:github/OpenZeppelin/openzeppelin-ui","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenZeppelin%2Fopenzeppelin-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenZeppelin%2Fopenzeppelin-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenZeppelin%2Fopenzeppelin-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenZeppelin%2Fopenzeppelin-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OpenZeppelin","download_url":"https://codeload.github.com/OpenZeppelin/openzeppelin-ui/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenZeppelin%2Fopenzeppelin-ui/sbom","scorecard":{"id":1241918,"data":{"date":"2026-01-16T18:43:34Z","repo":{"name":"github.com/OpenZeppelin/openzeppelin-ui","commit":"732688ab00b2b4e1ccac8c2090c86b8fbf67f8a2"},"scorecard":{"version":"v5.3.0","commit":"c22063e786c11f9dd714d777a687ff7c4599b600"},"score":5.1,"checks":[{"name":"Dependency-Update-Tool","score":10,"reason":"update tool detected","details":["Info: detected update tool: Dependabot: .github/dependabot.yml:1","Info: detected update tool: RenovateBot: renovate.json:1"],"documentation":{"short":"Determines if the project uses a dependency update tool.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#dependency-update-tool"}},{"name":"Code-Review","score":0,"reason":"Found 0/9 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"project was created within the last 90 days. Please review its contents carefully","details":["Warn: Repository was created within the last 90 days."],"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Info: jobLevel 'contents' permission set to 'read': .github/workflows/ci.yml:113","Info: jobLevel 'contents' permission set to 'read': .github/workflows/ci.yml:19","Info: jobLevel 'contents' permission set to 'read': .github/workflows/ci.yml:63","Info: jobLevel 'contents' permission set to 'read': .github/workflows/ci.yml:88","Warn: jobLevel 'statuses' permission set to 'write': .github/workflows/cla.yml:23","Warn: jobLevel 'checks' permission set to 'write': .github/workflows/cla.yml:24","Warn: jobLevel 'actions' permission set to 'write': .github/workflows/cla.yml:20","Warn: jobLevel 'contents' permission set to 'write': .github/workflows/cla.yml:21","Info: topLevel 'contents' permission set to 'read': .github/workflows/ci.yml:13","Info: topLevel 'contents' permission set to 'read': .github/workflows/cla.yml:14","Warn: topLevel 'contents' permission set to 'write': .github/workflows/publish.yml:18","Warn: topLevel 'actions' permission set to 'write': .github/workflows/publish.yml:23","Info: topLevel permissions set to 'read-all': .github/workflows/scorecard.yml:18"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#token-permissions"}},{"name":"Security-Policy","score":10,"reason":"security policy file detected","details":["Info: security policy file detected: SECURITY.md:1","Info: Found linked content: SECURITY.md:1","Info: Found disclosure, vulnerability, and/or timelines in security policy: SECURITY.md:1","Info: Found text in security policy: SECURITY.md:1"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#security-policy"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#binary-artifacts"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#packaging"}},{"name":"Pinned-Dependencies","score":10,"reason":"all dependencies are pinned","details":["Info:  14 out of  14 GitHub-owned GitHubAction dependencies pinned","Info:  14 out of  14 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":2,"reason":"badge detected: InProgress","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#cii-best-practices"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: GNU Affero General Public License v3.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":3,"reason":"branch protection is not maximal on development and all release branches","details":["Info: 'allow deletion' disabled on branch 'main'","Info: 'force pushes' disabled on branch 'main'","Warn: 'branch protection settings apply to administrators' is disabled on branch 'main'","Warn: 'stale review dismissal' is disabled on branch 'main'","Warn: branch 'main' does not require approvers","Warn: codeowners review is not required on branch 'main'","Warn: 'last push approval' is disabled on branch 'main'","Warn: no status checks found to merge onto branch 'main'","Info: PRs are required in order to make changes on branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#branch-protection"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":4,"reason":"6 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-qj3p-xc97-xw74","Warn: Project is vulnerable to: GHSA-3gc7-fjrx-p6mg","Warn: Project is vulnerable to: GHSA-848j-6mx2-7j84","Warn: Project is vulnerable to: GHSA-mp2g-9vg9-f4cg","Warn: Project is vulnerable to: GHSA-3vhc-576x-3qv4","Warn: Project is vulnerable to: GHSA-x7hr-w5r2-h6wg"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#vulnerabilities"}},{"name":"Contributors","score":0,"reason":"project has 0 contributing companies or organizations -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project has a set of contributors from multiple organizations (e.g., companies).","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#contributors"}},{"name":"SAST","score":3,"reason":"SAST tool is not run on all commits -- score normalized to 3","details":["Warn: 11 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#sast"}},{"name":"CI-Tests","score":10,"reason":"18 out of 18 merged PRs checked by a CI test -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project runs tests before pull requests are merged.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#ci-tests"}}]},"last_synced_at":"2026-01-18T17:30:15.394Z","repository_id":331441322,"created_at":"2026-01-18T17:30:15.394Z","updated_at":"2026-01-18T17:30:15.394Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29626596,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-19T13:04:20.082Z","status":"ssl_error","status_checked_at":"2026-02-19T13:03:33.775Z","response_time":117,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":"2026-01-03T14:24:05.049Z","updated_at":"2026-04-02T18:28:46.385Z","avatar_url":"https://github.com/OpenZeppelin.png","language":"TypeScript","readme":"# OpenZeppelin UI\n\nA modular React component library for building blockchain transaction interfaces.\n\n[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/OpenZeppelin/openzeppelin-ui/badge)](https://api.securityscorecards.dev/projects/github.com/OpenZeppelin/openzeppelin-ui)\n[![Scorecard supply-chain security](https://github.com/OpenZeppelin/openzeppelin-ui/actions/workflows/scorecard.yml/badge.svg)](https://github.com/OpenZeppelin/openzeppelin-ui/actions/workflows/scorecard.yml)\n[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/11780/badge)](https://www.bestpractices.dev/projects/11780)\n[![CLA Assistant](https://github.com/OpenZeppelin/openzeppelin-ui/actions/workflows/cla.yml/badge.svg)](https://github.com/OpenZeppelin/openzeppelin-ui/actions/workflows/cla.yml)\n[![License: AGPL-3.0](https://img.shields.io/badge/License-AGPL--3.0-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)\n\n## Packages\n\nThis monorepo contains the following packages:\n\n| Package                                              | Description                                 | npm                                                                                                                               |\n| ---------------------------------------------------- | ------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |\n| [@openzeppelin/ui-types](./packages/types)           | Shared TypeScript type definitions          | [![npm](https://img.shields.io/npm/v/@openzeppelin/ui-types.svg)](https://www.npmjs.com/package/@openzeppelin/ui-types)           |\n| [@openzeppelin/ui-utils](./packages/utils)           | Framework-agnostic utility functions        | [![npm](https://img.shields.io/npm/v/@openzeppelin/ui-utils.svg)](https://www.npmjs.com/package/@openzeppelin/ui-utils)           |\n| [@openzeppelin/ui-styles](./packages/styles)         | Centralized styling system (Tailwind CSS 4) | [![npm](https://img.shields.io/npm/v/@openzeppelin/ui-styles.svg)](https://www.npmjs.com/package/@openzeppelin/ui-styles)         |\n| [@openzeppelin/ui-components](./packages/components) | React UI components (shadcn/ui based)       | [![npm](https://img.shields.io/npm/v/@openzeppelin/ui-components.svg)](https://www.npmjs.com/package/@openzeppelin/ui-components) |\n| [@openzeppelin/ui-renderer](./packages/renderer)     | Transaction form rendering engine           | [![npm](https://img.shields.io/npm/v/@openzeppelin/ui-renderer.svg)](https://www.npmjs.com/package/@openzeppelin/ui-renderer)     |\n| [@openzeppelin/ui-react](./packages/react)           | React context providers and hooks           | [![npm](https://img.shields.io/npm/v/@openzeppelin/ui-react.svg)](https://www.npmjs.com/package/@openzeppelin/ui-react)           |\n| [@openzeppelin/ui-storage](./packages/storage)       | IndexedDB storage abstraction (Dexie.js)    | [![npm](https://img.shields.io/npm/v/@openzeppelin/ui-storage.svg)](https://www.npmjs.com/package/@openzeppelin/ui-storage)       |\n\n## Installation\n\nInstall the packages you need:\n\n```bash\n# Core types and utilities\npnpm add @openzeppelin/ui-types @openzeppelin/ui-utils\n\n# UI components\npnpm add @openzeppelin/ui-components @openzeppelin/ui-styles\n\n# Form rendering\npnpm add @openzeppelin/ui-renderer\n\n# React integration\npnpm add @openzeppelin/ui-react\n\n# Storage (optional)\npnpm add @openzeppelin/ui-storage\n```\n\n## Quick Start\n\n### 1. Setup Styles\n\nImport the generated Tailwind wiring in your app's entry CSS. For new or existing consumer apps, the recommended path is to let `oz-ui-dev tailwind fix` create and maintain the managed file for you:\n\n```bash\npnpm add -D @openzeppelin/ui-dev-cli\npnpm exec oz-ui-dev tailwind doctor --project \"$PWD\"\npnpm exec oz-ui-dev tailwind fix --project \"$PWD\"\n```\n\nThat command normalizes your entry stylesheet to import `oz-tailwind.generated.css`, which contains the required Tailwind v4 `@source` directives for OpenZeppelin UI and adapter packages.\n\nIf you need to wire it manually, your entry CSS must explicitly register the OpenZeppelin sources:\n\n```css\n@layer base, components, utilities;\n\n@import 'tailwindcss' source(none);\n@source \"./\";\n@source \"../\";\n@source \"../node_modules/@openzeppelin/ui-components\";\n@source \"../node_modules/@openzeppelin/ui-react\";\n@source \"../node_modules/@openzeppelin/ui-renderer\";\n@source \"../node_modules/@openzeppelin/ui-styles\";\n@source \"../node_modules/@openzeppelin/ui-utils\";\n@import '@openzeppelin/ui-styles/global.css';\n```\n\n### 2. Use Components\n\n```tsx\nimport { useForm } from 'react-hook-form';\n\nimport { Button, TextField } from '@openzeppelin/ui-components';\n\nfunction MyForm() {\n  const { control, handleSubmit } = useForm();\n\n  return (\n    \u003cform onSubmit={handleSubmit(onSubmit)}\u003e\n      \u003cTextField name=\"recipient\" label=\"Recipient Address\" control={control} placeholder=\"0x...\" /\u003e\n      \u003cButton type=\"submit\"\u003eSend Transaction\u003c/Button\u003e\n    \u003c/form\u003e\n  );\n}\n```\n\n### 3. Render Transaction Forms\n\n```tsx\nimport { TransactionForm } from '@openzeppelin/ui-renderer';\nimport type { RenderFormSchema } from '@openzeppelin/ui-types';\n\nconst schema: RenderFormSchema = {\n  id: 'transfer-form',\n  title: 'Transfer Tokens',\n  fields: [\n    { id: 'to', name: 'to', type: 'address', label: 'Recipient' },\n    { id: 'amount', name: 'amount', type: 'amount', label: 'Amount' },\n  ],\n  layout: { columns: 1, spacing: 'normal', labelPosition: 'top' },\n  submitButton: { text: 'Transfer', loadingText: 'Transferring...' },\n};\n\nfunction TransferPage() {\n  return (\n    \u003cTransactionForm\n      schema={schema}\n      adapter={myAdapter}\n      networkConfig={networkConfig}\n      onSubmit={handleSubmit}\n    /\u003e\n  );\n}\n```\n\n## Architecture\n\n| Layer | Package                       | Purpose                      |\n| ----- | ----------------------------- | ---------------------------- |\n| App   | Your Application              | Consumer application         |\n| 7     | `@openzeppelin/ui-storage`    | IndexedDB storage            |\n| 6     | `@openzeppelin/ui-renderer`   | Form \u0026 contract UI rendering |\n| 5     | `@openzeppelin/ui-react`      | Context providers \u0026 hooks    |\n| 4     | `@openzeppelin/ui-components` | UI primitives \u0026 form fields  |\n| 3     | `@openzeppelin/ui-styles`     | Tailwind theme \u0026 variables   |\n| 2     | `@openzeppelin/ui-utils`      | Shared utilities             |\n| 1     | `@openzeppelin/ui-types`      | Type definitions             |\n\n## Requirements\n\n- Node.js \u003e= 20.19.0\n- React 19\n- Tailwind CSS 4\n\n## Development\n\n```bash\n# Install dependencies\npnpm install\n\n# Build all packages\npnpm build\n\n# Run tests\npnpm test\n\n# Lint\npnpm lint\n\n# Type check\npnpm typecheck\n```\n\n## Local Development (Consuming Projects)\n\nThis repo now ships the shared `oz-ui-dev` local-development CLI for OpenZeppelin consumer apps.\n\nExisting first-party consumers such as `ui-builder`, `role-manager`, and `rwa-wizard` already check in the required `.openzeppelin-dev.json`, `.pnpmfile.cjs`, and `dev:local` / `dev:npm` scripts.\n\nFor a new consumer project, install the CLI once like a normal dev tool and then bootstrap the repo:\n\n```bash\npnpm add -D @openzeppelin/ui-dev-cli\npnpm exec oz-ui-dev init --project \"$PWD\" --family ui\n```\n\nThat creates a config-driven `.pnpmfile.cjs`, writes `.openzeppelin-dev.json`, records `@openzeppelin/ui-dev-cli` in `devDependencies`, and adds `dev:local` / `dev:npm` scripts that call `oz-ui-dev` directly. Developers only need local `openzeppelin-ui` or `openzeppelin-adapters` checkouts when they want to test package changes from source.\n\n## Contributing\n\nSee [CONTRIBUTING.md](./CONTRIBUTING.md) for development guidelines.\n\nThis project uses [GitHub Speckit](https://github.com/github/spec-kit) for spec-driven development. Feature specifications, implementation plans, and task breakdowns are managed in the `.specify/` directory.\n\n\u003e **Note**: Even if you're not using Speckit, please read the [project constitution](/.specify/memory/constitution.md) before contributing. It defines the architectural principles and quality standards that all contributions must follow.\n\n## Documentation\n\n- [Migration Guide](./docs/MIGRATION.md) - Migrate from `@openzeppelin/ui-builder-*` packages\n- [DevOps Setup Guide](./docs/DEVOPS_SETUP.md) - CI/CD secrets and GitHub App configuration\n- [Operations Runbook](./docs/RUNBOOK.md) - Release management and incident procedures\n\n## License\n\n[AGPL-3.0](./LICENSE)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenzeppelin%2Fopenzeppelin-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenzeppelin%2Fopenzeppelin-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenzeppelin%2Fopenzeppelin-ui/lists"}