Skip to content

wraith-protocol/docs

Repository files navigation

Contributing

Thanks for helping improve the Wraith Protocol docs.

Snippet checks

All TypeScript and JavaScript code fences in .mdx files are checked by:

npm run check:snippets

The checker extracts each ts, tsx, typescript, js, and javascript fence, writes it to a temporary file, and runs tsc --noEmit against that snippet. The initial gate is intentionally syntax-focused because many current docs snippets are fragments meant to illustrate API shapes rather than complete programs. It still catches malformed TypeScript and keeps the docs ready for stricter runtime validation over time.

Use no-check only for intentionally illustrative pseudocode:

```typescript no-check
// Pseudocode that is not copy-paste runnable.
```

Prefer making snippets compile over opting them out.

CI

Every pull request runs the snippet checker through GitHub Actions. A separate non-blocking Stellar testnet job is reserved for end-to-end snippet validation that depends on network availability.

About

Wraith is a multichain stealth address platform. Send and receive private payments across EVM chains and Stellar through a single SDK. An AI agent handles chain-specific crypto, key management, and privacy analysis inside Trusted Execution Environment hardware.

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors