@lit-protocol/vincent-policy-send-counter 0.0.4-mma

package/CONTRIBUTING.md

@@ -0,0 +1,89 @@
+# Contributing to Vincent Policy Send Counter
+
+This document provides guidelines for contributing to the Vincent Policy Send Counter project.
+
+## Overview
+
+The Vincent Policy Send Counter is a policy that can be attached to tools to avoid them spending more than a user-defined limit in a specific period of time. It's part of the Vincent Tools ecosystem and is built using the Vincent Tool SDK.
+
+## Setup
+
+1. Follow the global setup instructions in the repository root [CONTRIBUTING.md](../../../CONTRIBUTING.md).
+2. Install dependencies:
+   ```bash
+   pnpm install
+   ```
+
+## Development Workflow
+
+### Testing
+
+Run tests:
+
+```bash
+nx test policy-spending-limit
+```
+
+### Building the Lit Action
+
+Build the policy:
+
+```bash
+nx action:build policy-spending-limit
+```
+
+### Deploying the Lit Action to IPFS
+
+Building will be done automatically. Deploy the policy:
+
+```bash
+nx action:deploy policy-spending-limit
+```
+
+## Project Structure
+
+- `src/`: Source code
+  - `index.ts`: Main entry point
+
+## Policy Development Guidelines
+
+1. Use the Vincent Tool SDK to create policies
+2. Define clear schemas for tool parameters and user parameters
+3. Implement the policy lifecycle methods (evaluate, commit)
+4. Handle errors gracefully
+5. Write comprehensive tests for all functionality
+6. Document the policy's purpose and usage
+
+## Integration with Tools
+
+This policy can be integrated with various Vincent Tools to enforce sending limits. When developing or modifying the policy, consider how it will be used by tools such as:
+
+- Vincent Tool ERC20 Approval
+- Vincent Tool Uniswap Swap
+
+## Testing
+
+Write unit tests for all functionality:
+
+```bash
+pnpm test
+```
+
+## Documentation
+
+- Document the policy's purpose and usage
+- Update README.md when adding new features
+- Document the policy's parameters and behavior
+
+## Pull Request Process
+
+1. Ensure your code follows the coding standards
+2. Update documentation if necessary
+3. Include tests for new functionality
+4. Link any related issues in your pull request description
+5. Request a review from a maintainer
+
+## Additional Resources
+
+- [Vincent Documentation](https://docs.heyvincent.ai/)
+- [Vincent Tool SDK Documentation](../../libs/tool-sdk/README.md)

package/README.md

@@ -0,0 +1,71 @@
+# Vincent Policy Send Counter
+
+A policy that can be attached to Vincent tools to limit the number of transactions that can be sent within a specific time period.
+
+## Overview
+
+The Vincent Policy Send Counter is part of the Vincent Tools ecosystem and is built using the Vincent Tool SDK. It allows users to set transaction count limits for tools, providing an additional layer of security and control.
+
+## Features
+
+- Set maximum transaction limits per time period
+- Track transaction counts across multiple tools
+- Configurable by users through the Vincent Dashboard
+
+## Installation
+
+```bash
+npm install @lit-protocol/vincent-policy-send-counter
+```
+
+## Usage
+
+This policy can be integrated with Vincent Tools to enforce transaction count limits:
+
+```typescript
+import {
+  createVincentToolPolicy,
+  createVincentTool,
+  supportedPoliciesForTool,
+} from '@lit-protocol/vincent-tool-sdk';
+import { bundledVincentPolicy } from '@lit-protocol/vincent-policy-send-counter';
+
+const toolParamsSchema = z.object({
+  // Your tool's parameter schema
+});
+
+const sendCounterPolicy = createVincentToolPolicy({
+  toolParamsSchema,
+  bundledVincentPolicy,
+  // Map your tool's parameters to the policy's expected parameters if needed
+  toolParameterMappings: {
+    /* your parameter mappings */
+  },
+});
+
+export const myTool = createVincentTool({
+  toolParamsSchema,
+  supportedPolicies: supportedPoliciesForTool([sendCounterPolicy]),
+  // ... rest of tool implementation
+});
+```
+
+## Building
+
+```bash
+nx build policy-send-counter
+```
+
+## Running Tests
+
+```bash
+nx test policy-send-counter
+```
+
+## Contributing
+
+Please see [CONTRIBUTING.md](../../CONTRIBUTING.md) for guidelines on how to contribute to this project.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](../../LICENSE) file for details.

package/dist/CONTRIBUTING.md

