[doc] [TypeScript SDK] Add preliminary documentation (MystenLabs#1646)

* [TypeScript SDK] Add preliminary documentation * Update README.md Fix RPC links Split yarn and npm commands Co-authored-by: Clay-Mysten <[email protected]>
lykhangky · Apr 28, 2022 · 6163f84 · 6163f84
1 parent b68e3cd
commit 6163f84
Showing 1 changed file with 35 additions and 82 deletions.
diff --git a/sdk/typescript/README.md b/sdk/typescript/README.md
@@ -1,103 +1,56 @@
-# TSDX User Guide
+# Sui TypeScript SDK
 
-Congrats! You just saved yourself hours of work by bootstrapping this project with TSDX. Let’s get you oriented with what’s here and how to use it.
+This is the Sui TypeScript SDK built on the Sui [JSON RPC API](https://github.com/MystenLabs/sui/blob/main/doc/src/build/json-rpc.md). It provides utility classes and functions for applications to sign transactions and interact with the Sui network.
 
-> This TSDX setup is meant for developing libraries (not apps!) that can be published to NPM. If you’re looking to build a Node app, you could use `ts-node-dev`, plain `ts-node`, or simple `tsc`.
+Note that the SDK is still in development mode and some API functions are subject to change.
 
-> If you’re new to TypeScript, check out the handy [TypeScript cheatsheet](https://devhints.io/typescript).
+## Installation
 
-## Commands
-
-TSDX scaffolds your new library inside `/src`.
-
-To run TSDX, use:
+We haven't published the npm package yet, so right now you may use [npm link](https://docs.npmjs.com/cli/v8/commands/npm-link) to install it locally.
 
 ```bash
-npm start # or yarn start
+cd sui/sdk/typescript
+yarn && yarn build && npm link
 ```
 
-This builds to `/dist` and runs the project in watch mode, so any edit you save inside `src` causes a rebuild to `/dist`.
-
-To do a one-off build, use `npm run build` or `yarn build`.
-
-To run tests, use `npm test` or `yarn test`.
-
-## Configuration
-
-Code quality is set up for you with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly.
-
-### Jest
-
-Jest tests are set up to run with `npm test` or `yarn test`.
-
-### Bundle analysis
-
-[`size-limit`](https://github.com/ai/size-limit) is set up to calculate the real cost of your library with `npm run size` and visualize the bundle with `npm run analyze`.
-
-#### Setup files
-
-This is the folder structure we set up for you:
-
-```txt
-/src
-  index.tsx       # EDIT THIS
-/test
-  blah.test.tsx   # EDIT THIS
-.gitignore
-package.json      # OPTIONALLY EDIT THIS
-README.md         # EDIT THIS
-tsconfig.json
+Then:
+```bash
+cd your/project
+npm link sui.js
 ```
 
-### Rollup
+## Local Development Environment Setup
 
-TSDX uses [Rollup](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details.
+Follow the [JSON RPC doc](https://github.com/MystenLabs/sui/blob/main/doc/src/build/json-rpc.md) to start a local network and local RPC server
 
-### TypeScript
+## Usage
 
-`tsconfig.json` is set up to interpret `dom` and `esnext` types, as well as `react` for `jsx`. Adjust according to your needs.
+The `JsonRpcProvider` class provides a connection to the JSON-RPC Server and should be used for all read-only operations. For example:
 
-## Continuous integration
+Fetch objects owned by the address `C5206DD02C86A510C4848516229B02ADDFACBE55`
 
-### GitHub actions
-
-Two actions are added by default:
-
-- `main` that installs dependencies w/ cache, lints, and tests, and also builds on all pushes against a Node and OS matrix.
-- `size` that comments cost comparison of your library on every pull request using [`size-limit`](https://github.com/ai/size-limit).
-
-## Optimizations
-
-See the main `tsdx` [optimizations docs](https://github.com/palmerhq/tsdx#optimizations). In particular, know that you can take advantage of development-only optimizations:
-
-```js
-// ./types/index.d.ts
-declare var __DEV__: boolean;
-
-// inside your code...
-if (__DEV__) {
-  console.log('foo');
-}
+```typescript
+import { JsonRpcProvider } from 'sui.js';
+const provider = new JsonRpcProvider('http://127.0.0.1:5001/');
+const objects = await provider.getOwnedObjectRefs(
+  'C5206DD02C86A510C4848516229B02ADDFACBE55'
+);
 ```
 
-You can also choose to install and use [invariant](https://github.com/palmerhq/tsdx#invariant) and [warning](https://github.com/palmerhq/tsdx#warning) functions.
-
-## Module formats
+Fetch transaction details from a transaction digest:
 
-CJS, ESModules, and UMD module formats are supported.
-
-The appropriate paths are configured in `package.json` and `dist/index.js` accordingly. Please report if any issues are found.
-
-## Named exports
-
-Per Palmer Group guidelines, [always use named exports.](https://github.com/palmerhq/typescript#exports) Code split inside your React app instead of your React library.
-
-## Including styles
-
-There are many ways to ship styles, including with CSS-in-JS. TSDX has no opinion on this; configure how you like.
+```typescript
+import { JsonRpcProvider } from 'sui.js';
+const provider = new JsonRpcProvider('http://127.0.0.1:5001/');
+const txn = await provider.getTransaction(
+  '6mn5W1CczLwitHCO9OIUbqirNrQ0cuKdyxaNe16SAME='
+);
+```
 
-For vanilla CSS, you can include the stylesheet at the root directory and add it to the `files` section in your `package.json` so that it can be imported separately by your users and run through their bundler's loader.
+For any operations that involves signing or submitting transactions, you should use the `Signer` API. For example:
 
-## Publishing to NPM
+To sign a raw message:
+TODO
 
-We recommend using [np](https://github.com/sindresorhus/np).
+To transfer a Coin<SUI>:
+TODO