Skip to content

docs: update TypeScript SDK documentation#10

Open
plucena-coti wants to merge 1 commit intocoti-io:mainfrom
plucena-coti:feat/typescript-sdk-docs
Open

docs: update TypeScript SDK documentation#10
plucena-coti wants to merge 1 commit intocoti-io:mainfrom
plucena-coti:feat/typescript-sdk-docs

Conversation

@plucena-coti
Copy link

Summary

Updated build-on-coti/tools/typescript-sdk.md with the following improvements:

  • Expanded Function Documentation: Added detailed parameter descriptions and return values for key functions including encrypt, decrypt, generateRSAKeyPair, decryptRSA, sign, and recoverUserKey.
  • Added Optimization Note: Included a specific note for buildInputText regarding its optimization for 64-bit integers.
  • Merged Intro: Consolidated redundant introductory paragraphs into a cohesive overview.
  • Added Features & Data Types: Introduced clear sections for Features and Data Types with a table explaining it (Input Text) and ct (Ciphertext).
  • Modernized Formatting: Improved readability with consistent formatting and removal of legacy GitBook hints.
  • Terminology Fixes: Corrected definitions for it and ct types.

- Merge redundant intro paragraphs into cohesive description
- Add Features, Data Types, and Requirements sections
- Add it/ct type table (Input Text / Ciphertext)
- Update function signatures: prepareIT, prepareIT256, decryptUint256, recoverUserKey
- Correct terminology: it=Input Text, ct=Ciphertext
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants