Quick Start

git clone git@github.com:LIT-Protocol/vincent-ability-starter-kit.git
cd vincent-ability-starter-kit

# Verify your corepack version (should be > 0.31.0)
corepack -v

# If needed, update corepack to the latest version
npm install -g corepack@latest

# Enable Corepack globally
corepack enable

corepack enable pnpm
pnpm bootstrap

pnpm test-e2e

# Replace 'my-policy' with your desired package name
mkdir -p packages/my-policy
rsync -a --exclude='node_modules/' --exclude='dist/' \
  packages/policy-counter/ packages/my-policy/

{
  "name": "@your-org/my-policy",
  "version": "0.0.1",
  "description": "Your policy description here"
}

module.exports = {
  displayName: '@your-org/my-policy', // Update this
  // ... rest of config
};

{
  "release": {
    "projects": ["ability-native-send", "policy-counter", "test-e2e", "my-policy"]
  }
}

export const vincentPolicy = createVincentPolicy({
  packageName: '@your-org/my-policy',

  // There are other configurations here, not covered in the Quick Start.
  // Please read the other guides for more details.

  // Schemas for parameters and results
  abilityParamsSchema,
  userParamsSchema,
  commitParamsSchema,

  // Local validation - runs before execution
  precheck: async ({ abilityParams, userParams }, { allow, deny }) => {
    // Validate parameters and current state
    if (/* validation passes */) {
      return allow({ /* validation data */ });
    }
    return deny({ reason: 'Validation failed' });
  },

  // Evaluation - runs in Lit Action environment
  evaluate: async ({ abilityParams, userParams }, { allow, deny }) => {
    // Check policy state and determine if execution allowed
    if (/* policy allows execution */) {
      return allow({ /* evaluation data */ });
    }
    return deny({ reason: 'Policy denied execution' });
  },

  // State update - runs after successful execution
  commit: async (commitParams, { allow, deny }) => {
    // Update policy state
    return allow({ /* commit success data */ });
  },
});

{
  "jsonSchema": {
    "type": "object",
    "properties": {
      "maxAmount": {
        "type": "number",
        "title": "Maximum Amount",
        "description": "Maximum amount allowed per transaction"
      }
    }
  },
  "uiSchema": {
    "maxAmount": {
      "ui:placeholder": "Enter maximum amount"
    }
  }
}

pnpm install
pnpm nx build my-policy
pnpm test-e2e

pnpm nx action:deploy my-policy

cd packages/my-policy
pnpm publish