@thalalabs/surf 0.0.5 → 0.0.7

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @thalalabs/surf
 
+## 0.0.7
+
+### Patch Changes
+
+- 5d6d75b: Bug fix: abi files are missing in the package
+
+## 0.0.6
+
+### Patch Changes
+
+- 2618838: Add a getAccountResource API in useABI client
+- 4609afb: Add some builtin 0x1 types for getting account resource
+
 ## 0.0.5
 
 ### Patch Changes

package/README.md

@@ -28,7 +28,7 @@
 - **Get rid of encoding/decoding**: Surf takes care of the complexities within the APIs, so you don't have to.
 - **Linting and Auto-Completion**: Enjoy a better development experience with type safety. No more guesswork for input and output.
 - **Both TypeScript Interfaces & React Hooks**: Easy to use, whether working with wallets or private keys.
-- **Low runtime cost & small bundle size**: [minzipped size: 1.77 kB](https://bundlephobia.com/package/@thalalabs/surf).
+- **Low runtime cost & small bundle size**: [minzipped size: < 2 kB](https://bundlephobia.com/package/@thalalabs/surf).
 
 ## Overview
 
@@ -75,7 +75,7 @@ const client = createClient({
 });
 ```
 
-Surf infers types from ABI to give you the end-to-end type-safety from your Move contract to your frontend. So firstly, you need to prepare the ABI json object of your contract in TypeScript:
+Surf infers types from ABI to give you the end-to-end type-safety from your Move contract to your frontend. So firstly, you need to prepare the ABI json object of your contract in TypeScript (You can get ABI from Aptos Explorer, for example: [0x1::coin](https://explorer.aptoslabs.com/account/0x1/modules/code/coin?network=testnet)):
 
 ```TypeScript
 const abi = {…} as const;
@@ -173,10 +173,8 @@ Surf currently offers two React Hooks: `useWalletClient` and `useSubmitTransacti
 Compared to [Viem](https://viem.sh/), Surf is still in its infancy. Any contribution is welcome and appreciated. Here are some TODOs:
 
 - [ ] Deploy a dedicated smart contract on the testnet for Surf to run tests that cover all data types. Currently, Surf has some tests running in CI, but they do not cover all types.
-- [ ] Support `struct` types for input arguments or return values.
-  - [ ] For `view` function, Surf currently doesn't check the input type for `struct`.
-  - [ ] For `submitTransaction` function, Surf currently cannot encode for `struct` types. 
-- [ ] Support vector of vector, vector of struct.
+- [ ] Support `struct` types for return values for `view` function.
+- [ ] Support vector of vector.
 - [ ] Accept `Uint8Array` and `string` for `vector<u8>` input. Currently users can pass these values to `createEntryPayload`, and Surf will correctly encode it. But the type system will complain. So users need to use `as any` to pass `Uint8Array` or `string` for `vector<u8>`. The type system only accept `number[]` for `vector<u8>` now.
 - [ ] Add the functionality available in AptosClient to Surf, such as `estimateGasPrice` and `getAccountResources`.
 

package/build/cjs/abi/aptos_coin.js

@@ -0,0 +1,158 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APTOS_COIN_ABI = void 0;
+exports.APTOS_COIN_ABI = {
+    "address": "0x1",
+    "name": "aptos_coin",
+    "friends": [
+        "0x1::genesis"
+    ],
+    "exposed_functions": [
+        {
+            "name": "claim_mint_capability",
+            "visibility": "public",
+            "is_entry": true,
+            "is_view": false,
+            "generic_type_params": [],
+            "params": [
+                "&signer"
+            ],
+            "return": []
+        },
+        {
+            "name": "configure_accounts_for_test",
+            "visibility": "friend",
+            "is_entry": false,
+            "is_view": false,
+            "generic_type_params": [],
+            "params": [
+                "&signer",
+                "&signer",
+                "0x1::coin::MintCapability<0x1::aptos_coin::AptosCoin>"
+            ],
+            "return": []
+        },
+        {
+            "name": "delegate_mint_capability",
+            "visibility": "public",
+            "is_entry": true,
+            "is_view": false,
+            "generic_type_params": [],
+            "params": [
+                "signer",
+                "address"
+            ],
+            "return": []
+        },
+        {
+            "name": "destroy_mint_cap",
+            "visibility": "friend",
+            "is_entry": false,
+            "is_view": false,
+            "generic_type_params": [],
+            "params": [
+                "&signer"
+            ],
+            "return": []
+        },
+        {
+            "name": "has_mint_capability",
+            "visibility": "public",
+            "is_entry": false,
+            "is_view": false,
+            "generic_type_params": [],
+            "params": [
+                "&signer"
+            ],
+            "return": [
+                "bool"
+            ]
+        },
+        {
+            "name": "initialize",
+            "visibility": "friend",
+            "is_entry": false,
+            "is_view": false,
+            "generic_type_params": [],
+            "params": [
+                "&signer"
+            ],
+            "return": [
+                "0x1::coin::BurnCapability<0x1::aptos_coin::AptosCoin>",
+                "0x1::coin::MintCapability<0x1::aptos_coin::AptosCoin>"
+            ]
+        },
+        {
+            "name": "mint",
+            "visibility": "public",
+            "is_entry": true,
+            "is_view": false,
+            "generic_type_params": [],
+            "params": [
+                "&signer",
+                "address",
+                "u64"
+            ],
+            "return": []
+        }
+    ],
+    "structs": [
+        {
+            "name": "AptosCoin",
+            "is_native": false,
+            "abilities": [
+                "key"
+            ],
+            "generic_type_params": [],
+            "fields": [
+                {
+                    "name": "dummy_field",
+                    "type": "bool"
+                }
+            ]
+        },
+        {
+            "name": "DelegatedMintCapability",
+            "is_native": false,
+            "abilities": [
+                "store"
+            ],
+            "generic_type_params": [],
+            "fields": [
+                {
+                    "name": "to",
+                    "type": "address"
+                }
+            ]
+        },
+        {
+            "name": "Delegations",
+            "is_native": false,
+            "abilities": [
+                "key"
+            ],
+            "generic_type_params": [],
+            "fields": [
+                {
+                    "name": "inner",
+                    "type": "vector<0x1::aptos_coin::DelegatedMintCapability>"
+                }
+            ]
+        },
+        {
+            "name": "MintCapStore",
+            "is_native": false,
+            "abilities": [
+                "key"
+            ],
+            "generic_type_params": [],
+            "fields": [
+                {
+                    "name": "mint_cap",
+                    "type": "0x1::coin::MintCapability<0x1::aptos_coin::AptosCoin>"
+                }
+            ]
+        }
+    ]
+};
+//# sourceMappingURL=aptos_coin.js.map

package/build/cjs/abi/aptos_coin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"aptos_coin.js","sourceRoot":"","sources":["../../../src/abi/aptos_coin.ts"],"names":[],"mappings":";;;AAAa,QAAA,cAAc,GAAG;IAC1B,SAAS,EAAE,KAAK;IAChB,MAAM,EAAE,YAAY;IACpB,SAAS,EAAE;QACP,cAAc;KACjB;IACD,mBAAmB,EAAE;QACjB;YACI,MAAM,EAAE,uBAAuB;YAC/B,YAAY,EAAE,QAAQ;YACtB,UAAU,EAAE,IAAI;YAChB,SAAS,EAAE,KAAK;YAChB,qBAAqB,EAAE,EAAE;YACzB,QAAQ,EAAE;gBACN,SAAS;aACZ;YACD,QAAQ,EAAE,EAAE;SACf;QACD;YACI,MAAM,EAAE,6BAA6B;YACrC,YAAY,EAAE,QAAQ;YACtB,UAAU,EAAE,KAAK;YACjB,SAAS,EAAE,KAAK;YAChB,qBAAqB,EAAE,EAAE;YACzB,QAAQ,EAAE;gBACN,SAAS;gBACT,SAAS;gBACT,uDAAuD;aAC1D;YACD,QAAQ,EAAE,EAAE;SACf;QACD;YACI,MAAM,EAAE,0BAA0B;YAClC,YAAY,EAAE,QAAQ;YACtB,UAAU,EAAE,IAAI;YAChB,SAAS,EAAE,KAAK;YAChB,qBAAqB,EAAE,EAAE;YACzB,QAAQ,EAAE;gBACN,QAAQ;gBACR,SAAS;aACZ;YACD,QAAQ,EAAE,EAAE;SACf;QACD;YACI,MAAM,EAAE,kBAAkB;YAC1B,YAAY,EAAE,QAAQ;YACtB,UAAU,EAAE,KAAK;YACjB,SAAS,EAAE,KAAK;YAChB,qBAAqB,EAAE,EAAE;YACzB,QAAQ,EAAE;gBACN,SAAS;aACZ;YACD,QAAQ,EAAE,EAAE;SACf;QACD;YACI,MAAM,EAAE,qBAAqB;YAC7B,YAAY,EAAE,QAAQ;YACtB,UAAU,EAAE,KAAK;YACjB,SAAS,EAAE,KAAK;YAChB,qBAAqB,EAAE,EAAE;YACzB,QAAQ,EAAE;gBACN,SAAS;aACZ;YACD,QAAQ,EAAE;gBACN,MAAM;aACT;SACJ;QACD;YACI,MAAM,EAAE,YAAY;YACpB,YAAY,EAAE,QAAQ;YACtB,UAAU,EAAE,KAAK;YACjB,SAAS,EAAE,KAAK;YAChB,qBAAqB,EAAE,EAAE;YACzB,QAAQ,EAAE;gBACN,SAAS;aACZ;YACD,QAAQ,EAAE;gBACN,uDAAuD;gBACvD,uDAAuD;aAC1D;SACJ;QACD;YACI,MAAM,EAAE,MAAM;YACd,YAAY,EAAE,QAAQ;YACtB,UAAU,EAAE,IAAI;YAChB,SAAS,EAAE,KAAK;YAChB,qBAAqB,EAAE,EAAE;YACzB,QAAQ,EAAE;gBACN,SAAS;gBACT,SAAS;gBACT,KAAK;aACR;YACD,QAAQ,EAAE,EAAE;SACf;KACJ;IACD,SAAS,EAAE;QACP;YACI,MAAM,EAAE,WAAW;YACnB,WAAW,EAAE,KAAK;YAClB,WAAW,EAAE;gBACT,KAAK;aACR;YACD,qBAAqB,EAAE,EAAE;YACzB,QAAQ,EAAE;gBACN;oBACI,MAAM,EAAE,aAAa;oBACrB,MAAM,EAAE,MAAM;iBACjB;aACJ;SACJ;QACD;YACI,MAAM,EAAE,yBAAyB;YACjC,WAAW,EAAE,KAAK;YAClB,WAAW,EAAE;gBACT,OAAO;aACV;YACD,qBAAqB,EAAE,EAAE;YACzB,QAAQ,EAAE;gBACN;oBACI,MAAM,EAAE,IAAI;oBACZ,MAAM,EAAE,SAAS;iBACpB;aACJ;SACJ;QACD;YACI,MAAM,EAAE,aAAa;YACrB,WAAW,EAAE,KAAK;YAClB,WAAW,EAAE;gBACT,KAAK;aACR;YACD,qBAAqB,EAAE,EAAE;YACzB,QAAQ,EAAE;gBACN;oBACI,MAAM,EAAE,OAAO;oBACf,MAAM,EAAE,kDAAkD;iBAC7D;aACJ;SACJ;QACD;YACI,MAAM,EAAE,cAAc;YACtB,WAAW,EAAE,KAAK;YAClB,WAAW,EAAE;gBACT,KAAK;aACR;YACD,qBAAqB,EAAE,EAAE;YACzB,QAAQ,EAAE;gBACN;oBACI,MAAM,EAAE,UAAU;oBAClB,MAAM,EAAE,uDAAuD;iBAClE;aACJ;SACJ;KACJ;CACK,CAAC"}