{"id":31580021,"url":"https://github.com/lit-protocol/vincent-ability-starter-kit","last_synced_at":"2025-10-05T21:05:28.909Z","repository":{"id":317322579,"uuid":"1048702455","full_name":"LIT-Protocol/vincent-ability-starter-kit","owner":"LIT-Protocol","description":"Get started building Vincent Abilities and Policies with a fully functional example repository complete with end-to-end testing.","archived":false,"fork":false,"pushed_at":"2025-09-30T06:21:13.000Z","size":913,"stargazers_count":11,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-30T08:29:06.908Z","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/LIT-Protocol.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"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":"2025-09-01T22:19:54.000Z","updated_at":"2025-09-29T20:42:25.000Z","dependencies_parsed_at":"2025-09-30T08:40:45.507Z","dependency_job_id":null,"html_url":"https://github.com/LIT-Protocol/vincent-ability-starter-kit","commit_stats":null,"previous_names":["lit-protocol/vincent-ability-starter-kit"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/LIT-Protocol/vincent-ability-starter-kit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LIT-Protocol%2Fvincent-ability-starter-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LIT-Protocol%2Fvincent-ability-starter-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LIT-Protocol%2Fvincent-ability-starter-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LIT-Protocol%2Fvincent-ability-starter-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LIT-Protocol","download_url":"https://codeload.github.com/LIT-Protocol/vincent-ability-starter-kit/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LIT-Protocol%2Fvincent-ability-starter-kit/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278518899,"owners_count":26000177,"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-05T02:00:06.059Z","response_time":54,"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":"2025-10-05T21:05:27.719Z","updated_at":"2025-10-05T21:05:28.903Z","avatar_url":"https://github.com/LIT-Protocol.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Vincent Starter Kit\n\nA complete example repository for Vincent Ability and Policy authors. This monorepo uses Nx and pnpm and includes:\n\n- An example Vincent Ability that sends native tokens\n- An example Vincent Policy that counts ability executions\n- End-to-end tests that automatically build, deploy, and exercise the example ability and policy\n\n### See detailed documentation / guides at [docs.heyvincent.ai](https://docs.heyvincent.ai)\n\n## Requirements\n\n- Node.js: ^20.19.4\n- pnpm: 10.7.0 (managed via Corepack)\n\n### Using Corepack to use pnpm\n\nThis repo is configured to use pnpm and enforces it in the preinstall step. If you do not have pnpm set up, use Corepack:\n\n```bash\n# Enable Corepack globally (ships with Node 16.9+)\ncorepack enable\n\n# Ensure npm \u0026 pnpm shims are enabled\ncorepack enable npm\ncorepack enable pnpm\n\n# Or run the helper script from the repo root\npnpm run use-corepack\n```\n\nNotes:\n\n- The repo sets \"packageManager\": \"pnpm@10.7.0\" in package.json. Corepack will automatically provision that version.\n- The preinstall script scripts/check-packagemanager.sh verifies Node and Corepack are available and enforces pnpm via `npx only-allow pnpm`.\n\n## Scripts\n\nRoot-level scripts you will commonly use:\n\n| Script       | What it does                                            | Notes                                                                   |\n| ------------ | ------------------------------------------------------- | ----------------------------------------------------------------------- |\n| preinstall   | Ensures Node + Corepack are available and enforces pnpm | Runs automatically during `pnpm install`                                |\n| build        | nx run-many -t build                                    | Builds all packages (includes action bundling via Nx deps)              |\n| test         | nx run-many -t test                                     | Runs unit tests (if any)                                                |\n| test-e2e     | nx run-many -t test-e2e                                 | Builds + deploys the example Ability \u0026 Policy, then runs Jest E2E tests |\n| reset-e2e    | Moves packages/test-e2e/.env.test-e2e to a .backup file | Useful to re-run bootstrap for a new env                                |\n| lint         | nx run-many -t lint                                     | Lints all packages                                                      |\n| typecheck    | nx run-many -t typecheck                                | Types checks all packages                                               |\n| clean        | nx reset and per-project clean                          | Removes build artifacts and node_modules in projects                    |\n| prepare      | husky                                                   | Git hooks setup                                                         |\n| use-corepack | corepack enable ...                                     | Quickly enables pnpm via Corepack                                       |\n| reset        | pnpm clean \u0026\u0026 pnpm install                              | Full reinstall                                                          |\n| hard-build   | pnpm reset \u0026\u0026 pnpm build                                | Clean reinstall and build                                               |\n| bootstrap    | tsx ./src/bin/bootstrap.ts                              | Interactive environment setup (see Bootstrap flow)                      |\n\nProject-level Nx targets you may find useful (run via pnpm nx ...):\n\n| Target        | Project(s)                          | What it does                                                           |\n| ------------- | ----------------------------------- | ---------------------------------------------------------------------- |\n| action:build  | ability-native-send, policy-counter | Bundles the Lit Action code for the Ability/Policy                     |\n| action:deploy | ability-native-send, policy-counter | Builds (if needed) and deploys the Lit Action code                     |\n| build         | all                                 | TypeScript build (depends on action:build where applicable)            |\n| test-e2e      | test-e2e                            | Depends on deploying both the example Ability \u0026 Policy, then runs Jest |\n\n## Packages in this repository\n\n| Package                                           | Path                         | Purpose                                                                                                                                              |\n| ------------------------------------------------- | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |\n| @lit-protocol/vincent-example-ability-native-send | packages/ability-native-send | An example Vincent Ability that sends native tokens to a user. Demonstrates Ability authoring, bundling, and deployment.                             |\n| @lit-protocol/vincent-example-policy-counter      | packages/policy-counter      | An example Vincent Policy that counts the number of times an Ability is executed. Demonstrates Policy authoring, bundling, and deployment.           |\n| @lit-protocol/vincent-example-e2e                 | packages/test-e2e            | Private package with end-to-end tests. It orchestrates building and deploying the example Ability \u0026 Policy and then runs integration tests via Jest. |\n\n## Bootstrap flow\n\nThe bootstrap script guides you through configuring the repo for the first time and preparing the E2E environment.\n\nCommand:\n\n```bash\npnpm bootstrap\n```\n\nWhat happens:\n\n1. Pinata JWT setup\n   - A Pinata JWT is required for e2e tests and for publishing Vincent Abilities and Policies to the Registry.\n   - You will be prompted to obtain a Pinata JWT from https://app.pinata.cloud/developers/api-keys.\n   - The JWT you provide will be stored in a root-level .env as `PINATA_JWT`. Tooling will use this to authenticate with Pinata.\n   - If you already have a .env file, the script will skip this step.\n2. Funder environment setup for E2E\n   - You must fund a wallet with testLPX on the LIT testnet (Yellowstone). You can fund your wallet using the faucet as https://chronicle-yellowstone-faucet.getlit.dev/\n   - Once you have funded your wallet, you must provide its private key for usage by tooling in the repository.\n   - The bootstrap process creates additional test private keys (app manager, app delegatee, agent wallet PKP owner) and stores those keys in packages/test-e2e/.env.test-e2e\n\nNotes:\n\n- If a root .env already exists, the Pinata JWT step is skipped.\n- If packages/test-e2e/.env.test-e2e already exists, bootstrap aborts with an error so you don’t overwrite your private keys. Use `pnpm reset-e2e` to back up the existing .env.test-e2e file, and re-run bootstrap.\n\n## Quick start\n\nIt is recommended to use Corepack to ensure pnpm is used for the repository's package management. If you use a different package manager, you may experience problematic behavior.\n\n1. Verify your version of corepack and ensure you are on \u003e 0.31.0\n   ```bash\n   corepack -v\n   npm install -g corepack@latest\n   ```\n2. Enable Corepack:\n   ```bash\n   corepack enable \u0026\u0026 corepack enable pnpm\n   ```\n3. Run bootstrap to build and configure the repository :\n   ```bash\n   pnpm bootstrap\n   ```\n4. Run the example end-to-end test flow:\n   ```bash\n   pnpm test-e2e\n   ```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flit-protocol%2Fvincent-ability-starter-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flit-protocol%2Fvincent-ability-starter-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flit-protocol%2Fvincent-ability-starter-kit/lists"}