Skip to content

cotitech-io/coti-pod-sdk

Repository files navigation

@coti/pod-sdk

SDK for building privacy dApps on EVM with COTI Privacy on Demand (PoD): Solidity contracts, async Inbox messaging patterns, and TypeScript crypto helpers.

Install

From npm (when published):

npm install @coti/pod-sdk

From GitHub:

npm install github:cotitech-io/coti-pod-sdk

The package builds automatically on install (prepare script).

Documentation

Production documentation lives in /docs:

  • /docs/README.md (documentation index)
  • /docs/01-privacy-decentralized-apps-on-any-evm-chain-with-coti-pod.md
  • /docs/02-showcase.md
  • /docs/03-features.md
  • /docs/04-getting-started.md
  • /docs/05-writing-privacy-contracts-on-ethereum.md
  • /docs/05a-async-execution.md
  • /docs/05b-multi-party-computing-library-mpclib.md
  • /docs/05c-examples-with-description.md
  • /docs/06-typescript-integration-ux-development.md
  • /docs/06a-coti-typescript-sdk.md
  • /docs/06b-encrypt-decrypt.md
  • /docs/06c-onboarding-account-account-aes-key.md
  • /docs/contracts/01-it-ct-gt-data-types.md
  • /docs/contracts/02-contract-patterns-and-checklist.md
  • /docs/contracts/03-request-builder-and-remote-calls.md

MkDocs setup lives in /docs:

  • Config: /docs/mkdocs.yml
  • Dependencies: /docs/requirements.txt
  • Commands: /docs/Makefile (make install, make serve, make build)

From repo root:

  • npm run docs:install
  • npm run docs:serve
  • npm run docs:build

Current version

0.1.0

About

Contracts, SDK, and Documentation for Coti PoD

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors