@typemove/iota 1.10.0-rc.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/Readme.md

@@ -0,0 +1,161 @@
+<p align="center">
+  <img src="../../images/logo.png" width="300" alt="TypeChain">
+</p>
+
+# TypeMove 
+Generate TypeScript bindings for Iota contracts.
+## Features
+ - Code generation for Iota smart contract based on ABI
+ - Typesafe encode/decoding, object filtering, transaction building, etc
+ - Automatically manage depended modules
+ - BCS schema (WIP) 
+## Usage
+### Install package
+```shell
+yarn add @typemove/iota
+```
+or 
+
+```shell
+pnpm add @typemove/iota
+```
+
+### Code Generation
+```typescript
+yarn typemove-iota [--target-dir] [--network] [--abi-dir] <location>
+```
+- `location`: Directory of ABI json files or address of account to generate types for
+- `target-dir`: Directory to output generated files (default: "./types")
+- `network`:  Network to use, could be either "mainnet", "testnet" or any node URL (default: "mainnet")
+- `abi-dir`:  Directory to store downloaded ABI. Only useful if <location> is address (default: "./abis")
+
+Use `yarn typemove-iota --help` to see detail description.
+
+A few examples:
+- generate types for an address on mainnet:
+    ```typescript
+    yarn typemove-iota --target-dir=./src/types --abi-dir=./src/abis 0x1e2b124f746a339b3cf99b9f969393a96594519aafb1d06517aacfeeae20e7a5 
+    ```
+- generate types for local ABI files stored in `./src/abis`:
+    ```typescript
+    yarn typemove-iota --target-dir=./src/types ./src/abis
+    ```
+- generate types using local node:
+    ```typescript
+    yarn typemove-iota --network="http://localhost:8080" 0x48271d39d0b05bd6efca2278f22277d6fcc375504f9839fd73f74ace240861af
+  ```
+
+### Decode Object
+```typescript
+import { defaultMoveCoder } from '@typemove/iota'
+import { single_collateral } from './types/testnet/0xebaa2ad3eacc230f309cd933958cc52684df0a41ae7ac214d186b80f830867d2.js'
+
+const res = await defaultMoveCoder().decodeType(
+  data,
+  single_collateral.Info.type()
+)
+```
+
+<details open>
+  <summary>Click to see what's like without TypeMove</summary>
+
+```typescript
+export interface Info {
+  index: string;
+  creator: string;
+  createTsMs: string;
+  round: string;
+  deliveryInfo?: DeliveryInfo;
+}
+export interface DeliveryInfo {
+  round: string;
+  price: string;
+  size: string;
+  premium: string;
+  tsMs: string;
+}
+
+let deliveryInfo: DeliveryInfo | undefined =
+    // @ts-ignore
+    data.content.fields.info.fields.delivery_info
+        ? {
+          // @ts-ignore
+          round: data.content.fields.info.fields.delivery_info.fields.round,
+          // @ts-ignore
+          price: data.content.fields.info.fields.delivery_info.fields.price,
+          // @ts-ignore
+          size: data.content.fields.info.fields.delivery_info.fields.size,
+          // @ts-ignore
+          premium: data.content.fields.info.fields.delivery_info.fields.premium,
+          // @ts-ignore
+          tsMs: data.content.fields.info.fields.delivery_info.fields.ts_ms,
+        }
+        : undefined;
+let info: Info = {
+  // @ts-ignore
+  index: data.content.fields.info.fields.index,
+  // @ts-ignore
+  creator: data.content.fields.info.fields.creator,
+  // @ts-ignore
+  createTsMs: data.content.fields.info.fields.create_ts_ms,
+  // @ts-ignore
+  round: data.content.fields.info.fields.round,
+  deliveryInfo,
+};
+
+```
+</details>
+
+
+### Decode dynamic fields
+Get objects with specified type from a list of dynamic objects, and access field with fully typed object
+```typescript
+const decodedObjects = await coder.getDynamicFields(
+    objects,
+    BUILTIN_TYPES.U64_TYPE,
+    single_collateral.PortfolioVault.type()
+)
+console.log(decodedObjects[0].value.info.delivery_info?.price)
+```
+IDE could infer result type correctly.
+![dynamic_fields.png](../../images/dynamic_fields.png)
+
+### View Function
+With type move, you could, call view functions and get decoded result very easily, e.g.
+```typescript
+import { _0x2 } from '@typemove/iota/builtin'
+
+res = (await _0x2.math.view.min(client, [20n, 4n]))
+
+console.log(res?.results_decoded[0])
+```
+
+Typemove's generated view function stubs wraps the `devInspectTransactionBlock` API and decode the result,
+it adds an fully typed `results_decoded` field to the result object. e.g. the above `min` function generated has type annotation as below: 
+
+```typescript
+module math {
+  export async function min(
+      client: IotaClient,
+      args: [bigint | TransactionArgument, bigint | TransactionArgument],
+  ): Promise<TypedDevInspectResults<[bigint]>> {
+  ...
+  }
+}
+```
+
+### Building transaction
+Similar to original transaction building process, but you could use generated builder function to replace the 
+`txb.moveCall`.
+
+```typescript
+import { clob_v2 } from './types/testnet/0xdee9.js'
+
+const client = new IotaClient({ url: getFullnodeUrl('testnet') })
+const tx = new TransactionBlock()
+clob_v2.builder.createAccount(tx, ["0xd9e6dc1e7f0790c18acf96b629f0a236d56de2f96537d921197bcb0e071b12bd"])
+    ... more tx build 
+client.signAndExecuteTransactionBlock({transactionBlock: tx, signer: keypair})
+```
+
+Checkout our [tests](./src/tests/move-call.test.ts) for more examples.

package/builtin/0x1/package.json

@@ -0,0 +1,5 @@
+{
+  "private": true,
+  "main": "../../dist/cjs/builtin/0x1.js",
+  "module": "../../dist/esm/builtin/0x1.js"
+}

package/builtin/0x2/package.json

@@ -0,0 +1,5 @@
+{
+  "private": true,
+  "main": "../../dist/cjs/builtin/0x2.js",
+  "module": "../../dist/esm/builtin/0x2.js"
+}

package/builtin/0x3/package.json

@@ -0,0 +1,5 @@
+{
+  "private": true,
+  "main": "../../dist/cjs/builtin/0x3.js",
+  "module": "../../dist/esm/builtin/0x3.js"
+}

package/builtin/package.json

@@ -0,0 +1,5 @@
+{
+  "private": true,
+  "main": "../dist/cjs/builtin/index.js",
+  "module": "../dist/esm/builtin/index.js"
+}

package/codegen/package.json

@@ -0,0 +1,5 @@
+{
+  "private": true,
+  "main": "../dist/cjs/codegen/index.js",
+  "module": "../dist/esm/codegen/index.js"
+}