[release] Release stable version 1.0.0

README.md

@@ -5,19 +5,16 @@
 [![NPM Package Downloads][npm-image-downloads]][npm-url]
 
 ### Latest Version
+
 [![NPM Package Version][npm-image-version]][npm-url]
 ![Node Version](https://img.shields.io/node/v/%40aptos-labs%2Fts-sdk)
 ![NPM bundle size](https://img.shields.io/bundlephobia/min/%40aptos-labs/ts-sdk)
 
 ### Experimental Development Version
+
 [![NPM Experimental Version](https://img.shields.io/npm/v/%40aptos-labs/ts-sdk/experimental)][experimental-url]
 ![Experimental Node Version](https://img.shields.io/node/v/%40aptos-labs%2Fts-sdk/experimental)
-![Experimental bundle size](https://img.shields.io/bundlephobia/min/%40aptos-labs/ts-sdk/experimental
-)
-
-
-
-> **This library is experimental**. Therefore, the API is unstable and may change without warning.
+![Experimental bundle size](https://img.shields.io/bundlephobia/min/%40aptos-labs/ts-sdk/experimental)
 
 The Aptos TypeScript SDK provides a convenient way to interact with the Aptos blockchain using TypeScript. It offers a
 set of utility functions, classes, and types to simplify the integration process and enhance developer productivity.
@@ -31,15 +28,15 @@ This repository supports version >= 0.0.0 of the [Aptos SDK npm package](https:/
 Install with your favorite package manager such as npm, yarn, or pnpm:
 
 ```bash
-pnpm install @aptos-labs/ts-sdk@experimental
+pnpm install @aptos-labs/ts-sdk
 ```
 
 ##### For use in a browser
 
 You can add the SDK to your web application using a script tag:
 
 ```html
-<script src="https://unpkg.com/@aptos-labs/ts-sdk@experimental/dist/browser/index.global.js" />
+<script src="https://unpkg.com/@aptos-labs/ts-sdk/dist/browser/index.global.js" />
 ```
 
 Then, the SDK can be accessed through `window.aptosSDK`.
@@ -57,7 +54,7 @@ If you want to pass in a custom config
 
 ```ts
 // an optional config information for the SDK client instance.
-const config = new AptosConfig({ network: Network.LOCAL });
+const config = new AptosConfig({ network: Network.LOCAL }); // default network is devnet
 const aptos = new Aptos(config);
 ```
 
@@ -69,7 +66,7 @@ const aptos = new Aptos(config);
 const modules = await aptos.getAccountModules({ accountAddress: "0x123" });
 ```
 
-### Keys management (default to Ed25519)
+### Account management (default to Ed25519)
 
 > Note: We introduce a Single Sender authentication (as introduced in [AIP-55](https://github.com/aptos-foundation/AIPs/pull/263)). Generating an account defaults to Legacy Ed25519 authentication with the option to use the Single Sender unified authentication
 
@@ -112,8 +109,9 @@ Using transaction submission api
 ```ts
 const alice: Account = Account.generate();
 const bobAddress = "0xb0b";
+// build transaction
 const transaction = await aptos.build.transaction({
-  sender: alice.accountAddress.toString(),
+  sender: alice,
   data: {
     function: "0x1::coin::transfer",
     type_arguments: ["0x1::aptos_coin::AptosCoin"],
@@ -132,11 +130,12 @@ const committedTransaction = await aptos.signAndSubmitTransaction({ signer: alic
 Using built in `transferCoinTransaction`
 
 ```ts
-const alice: Account;
+const alice: Account = Account.generate();
 const bobAddress = "0xb0b";
+// build transaction
 const transaction = await aptos.transferCoinTransaction({
-  sender: alice.accountAddress.toString(),
-  recipient: bob,
+  sender: alice,
+  recipient: bobAddress,
   amount: 100,
 });
 
@@ -145,6 +144,7 @@ const pendingTransaction = await aptos.signAndSubmitTransaction({ signer: alice,
 
 ## Documentation and examples
 
+- For full SDK documentation, check out the [TypeScript SDK documentation](https://aptos.dev/sdks/ts-sdk-v2/)
 - For reference documenation, check out the [API reference documentation](https://aptos-labs.github.io/aptos-ts-sdk/) for the associated version.
 - For in-depth examples, check out the [examples](./examples) folder with ready-made `package.json` files to get you going quickly!
 

docs/@aptos-labs/ts-sdk-1.0.0/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

docs/@aptos-labs/ts-sdk-1.0.0/assets/highlight.css

@@ -0,0 +1,141 @@
+:root {
+    --light-hl-0: #795E26;
+    --dark-hl-0: #DCDCAA;
+    --light-hl-1: #000000;
+    --dark-hl-1: #D4D4D4;
+    --light-hl-2: #A31515;
+    --dark-hl-2: #CE9178;
+    --light-hl-3: #800000;
+    --dark-hl-3: #808080;
+    --light-hl-4: #800000;
+    --dark-hl-4: #569CD6;
+    --light-hl-5: #000000FF;
+    --dark-hl-5: #D4D4D4;
+    --light-hl-6: #E50000;
+    --dark-hl-6: #9CDCFE;
+    --light-hl-7: #0000FF;
+    --dark-hl-7: #CE9178;
+    --light-hl-8: #CD3131;
+    --dark-hl-8: #F44747;
+    --light-hl-9: #008000;
+    --dark-hl-9: #6A9955;
+    --light-hl-10: #0000FF;
+    --dark-hl-10: #569CD6;
+    --light-hl-11: #0070C1;
+    --dark-hl-11: #4FC1FF;
+    --light-hl-12: #001080;
+    --dark-hl-12: #9CDCFE;
+    --light-hl-13: #AF00DB;
+    --dark-hl-13: #C586C0;
+    --light-hl-14: #267F99;
+    --dark-hl-14: #4EC9B0;
+    --light-hl-15: #098658;
+    --dark-hl-15: #B5CEA8;
+    --light-hl-16: #000000;
+    --dark-hl-16: #C8C8C8;
+    --light-code-background: #FFFFFF;
+    --dark-code-background: #1E1E1E;
+}
+
+@media (prefers-color-scheme: light) { :root {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
+    --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
+    --hl-10: var(--light-hl-10);
+    --hl-11: var(--light-hl-11);
+    --hl-12: var(--light-hl-12);
+    --hl-13: var(--light-hl-13);
+    --hl-14: var(--light-hl-14);
+    --hl-15: var(--light-hl-15);
+    --hl-16: var(--light-hl-16);
+    --code-background: var(--light-code-background);
+} }
+
+@media (prefers-color-scheme: dark) { :root {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
+    --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
+    --hl-10: var(--dark-hl-10);
+    --hl-11: var(--dark-hl-11);
+    --hl-12: var(--dark-hl-12);
+    --hl-13: var(--dark-hl-13);
+    --hl-14: var(--dark-hl-14);
+    --hl-15: var(--dark-hl-15);
+    --hl-16: var(--dark-hl-16);
+    --code-background: var(--dark-code-background);
+} }
+
+:root[data-theme='light'] {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
+    --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
+    --hl-10: var(--light-hl-10);
+    --hl-11: var(--light-hl-11);
+    --hl-12: var(--light-hl-12);
+    --hl-13: var(--light-hl-13);
+    --hl-14: var(--light-hl-14);
+    --hl-15: var(--light-hl-15);
+    --hl-16: var(--light-hl-16);
+    --code-background: var(--light-code-background);
+}
+
+:root[data-theme='dark'] {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
+    --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
+    --hl-10: var(--dark-hl-10);
+    --hl-11: var(--dark-hl-11);
+    --hl-12: var(--dark-hl-12);
+    --hl-13: var(--dark-hl-13);
+    --hl-14: var(--dark-hl-14);
+    --hl-15: var(--dark-hl-15);
+    --hl-16: var(--dark-hl-16);
+    --code-background: var(--dark-code-background);
+}
+
+.hl-0 { color: var(--hl-0); }
+.hl-1 { color: var(--hl-1); }
+.hl-2 { color: var(--hl-2); }
+.hl-3 { color: var(--hl-3); }
+.hl-4 { color: var(--hl-4); }
+.hl-5 { color: var(--hl-5); }
+.hl-6 { color: var(--hl-6); }
+.hl-7 { color: var(--hl-7); }
+.hl-8 { color: var(--hl-8); }
+.hl-9 { color: var(--hl-9); }
+.hl-10 { color: var(--hl-10); }
+.hl-11 { color: var(--hl-11); }
+.hl-12 { color: var(--hl-12); }
+.hl-13 { color: var(--hl-13); }
+.hl-14 { color: var(--hl-14); }
+.hl-15 { color: var(--hl-15); }
+.hl-16 { color: var(--hl-16); }
+pre, code { background: var(--code-background); }