|
| 1 | +# Quick Start Guide |
| 2 | + |
| 3 | +Get started with the acta.build verifiable credentials skill in 5 minutes. |
| 4 | + |
| 5 | +## 1. Install the Skill |
| 6 | + |
| 7 | +```bash |
| 8 | +# From the skill directory |
| 9 | +npx skills add . |
| 10 | + |
| 11 | +# Or from GitHub (when published) |
| 12 | +npx skills add wlademyr/acta-skill |
| 13 | +``` |
| 14 | + |
| 15 | +## 2. Test Helper Scripts |
| 16 | + |
| 17 | +Verify your API connection: |
| 18 | + |
| 19 | +```bash |
| 20 | +npm run test:api |
| 21 | +``` |
| 22 | + |
| 23 | +Validate credential templates: |
| 24 | + |
| 25 | +```bash |
| 26 | +npm run validate:education |
| 27 | +npm run validate:employment |
| 28 | +npm run validate:identity |
| 29 | +``` |
| 30 | + |
| 31 | +## 3. Invoke the Skill |
| 32 | + |
| 33 | +In Claude Code: |
| 34 | + |
| 35 | +``` |
| 36 | +$acta help me set up my first credential vault |
| 37 | +``` |
| 38 | + |
| 39 | +Or implicitly: |
| 40 | + |
| 41 | +``` |
| 42 | +I want to issue a verifiable credential for education |
| 43 | +``` |
| 44 | + |
| 45 | +## 4. Common Tasks |
| 46 | + |
| 47 | +### Issue a Credential |
| 48 | + |
| 49 | +``` |
| 50 | +$acta help me issue an education credential |
| 51 | +``` |
| 52 | + |
| 53 | +The skill will: |
| 54 | +- Check your setup (API key, wallet) |
| 55 | +- Show you the credential template |
| 56 | +- Guide you through the issuance process |
| 57 | +- Provide safety confirmations |
| 58 | + |
| 59 | +### Verify a Credential |
| 60 | + |
| 61 | +``` |
| 62 | +$acta verify this credential: vc:education:degree:12345 |
| 63 | +``` |
| 64 | + |
| 65 | +The skill will: |
| 66 | +- Read the credential from the vault |
| 67 | +- Check validity and issuer authorization |
| 68 | +- Display credential details |
| 69 | + |
| 70 | +### Set Up a Vault |
| 71 | + |
| 72 | +``` |
| 73 | +$acta create a vault for my wallet |
| 74 | +``` |
| 75 | + |
| 76 | +The skill will: |
| 77 | +- Connect to Freighter wallet |
| 78 | +- Create vault with your DID |
| 79 | +- Confirm successful creation |
| 80 | + |
| 81 | +## 5. Prerequisites Checklist |
| 82 | + |
| 83 | +Before using the skill, ensure you have: |
| 84 | + |
| 85 | +- [ ] **API Key** from https://dapp.acta.build |
| 86 | +- [ ] **Freighter Wallet** installed and configured for testnet |
| 87 | +- [ ] **API Key in .env.local**: |
| 88 | + ``` |
| 89 | + ACTA_API_KEY_TESTNET=your_api_key_here |
| 90 | + ``` |
| 91 | +- [ ] **.env.local in .gitignore** (protect your API key!) |
| 92 | +- [ ] **Testnet XLM** funded wallet (free from Stellar Laboratory) |
| 93 | + |
| 94 | +## 6. File Structure |
| 95 | + |
| 96 | +``` |
| 97 | +acta-skill/ |
| 98 | +├── SKILL.md # Main skill definition (read first!) |
| 99 | +├── README.md # Installation guide |
| 100 | +├── QUICKSTART.md # This file |
| 101 | +├── references/ # Detailed documentation |
| 102 | +│ ├── platform-overview.md |
| 103 | +│ ├── react-sdk-reference.md |
| 104 | +│ ├── credential-lifecycle.md |
| 105 | +│ ├── vault-management.md |
| 106 | +│ └── security-best-practices.md |
| 107 | +├── assets/ |
| 108 | +│ ├── credential-templates/ # JSON templates |
| 109 | +│ └── examples/ # React components |
| 110 | +└── scripts/ # Helper utilities |
| 111 | + ├── test-api-connection.js |
| 112 | + └── validate-credential.js |
| 113 | +``` |
| 114 | + |
| 115 | +## 7. Safety First |
| 116 | + |
| 117 | +The skill follows these safety principles: |
| 118 | + |
| 119 | +⚠️ **Mandatory Confirmations** |
| 120 | +- All credential operations require explicit approval |
| 121 | +- Vault creation requires confirmation |
| 122 | +- Issuer revocation requires typing "REVOKE" |
| 123 | + |
| 124 | +🔐 **Security Best Practices** |
| 125 | +- API keys never in code |
| 126 | +- Private keys stay in wallet |
| 127 | +- Testnet default for development |
| 128 | + |
| 129 | +🛡️ **Immutability Warnings** |
| 130 | +- Credentials cannot be deleted |
| 131 | +- Users must understand permanence |
| 132 | +- Clear consequences explained |
| 133 | + |
| 134 | +## 8. Example Workflows |
| 135 | + |
| 136 | +### Complete Setup (First Time) |
| 137 | + |
| 138 | +``` |
| 139 | +$acta I'm new to verifiable credentials, help me get started |
| 140 | +``` |
| 141 | + |
| 142 | +1. Skill checks prerequisites |
| 143 | +2. Guides you to obtain API key |
| 144 | +3. Helps configure environment |
| 145 | +4. Creates vault |
| 146 | +5. Issues first credential |
| 147 | + |
| 148 | +### Issue Employment Credential |
| 149 | + |
| 150 | +``` |
| 151 | +$acta issue an employment verification credential |
| 152 | +``` |
| 153 | + |
| 154 | +1. Skill loads employment template |
| 155 | +2. Prompts for job details |
| 156 | +3. Shows confirmation dialog |
| 157 | +4. Signs with Freighter |
| 158 | +5. Returns credential ID |
| 159 | + |
| 160 | +### Verify Someone's Credential |
| 161 | + |
| 162 | +``` |
| 163 | +$acta verify credential vc:education:degree:xyz from wallet GXXXXX |
| 164 | +``` |
| 165 | + |
| 166 | +1. Skill queries vault |
| 167 | +2. Checks issuer authorization |
| 168 | +3. Validates signatures |
| 169 | +4. Displays credential data |
| 170 | + |
| 171 | +## 9. Troubleshooting |
| 172 | + |
| 173 | +**"API key not found"** |
| 174 | +- Create `.env.local` file |
| 175 | +- Add `ACTA_API_KEY_TESTNET=your_key` |
| 176 | +- Restart your application |
| 177 | + |
| 178 | +**"Vault not found"** |
| 179 | +- Create vault first with `$acta create vault` |
| 180 | +- Check you're using correct wallet address |
| 181 | + |
| 182 | +**"Issuer not authorized"** |
| 183 | +- Authorize issuer with `$acta authorize issuer GXXXXX` |
| 184 | +- Confirm authorization completed |
| 185 | + |
| 186 | +**"Insufficient balance"** |
| 187 | +- Fund testnet wallet: https://laboratory.stellar.org/#account-creator?network=test |
| 188 | +- Mainnet: Add real XLM |
| 189 | + |
| 190 | +## 10. Next Steps |
| 191 | + |
| 192 | +- Read `SKILL.md` for complete workflow |
| 193 | +- Explore `references/` for detailed documentation |
| 194 | +- Try example React components in `assets/examples/` |
| 195 | +- Join Discord: https://discord.gg/DsUSE3aMDZ |
| 196 | + |
| 197 | +## Resources |
| 198 | + |
| 199 | +- **Website:** https://acta.build |
| 200 | +- **Documentation:** https://docs.acta.build |
| 201 | +- **dApp:** https://dapp.acta.build |
| 202 | +- **GitHub:** https://github.com/ACTA-Team |
| 203 | +- **Discord:** https://discord.gg/DsUSE3aMDZ |
| 204 | + |
| 205 | +--- |
| 206 | + |
| 207 | +**Need help?** Ask in the skill: |
| 208 | + |
| 209 | +``` |
| 210 | +$acta I'm stuck with [your issue] |
| 211 | +``` |
| 212 | + |
| 213 | +The skill will guide you through troubleshooting! |
0 commit comments