https://github.com/boopi7/tipjar_plugin_package
https://github.com/boopi7/tipjar_plugin_package
Last synced: about 16 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/boopi7/tipjar_plugin_package
- Owner: Boopi7
- Created: 2025-10-28T14:42:46.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-10-28T14:43:46.000Z (9 months ago)
- Last Synced: 2026-02-17T20:51:45.838Z (5 months ago)
- Language: JavaScript
- Size: 49.8 KB
- Stars: 7
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
TipJar Plugin - Package (ARC-0058 compatible)
Contents:
- tipjar_plugin.algo.ts : TypeScript ARC4 contract skeleton (plugin)
- deploy_tipjar.js : Deployment template script (Node.js / algosdk)
- integration_example.md : Step-by-step integration flow with AbstractedAccount (ARC-0058)
- frontend_hook.js : Frontend snippet template for creating atomic group and invoking tip
Step-by-step (high-level):
1) Compile contract
- Use the ARC4 / algorand-typescript toolchain to compile TypeScript contract to TEAL.
- Example: arc4 compile ./tipjar_plugin.algo.ts -> outputs approval.teal & clear.teal
2) Deploy plugin contract to TestNet
- Use algosdk or Algorand tooling (algob/algokit) to deploy approval.teal & clear.teal as an Application.
3) Register plugin with AbstractedAccount
- Call arc58_addPlugin on the AbstractedAccount instance with plugin app ID, allowed caller, methods, cooldowns, and escrow info.
4) Invoke tip flow from frontend
- Construct atomic group: arc58_rekeyToPlugin -> TipJarPlugin.executeTip -> arc58_verifyAuthAddr
5) Testing checklist
- Verify rekey flash flows, enforce allowance rules, test asset transfers and fee splits, test insufficient balance scenarios.
Files exported in this package are templates — adjust them to match your deployment toolchain (algob, algokit, arc4 compiler).