Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 5 additions & 18 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,21 +1,8 @@
MIT License
MintPass is a mixed-license monorepo for the public, open-source MintPass packages.

Copyright (c) 2025 Bitsocial
The controlling license depends on the package you are using:

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
- `challenge` (`@bitsocial/mintpass-challenge`): `GPL-3.0-or-later`. See `challenge/LICENSE`.
- `contracts` (`@bitsocial/mintpass-contracts`): `MIT`. See `contracts/LICENSE`.

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
The hosted MintPass web app (the SMS-OTP and minting service for mintpass.org) is proprietary and maintained separately in a private repository; it is not included here. Unless a subdirectory says otherwise, root workspace files are provided for monorepo development only and are not offered as a separate redistributable package.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ MintPass integrates as a challenge so Bitsocial communities can distinguish real
mintpass/
├── contracts/ # MintPassV1 smart contract and tooling
├── challenge/ # Bitsocial challenge implementation (“mintpass”)
├── web/ # Next.js website + API (mintpass.org)
├── docs/ # Documentation and specifications
├── tests/ # Cross‑component integration tests
└── scripts/ # Deployment and utilities
Expand All @@ -42,7 +41,7 @@ mintpass/

- `contracts/`: Solidity contracts (MintPassV1). Versioned, role‑based minting, token types per NFT (type 0 = SMS). See `contracts/README.md`.
- `challenge/`: The Bitsocial challenge that checks for a MintPass NFT and applies additional rules (e.g., transfer cooldowns) to resist sybils.
- `web/`: The user‑facing site and serverless backend. Sends SMS codes, verifies OTP, and mints or records successful verification. See `web/README.md`.
- The hosted MintPass web app (the `mintpass.org` site + SMS-OTP / minting API) is **proprietary** and maintained in a separate private repository; it is not part of this public monorepo.

## Privacy and anti‑sybil design (high level)

Expand All @@ -59,7 +58,6 @@ mintpass/

- Contracts: `cd contracts && yarn install && yarn test`
- Challenge: `cd challenge && yarn install && yarn test`
- Web: `cd web && yarn install && yarn dev` then open `https://mintpass.localhost/request`

## Using MintPass in your community

Expand Down Expand Up @@ -195,6 +193,9 @@ These items are exploratory; concrete work will land incrementally and stay conf

## License

MIT License — see [LICENSE](LICENSE).
MintPass is a mixed-license monorepo — see [LICENSE](LICENSE):

Open source and commercial‑friendly. A hosted version is available at [mintpass.org](https://mintpass.org).
- `challenge/` (`@bitsocial/mintpass-challenge`): GPL-3.0-or-later
- `contracts/` (`@bitsocial/mintpass-contracts`): MIT

The hosted MintPass web app is proprietary and maintained in a separate private repository. A hosted version is available at [mintpass.org](https://mintpass.org).
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"type": "module",
"description": "NFT-based authentication system for PKC communities",
"author": "Bitsocial",
"license": "MIT",
"license": "UNLICENSED",
"exports": {
"./challenge": {
"types": "./dist/challenge/index.d.ts",
Expand Down
7 changes: 3 additions & 4 deletions scripts/llms-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,22 @@
"repoUrl": "https://github.com/bitsocialnet/mintpass",
"llmsUrl": "https://mintpass.org/llms.txt",
"llmsFullUrl": "https://mintpass.org/llms-full.txt",
"shortOutputs": ["llms.txt", "web/public/llms.txt"],
"fullOutputs": ["llms-full.txt", "web/public/llms-full.txt"],
"shortOutputs": ["llms.txt"],
"fullOutputs": ["llms-full.txt"],
"links": [
["Website", "https://mintpass.org"],
["Repository", "https://github.com/bitsocialnet/mintpass"],
["Challenge package", "https://www.npmjs.com/package/@bitsocial/mintpass-challenge"],
["Bitsocial protocol", "https://bitsocial.net"]
],
"notes": [
"This is a multi-project repo: web, contracts, challenge, docs, and generated challenge artifacts.",
"This is a multi-project repo: contracts, challenge, docs, and generated challenge artifacts.",
"Secrets and private deployment values belong in environment variables or private operator files, never in committed docs.",
"Generated llms files are compiled context for AI contributors and deployed site readers; verify behavior against source."
],
"docs": [
"README.md",
"AGENTS.md",
"web/README.md",
"challenge/README.md",
"contracts/README.md",
"docs/pkc-info.md",
Expand Down
36 changes: 0 additions & 36 deletions web/.env.example

This file was deleted.

42 changes: 0 additions & 42 deletions web/.gitignore

This file was deleted.

1 change: 0 additions & 1 deletion web/.yarnrc.yml

This file was deleted.

178 changes: 0 additions & 178 deletions web/README.md

This file was deleted.

32 changes: 0 additions & 32 deletions web/components.json

This file was deleted.

3 changes: 0 additions & 3 deletions web/eslint.config.mjs

This file was deleted.

Loading