@@ -0,0 +1,89 @@
+# Contributing to Vincent Policy Send Counter
+
+This document provides guidelines for contributing to the Vincent Policy Send Counter project.
+
+## Overview
+
+The Vincent Policy Send Counter is a policy that can be attached to tools to avoid them spending more than a user-defined limit in a specific period of time. It's part of the Vincent Tools ecosystem and is built using the Vincent Tool SDK.
+
+## Setup
+
+1. Follow the global setup instructions in the repository root [CONTRIBUTING.md](../../../CONTRIBUTING.md).
+2. Install dependencies:
+   ```bash
+   pnpm install
+   ```
+
+## Development Workflow
+
+### Testing
+
+Run tests:
+
+```bash
+nx test policy-spending-limit
+```
+
+### Building the Lit Action
+
+Build the policy:
+
+```bash
+nx action:build policy-spending-limit
+```
+
+### Deploying the Lit Action to IPFS
+
+Building will be done automatically. Deploy the policy:
+
+```bash
+nx action:deploy policy-spending-limit
+```
+
+## Project Structure
+
+- `src/`: Source code
+  - `index.ts`: Main entry point
+
+## Policy Development Guidelines
+
+1. Use the Vincent Tool SDK to create policies
+2. Define clear schemas for tool parameters and user parameters
+3. Implement the policy lifecycle methods (evaluate, commit)
+4. Handle errors gracefully
+5. Write comprehensive tests for all functionality
+6. Document the policy's purpose and usage
+
+## Integration with Tools
+
+This policy can be integrated with various Vincent Tools to enforce sending limits. When developing or modifying the policy, consider how it will be used by tools such as:
+
+- Vincent Tool ERC20 Approval
+- Vincent Tool Uniswap Swap
+
+## Testing
+
+Write unit tests for all functionality:
+
+```bash
+pnpm test
+```
+
+## Documentation
+
+- Document the policy's purpose and usage
+- Update README.md when adding new features
+- Document the policy's parameters and behavior
+
+## Pull Request Process
+
+1. Ensure your code follows the coding standards
+2. Update documentation if necessary
+3. Include tests for new functionality
+4. Link any related issues in your pull request description
+5. Request a review from a maintainer
+
+## Additional Resources
+
+- [Vincent Documentation](https://docs.heyvincent.ai/)
+- [Vincent Tool SDK Documentation](../../libs/tool-sdk/README.md)

package/dist/README.md

@@ -0,0 +1,71 @@
+# Vincent Policy Send Counter
+
+A policy that can be attached to Vincent tools to limit the number of transactions that can be sent within a specific time period.
+
+## Overview
+
+The Vincent Policy Send Counter is part of the Vincent Tools ecosystem and is built using the Vincent Tool SDK. It allows users to set transaction count limits for tools, providing an additional layer of security and control.
+
+## Features
+
+- Set maximum transaction limits per time period
+- Track transaction counts across multiple tools
+- Configurable by users through the Vincent Dashboard
+
+## Installation
+
+```bash
+npm install @lit-protocol/vincent-policy-send-counter
+```
+
+## Usage
+
+This policy can be integrated with Vincent Tools to enforce transaction count limits:
+
+```typescript
+import {
+  createVincentToolPolicy,
+  createVincentTool,
+  supportedPoliciesForTool,
+} from '@lit-protocol/vincent-tool-sdk';
+import { bundledVincentPolicy } from '@lit-protocol/vincent-policy-send-counter';
+
+const toolParamsSchema = z.object({
+  // Your tool's parameter schema
+});
+
+const sendCounterPolicy = createVincentToolPolicy({
+  toolParamsSchema,
+  bundledVincentPolicy,
+  // Map your tool's parameters to the policy's expected parameters if needed
+  toolParameterMappings: {
+    /* your parameter mappings */
+  },
+});
+
+export const myTool = createVincentTool({
+  toolParamsSchema,
+  supportedPolicies: supportedPoliciesForTool([sendCounterPolicy]),
+  // ... rest of tool implementation
+});
+```
+
+## Building
+
+```bash
+nx build policy-send-counter
+```
+
+## Running Tests
+
+```bash
+nx test policy-send-counter
+```
+
+## Contributing
+
+Please see [CONTRIBUTING.md](../../CONTRIBUTING.md) for guidelines on how to contribute to this project.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](../../LICENSE) file for details.

package/dist/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@lit-protocol/vincent-policy-send-counter",
+  "version": "0.0.1",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@lit-protocol/vincent-tool-sdk": "workspace:*",
+    "@uniswap/sdk-core": "^7.7.2",
+    "ethers": "^5.8.0",
+    "tslib": "2.8.1",
+    "zod": "^3.25.64"
+  },
+  "peerDependencies": {
+    "@lit-protocol/vincent-app-sdk": "workspace:^"
+  },
+  "devDependencies": {
+    "esbuild": "^0.19.12",
+    "esbuild-plugin-polyfill-node": "^0.3.0",
+    "ipfs-only-hash": "^4.0.0"
+  },
+  "main": "./dist/src/index.js",
+  "module": "./dist/src/index.js",
+  "types": "./dist/src/index.d.ts",
+  "files": [
+    "dist/**",
+    "*.md"
+  ],
+  "type": "commonjs"
+}