@bitsocial/mintpass-challenge

MintPass challenge for pkc-js that verifies users own a MintPass NFT before publishing.

Requirements

• Node.js >=22
• ESM-only environment

Using mintpass in your community

Community owners add the mintpass challenge to their community settings. When enabled, every publication (post, reply, vote) requires the author to own a MintPass NFT. The challenge is published as @bitsocial/mintpass-challenge on npm.

With pkc-js over RPC

If your RPC server is already running, first install the challenge on the server:

bitsocial challenge install @bitsocial/mintpass-challenge

Then from your RPC client, connect and set the challenge on your community by name — no npm install or challenge registration needed on the client side:

import PKC from "@pkcprotocol/pkc-js";

const pkc = await PKC({
  pkcRpcClientsOptions: ["ws://localhost:9138"]
});

const community = await pkc.createCommunity({ address: "your-community-address.bso" });

await community.edit({
  settings: {
    challenges: [
      {
        name: "@bitsocial/mintpass-challenge",
        options: {
          chainTicker: "base",
          contractAddress: "0x13d41d6B8EA5C86096bb7a94C3557FCF184491b9",
          requiredTokenType: "0",
          transferCooldownSeconds: "604800"
        }
      }
    ]
  }
});

With pkc-js (TypeScript)

Install the challenge package:

npm install @bitsocial/mintpass-challenge

Register the challenge and configure your community:

import PKC from '@pkcprotocol/pkc-js'
import { mintpass } from '@bitsocial/mintpass-challenge'

// Register the challenge so it can be referenced by name
PKC.challenges['@bitsocial/mintpass-challenge'] = mintpass

const pkc = await PKC({ /* your pkc options */ })
const community = await pkc.createCommunity({ address: 'your-community.bso' })

await community.edit({
  settings: {
    challenges: [{
      name: '@bitsocial/mintpass-challenge',
      options: {
        chainTicker: 'base',
        contractAddress: '0x13d41d6B8EA5C86096bb7a94C3557FCF184491b9',
        requiredTokenType: '0',
        transferCooldownSeconds: '604800',
      }
    }]
  }
})

Challenge options

All option values must be strings (pkc-js challenge convention).

| Option | Default | Description | |--------|---------|-------------| | chainTicker | "base" | Chain where MintPass contract is deployed | | contractAddress | Known deployment per chain | If omitted and chainTicker is supported, defaults to the known MintPass deployment for that chain | | requiredTokenType | "0" | Required token type (0=SMS, 1=Email, 2+=future methods) | | transferCooldownSeconds | "604800" | Cooldown period after NFT transfer (1 week) | | error | Default message | Custom error message for users without NFT. Use {authorAddress} as a placeholder |

With bitsocial-cli

Install the challenge package:

bitsocial challenge install @bitsocial/mintpass-challenge

Edit your community to use the challenge:

bitsocial community edit your-community.bso \
  '--settings.challenges[0].name' @bitsocial/mintpass-challenge \
  '--settings.challenges[0].options.chainTicker' 'base' \
  '--settings.challenges[0].options.contractAddress' '0x13d41d6B8EA5C86096bb7a94C3557FCF184491b9' \
  '--settings.challenges[0].options.requiredTokenType' '0' \
  '--settings.challenges[0].options.transferCooldownSeconds' '604800'

See the bitsocial-cli documentation for full CLI reference.

Scripts

yarn build
yarn test
yarn clean