@thalalabs/surf 0.0.9 → 0.0.10

package/build/types/abi/aggregator.d.ts

@@ -0,0 +1,63 @@
+export declare const AGGREGATOR_ABI: {
+    readonly address: "0x1";
+    readonly name: "aggregator";
+    readonly friends: readonly [];
+    readonly exposed_functions: readonly [{
+        readonly name: "add";
+        readonly visibility: "public";
+        readonly is_entry: false;
+        readonly is_view: false;
+        readonly generic_type_params: readonly [];
+        readonly params: readonly ["&mut 0x1::aggregator::Aggregator", "u128"];
+        readonly return: readonly [];
+    }, {
+        readonly name: "destroy";
+        readonly visibility: "public";
+        readonly is_entry: false;
+        readonly is_view: false;
+        readonly generic_type_params: readonly [];
+        readonly params: readonly ["0x1::aggregator::Aggregator"];
+        readonly return: readonly [];
+    }, {
+        readonly name: "limit";
+        readonly visibility: "public";
+        readonly is_entry: false;
+        readonly is_view: false;
+        readonly generic_type_params: readonly [];
+        readonly params: readonly ["&0x1::aggregator::Aggregator"];
+        readonly return: readonly ["u128"];
+    }, {
+        readonly name: "read";
+        readonly visibility: "public";
+        readonly is_entry: false;
+        readonly is_view: false;
+        readonly generic_type_params: readonly [];
+        readonly params: readonly ["&0x1::aggregator::Aggregator"];
+        readonly return: readonly ["u128"];
+    }, {
+        readonly name: "sub";
+        readonly visibility: "public";
+        readonly is_entry: false;
+        readonly is_view: false;
+        readonly generic_type_params: readonly [];
+        readonly params: readonly ["&mut 0x1::aggregator::Aggregator", "u128"];
+        readonly return: readonly [];
+    }];
+    readonly structs: readonly [{
+        readonly name: "Aggregator";
+        readonly is_native: false;
+        readonly abilities: readonly ["store"];
+        readonly generic_type_params: readonly [];
+        readonly fields: readonly [{
+            readonly name: "handle";
+            readonly type: "address";
+        }, {
+            readonly name: "key";
+            readonly type: "address";
+        }, {
+            readonly name: "limit";
+            readonly type: "u128";
+        }];
+    }];
+};
+//# sourceMappingURL=aggregator.d.ts.map

package/build/types/abi/aggregator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"aggregator.d.ts","sourceRoot":"","sources":["../../../src/abi/aggregator.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2Ff,CAAC"}

package/build/types/abi/optional_aggregator.d.ts

@@ -0,0 +1,88 @@
+export declare const OPTIONAL_AGGREGATOR_ABI: {
+    readonly address: "0x1";
+    readonly name: "optional_aggregator";
+    readonly friends: readonly ["0x1::coin"];
+    readonly exposed_functions: readonly [{
+        readonly name: "add";
+        readonly visibility: "public";
+        readonly is_entry: false;
+        readonly is_view: false;
+        readonly generic_type_params: readonly [];
+        readonly params: readonly ["&mut 0x1::optional_aggregator::OptionalAggregator", "u128"];
+        readonly return: readonly [];
+    }, {
+        readonly name: "destroy";
+        readonly visibility: "public";
+        readonly is_entry: false;
+        readonly is_view: false;
+        readonly generic_type_params: readonly [];
+        readonly params: readonly ["0x1::optional_aggregator::OptionalAggregator"];
+        readonly return: readonly [];
+    }, {
+        readonly name: "is_parallelizable";
+        readonly visibility: "public";
+        readonly is_entry: false;
+        readonly is_view: false;
+        readonly generic_type_params: readonly [];
+        readonly params: readonly ["&0x1::optional_aggregator::OptionalAggregator"];
+        readonly return: readonly ["bool"];
+    }, {
+        readonly name: "new";
+        readonly visibility: "friend";
+        readonly is_entry: false;
+        readonly is_view: false;
+        readonly generic_type_params: readonly [];
+        readonly params: readonly ["u128", "bool"];
+        readonly return: readonly ["0x1::optional_aggregator::OptionalAggregator"];
+    }, {
+        readonly name: "read";
+        readonly visibility: "public";
+        readonly is_entry: false;
+        readonly is_view: false;
+        readonly generic_type_params: readonly [];
+        readonly params: readonly ["&0x1::optional_aggregator::OptionalAggregator"];
+        readonly return: readonly ["u128"];
+    }, {
+        readonly name: "sub";
+        readonly visibility: "public";
+        readonly is_entry: false;
+        readonly is_view: false;
+        readonly generic_type_params: readonly [];
+        readonly params: readonly ["&mut 0x1::optional_aggregator::OptionalAggregator", "u128"];
+        readonly return: readonly [];
+    }, {
+        readonly name: "switch";
+        readonly visibility: "public";
+        readonly is_entry: false;
+        readonly is_view: false;
+        readonly generic_type_params: readonly [];
+        readonly params: readonly ["&mut 0x1::optional_aggregator::OptionalAggregator"];
+        readonly return: readonly [];
+    }];
+    readonly structs: readonly [{
+        readonly name: "Integer";
+        readonly is_native: false;
+        readonly abilities: readonly ["store"];
+        readonly generic_type_params: readonly [];
+        readonly fields: readonly [{
+            readonly name: "value";
+            readonly type: "u128";
+        }, {
+            readonly name: "limit";
+            readonly type: "u128";
+        }];
+    }, {
+        readonly name: "OptionalAggregator";
+        readonly is_native: false;
+        readonly abilities: readonly ["store"];
+        readonly generic_type_params: readonly [];
+        readonly fields: readonly [{
+            readonly name: "aggregator";
+            readonly type: "0x1::option::Option<0x1::aggregator::Aggregator>";
+        }, {
+            readonly name: "integer";
+            readonly type: "0x1::option::Option<0x1::optional_aggregator::Integer>";
+        }];
+    }];
+};
+//# sourceMappingURL=optional_aggregator.d.ts.map

package/build/types/abi/optional_aggregator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"optional_aggregator.d.ts","sourceRoot":"","sources":["../../../src/abi/optional_aggregator.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoIxB,CAAC"}

package/build/types/core/Client.d.ts

@@ -3,18 +3,113 @@ import type { ABIEntryClient, ABIViewClient, ABIRoot, EntryOptions, EntryPayload
 import type { TransactionResponse } from "../types/common.js";
 import { ABIResourceClient } from "../types/abiClient.js";
 import { ABITable } from "../types/struct.js";
+/**
+ * Create a client to interact with Aptos smart contract.
+ *
+ * @param options.nodeUrl URL of the Aptos Node API endpoint.
+ * @returns The client object.
+ */
 export declare function createClient<TABITable extends ABITable = DefaultABITable>(options: {
     nodeUrl: string;
 }): Client<TABITable>;
 export declare class Client<TABITable extends ABITable> {
     private client;
     constructor(client: AptosClient);
+    /**
+     * Call a view function.
+     *
+     * @param payload The payload object created by `createViewPayload`.
+     * @param options.ledger_version The ledger version.
+     * @returns The return value of view function.
+     * @example
+     * const viewPayload = createViewPayload(COIN_ABI, {
+     *   function: 'balance',
+     *   arguments: ['0x1'],
+     *   type_arguments: ['0x1::aptos_coin::AptosCoin'],
+     * });
+     * const [balance] = await client.view(viewPayload);
+     */
     view<TReturn>(payload: ViewPayload<TReturn>, options?: ViewOptions): Promise<TReturn>;
+    /**
+     * Submit a transaction.
+     *
+     * @param payload The payload object created by `createEntryPayload`.
+     * @param options.account AptosAccount to submit the transaction.
+     * @returns The transaction response.
+     * @example
+     * const entryPayload = createEntryPayload(COIN_ABI, {
+     *     function: 'transfer',
+     *     arguments: ['0x1', 1],
+     *     type_arguments: ['0x1::aptos_coin::AptosCoin'],
+     * });
+     *
+     * const { hash } = await client.submitTransaction(
+     *     entryPayload,
+     *     { account },
+     * );
+     */
     submitTransaction(payload: EntryPayload, options: EntryOptions): Promise<TransactionResponse>;
+    /**
+     * Simulate a transaction.
+     *
+     * @param payload The payload object created by `createEntryPayload`.
+     * @param options.account AptosAccount to simulate the transaction.
+     * @returns The transaction response.
+     * @example
+     * const entryPayload = createEntryPayload(COIN_ABI, {
+     *     function: 'transfer',
+     *     arguments: ['0x1', 1],
+     *     type_arguments: ['0x1::aptos_coin::AptosCoin'],
+     * });
+     *
+     * const { hash } = await client.simulateTransaction(
+     *     entryPayload,
+     *     { account },
+     * );
+     */
     simulateTransaction(payload: EntryPayload, options: EntryOptions): Promise<TransactionResponse>;
+    /**
+     * Create a client associated with a specific ABI.
+     *
+     * @param abi The ABI JSON.
+     * @returns A client can call view/entry functions or get account resource.
+     * @example
+     * const [balance] = await client.useABI(COIN_ABI).view.balance({
+     *    arguments: ['0x1'],
+     *    type_arguments: ['0x1::aptos_coin::AptosCoin'],
+     * });
+     */
     useABI<T extends ABIRoot>(abi: T): {
+        /**
+         * Call an view function.
+         *
+         * @example
+         * const [balance] = await client.useABI(COIN_ABI).view.balance({
+         *     arguments: ['0x1'],
+         *     type_arguments: ['0x1::aptos_coin::AptosCoin'],
+         * });
+         */
         view: ABIViewClient<T>;
+        /**
+         * Call an entry function.
+         *
+         * @example
+         * const { hash } = await client.useABI(COIN_ABI).entry.transfer({
+         *     arguments: ['0x1', 1],
+         *     type_arguments: ['0x1::aptos_coin::AptosCoin'],
+         *     account,
+         * });
+         */
         entry: ABIEntryClient<T>;
+        /**
+         * Get account resource.
+         *
+         * @example
+         * const { data } = await client.useABI(COIN_ABI).resource.CoinStore({
+         *     type_arguments: ['0x1::aptos_coin::AptosCoin'],
+         *     account: '0x1',
+         * });
+         */
         resource: ABIResourceClient<TABITable, T>;
     };
     private generateRawTxn;

package/build/types/core/Client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Client.d.ts","sourceRoot":"","sources":["../../../src/core/Client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAmB,MAAM,OAAO,CAAC;AAGrD,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACvJ,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAE9C,wBAAgB,YAAY,CAAC,SAAS,SAAS,QAAQ,GAAG,eAAe,EACpE,OAAO,EAAE;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAAC,SAAS,CAAC,CAIpD;AAED,qBAAa,MAAM,CAAC,SAAS,SAAS,QAAQ;IAC1C,OAAO,CAAC,MAAM,CAAc;gBAEhB,MAAM,EAAE,WAAW;IAIlB,IAAI,CAAC,OAAO,EACrB,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,EAC7B,OAAO,CAAC,EAAE,WAAW,GACtB,OAAO,CAAC,OAAO,CAAC;IAeN,iBAAiB,CAC1B,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,YAAY,GACtB,OAAO,CAAC,mBAAmB,CAAC;IAoBlB,mBAAmB,CAC5B,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,YAAY,GACtB,OAAO,CAAC,mBAAmB,CAAC;IAWxB,MAAM,CAAC,CAAC,SAAS,OAAO,EAAE,GAAG,EAAE,CAAC;;;;;YAiDzB,cAAc;CAW/B"}
+{"version":3,"file":"Client.d.ts","sourceRoot":"","sources":["../../../src/core/Client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAmB,MAAM,OAAO,CAAC;AAGrD,OAAO,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACvJ,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAE9C;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,SAAS,SAAS,QAAQ,GAAG,eAAe,EACpE,OAAO,EAAE;IAAE,OAAO,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAAC,SAAS,CAAC,CAIpD;AAED,qBAAa,MAAM,CAAC,SAAS,SAAS,QAAQ;IAC1C,OAAO,CAAC,MAAM,CAAc;gBAEhB,MAAM,EAAE,WAAW;IAI/B;;;;;;;;;;;;;OAaG;IACU,IAAI,CAAC,OAAO,EACrB,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC,EAC7B,OAAO,CAAC,EAAE,WAAW,GACtB,OAAO,CAAC,OAAO,CAAC;IAenB;;;;;;;;;;;;;;;;;OAiBG;IACU,iBAAiB,CAC1B,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,YAAY,GACtB,OAAO,CAAC,mBAAmB,CAAC;IAoB/B;;;;;;;;;;;;;;;;;OAiBG;IACU,mBAAmB,CAC5B,OAAO,EAAE,YAAY,EACrB,OAAO,EAAE,YAAY,GACtB,OAAO,CAAC,mBAAmB,CAAC;IAW/B;;;;;;;;;;OAUG;IACI,MAAM,CAAC,CAAC,SAAS,OAAO,EAAE,GAAG,EAAE,CAAC;QAE/B;;;;;;;;WAQG;;QAeH;;;;;;;;;WASG;;QAiBH;;;;;;;;WAQG;;;YAoBG,cAAc;CAW/B"}

package/build/types/core/createEntryPayload.d.ts

@@ -1,4 +1,24 @@
 import type { ABIRoot, EntryPayload } from "../types/index.js";
 import type { EntryFunctionName, EntryRequestPayload } from "../types/common.js";
+/**
+ * Create a payload for calling a entry function.
+ *
+ * @param abi The ABI JSON contains the entry function. For type inference and encoding/decoding purpose.
+ * @param payload.function The function name.
+ * @param payload.arguments The input arguments for function.
+ * @param payload.type_arguments The generic type arguments for function.
+ * @returns The payload object to be used in `simulateTransaction` or `submitTransaction` method.
+ * @example
+ * const entryPayload = createEntryPayload(COIN_ABI, {
+ *     function: 'transfer',
+ *     arguments: ['0x1', 1],
+ *     type_arguments: ['0x1::aptos_coin::AptosCoin'],
+ * });
+ *
+ * const { hash } = await client.submitTransaction(
+ *     entryPayload,
+ *     { account },
+ * );
+ */
 export declare function createEntryPayload<T extends ABIRoot, TFuncName extends EntryFunctionName<T>>(abi: T, payload: EntryRequestPayload<T, TFuncName>): EntryPayload;
 //# sourceMappingURL=createEntryPayload.d.ts.map

package/build/types/core/createEntryPayload.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createEntryPayload.d.ts","sourceRoot":"","sources":["../../../src/core/createEntryPayload.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,KAAK,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAEjF,wBAAgB,kBAAkB,CAC9B,CAAC,SAAS,OAAO,EACjB,SAAS,SAAS,iBAAiB,CAAC,CAAC,CAAC,EAEtC,GAAG,EAAE,CAAC,EACN,OAAO,EAAE,mBAAmB,CAAC,CAAC,EAAE,SAAS,CAAC,GAC3C,YAAY,CAoDd"}
+{"version":3,"file":"createEntryPayload.d.ts","sourceRoot":"","sources":["../../../src/core/createEntryPayload.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,KAAK,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAEjF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,kBAAkB,CAC9B,CAAC,SAAS,OAAO,EACjB,SAAS,SAAS,iBAAiB,CAAC,CAAC,CAAC,EAEtC,GAAG,EAAE,CAAC,EACN,OAAO,EAAE,mBAAmB,CAAC,CAAC,EAAE,SAAS,CAAC,GAC3C,YAAY,CAoDd"}

package/build/types/core/createViewPayload.d.ts

@@ -1,4 +1,20 @@
 import type { ABIRoot, ViewPayload } from "../types/index.js";
 import type { ExtractReturnType, ViewFunctionName, ViewRequestPayload } from "../types/common.js";
+/**
+ * Create a payload for calling a view function.
+ *
+ * @param abi The ABI JSON contains the view function. For type inference and encoding/decoding purpose.
+ * @param payload.function The function name.
+ * @param payload.arguments The input arguments for function.
+ * @param payload.type_arguments The generic type arguments for function.
+ * @returns The payload object to be used in `view` method.
+ * @example
+ * const viewPayload = createViewPayload(COIN_ABI, {
+ *   function: 'balance',
+ *   arguments: ['0x1'],
+ *   type_arguments: ['0x1::aptos_coin::AptosCoin'],
+ * });
+ * const [balance] = await client.view(viewPayload);
+ */
 export declare function createViewPayload<T extends ABIRoot, TFuncName extends ViewFunctionName<T>>(abi: T, payload: ViewRequestPayload<T, TFuncName>): ViewPayload<ExtractReturnType<T, TFuncName>>;
 //# sourceMappingURL=createViewPayload.d.ts.map

package/build/types/core/createViewPayload.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createViewPayload.d.ts","sourceRoot":"","sources":["../../../src/core/createViewPayload.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAKlG,wBAAgB,iBAAiB,CAC7B,CAAC,SAAS,OAAO,EACjB,SAAS,SAAS,gBAAgB,CAAC,CAAC,CAAC,EAErC,GAAG,EAAE,CAAC,EACN,OAAO,EAAE,kBAAkB,CAAC,CAAC,EAAE,SAAS,CAAC,GAEzC,WAAW,CAAC,iBAAiB,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAgD/C"}
+{"version":3,"file":"createViewPayload.d.ts","sourceRoot":"","sources":["../../../src/core/createViewPayload.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,oBAAoB,CAAC;AAKlG;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,iBAAiB,CAC7B,CAAC,SAAS,OAAO,EACjB,SAAS,SAAS,gBAAgB,CAAC,CAAC,CAAC,EAErC,GAAG,EAAE,CAAC,EACN,OAAO,EAAE,kBAAkB,CAAC,CAAC,EAAE,SAAS,CAAC,GAEzC,WAAW,CAAC,iBAAiB,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAgD/C"}

package/build/types/types/defaultABITable.d.ts

@@ -1,11 +1,15 @@
+import { AGGREGATOR_ABI } from "../abi/aggregator.js";
 import type { COIN_ABI } from "../abi/coin.js";
 import type { EVENT_ABI } from "../abi/event.js";
 import type { GUID_ABI } from "../abi/guid.js";
+import { OPTIONAL_AGGREGATOR_ABI } from "../abi/optional_aggregator.js";
 import { TABLE_ABI } from "../abi/table.js";
 export type DefaultABITable = {
     '0x1::coin': typeof COIN_ABI;
     '0x1::event': typeof EVENT_ABI;
     '0x1::guid': typeof GUID_ABI;
     '0x1::table': typeof TABLE_ABI;
+    '0x1::optional_aggregator': typeof OPTIONAL_AGGREGATOR_ABI;
+    '0x1::aggregator': typeof AGGREGATOR_ABI;
 };
 //# sourceMappingURL=defaultABITable.d.ts.map

package/build/types/types/defaultABITable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"defaultABITable.d.ts","sourceRoot":"","sources":["../../../src/types/defaultABITable.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,MAAM,MAAM,eAAe,GAAG;IAC1B,WAAW,EAAE,OAAO,QAAQ,CAAC;IAC7B,YAAY,EAAE,OAAO,SAAS,CAAC;IAC/B,WAAW,EAAE,OAAO,QAAQ,CAAC;IAC7B,YAAY,EAAE,OAAO,SAAS,CAAC;CAClC,CAAC"}
+{"version":3,"file":"defaultABITable.d.ts","sourceRoot":"","sources":["../../../src/types/defaultABITable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAC;AACxE,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,MAAM,MAAM,eAAe,GAAG;IAC1B,WAAW,EAAE,OAAO,QAAQ,CAAC;IAC7B,YAAY,EAAE,OAAO,SAAS,CAAC;IAC/B,WAAW,EAAE,OAAO,QAAQ,CAAC;IAC7B,YAAY,EAAE,OAAO,SAAS,CAAC;IAC/B,0BAA0B,EAAE,OAAO,uBAAuB,CAAC;IAC3D,iBAAiB,EAAE,OAAO,cAAc,CAAC;CAC5C,CAAC"}

package/build/types/types/struct.d.ts

@@ -11,8 +11,11 @@ type ExtractStruct<T extends ABIRoot, TResourceName extends ResourceStructName<T
 type ExtractStructFieldMoveType<T extends ABIRoot, TStructName extends ResourceStructName<T>, TFieldName extends string> = Extract<ExtractStruct<T, TStructName>['fields'][number], {
     name: TFieldName;
 }>['type'];
-type ConvertStructFieldType<TABITable extends ABITable, TMoveType extends string> = TMoveType extends AllTypes ? ConvertStructFieldNonStructType<TABITable, TMoveType> : ConvertStructFieldStructType<TABITable, TMoveType>;
+type ConvertStructFieldType<TABITable extends ABITable, TMoveType extends string> = TMoveType extends AllTypes ? ConvertStructFieldNonStructType<TABITable, TMoveType> : TMoveType extends `0x1::option::Option<${infer TInner}>` ? ConvertStructFieldOptionType<TABITable, TInner> : ConvertStructFieldStructType<TABITable, TMoveType>;
 export type ConvertStructFieldNonStructType<TABITable extends ABITable, TMoveType extends AllTypes> = TMoveType extends Primitive ? ConvertPrimitiveStructField<TMoveType> : TMoveType extends `vector<${infer TInner}>` ? ConvertStructFieldType<TABITable, TInner>[] : Struct<TMoveType>;
+type ConvertStructFieldOptionType<TABITable extends ABITable, TMoveType extends string> = {
+    vec: [ConvertStructFieldType<TABITable, TMoveType>] | [];
+};
 type ConvertStructFieldStructType<TABITable extends ABITable, TMoveType extends string> = TMoveType extends `${infer TAccountAddress}::${infer TModuleName}::${infer TStructName}${'' | `<${infer _TInnerType}>`}` ? `${TAccountAddress}::${TModuleName}` extends keyof TABITable ? OmitInner<TStructName> extends ResourceStructName<TABITable[`${TAccountAddress}::${TModuleName}`]> ? ExtractStructType<TABITable, TABITable[`${TAccountAddress}::${TModuleName}`], OmitInner<TStructName>> : Struct<TMoveType> : Struct<TMoveType> : Struct<TMoveType>;
 export type ExtractStructType<TABITable extends ABITable, TABI extends ABIRoot, TStructName extends ResourceStructName<TABI>> = {
     [TField in ExtractStructFieldsName<TABI, TStructName>]: ConvertStructFieldType<TABITable, ExtractStructFieldMoveType<TABI, TStructName, TField>>;

package/build/types/types/struct.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"struct.d.ts","sourceRoot":"","sources":["../../../src/types/struct.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACnC,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAErE,KAAK,MAAM,CAAC,EAAE,SAAS,MAAM,IAAI,MAAM,CAAC;AAExC,MAAM,MAAM,2BAA2B,CAAC,CAAC,SAAS,SAAS,IACvD,CAAC,SAAS,MAAM,GAAG,OAAO,GAC1B,CAAC,SAAS,IAAI,GAAG,MAAM,GACvB,CAAC,SAAS,KAAK,GAAG,MAAM,GACxB,CAAC,SAAS,KAAK,GAAG,MAAM,GACxB,CAAC,SAAS,KAAK,GAAG,MAAM,GACxB,CAAC,SAAS,MAAM,GAAG,MAAM,GACzB,CAAC,SAAS,MAAM,GAAG,MAAM,GACzB,CAAC,SAAS,SAAS,GAAG,KAAK,MAAM,EAAE,GACnC,CAAC,SAAS,qBAAqB,GAAG,MAAM,GACxC,KAAK,CAAC;AAEV,KAAK,UAAU,CAAC,CAAC,SAAS,OAAO,IAAI,CAAC,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;AAE1D,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,OAAO,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;AAE1E,KAAK,uBAAuB,CACxB,CAAC,SAAS,OAAO,EACjB,WAAW,SAAS,kBAAkB,CAAC,CAAC,CAAC,IAAI,aAAa,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;AAEzG,KAAK,aAAa,CAAC,CAAC,SAAS,OAAO,EAAE,aAAa,SAAS,kBAAkB,CAAC,CAAC,CAAC,IAC7E,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE;IAAE,IAAI,EAAE,aAAa,CAAA;CAAE,CAAC,CAAC;AAEpD,KAAK,0BAA0B,CAC3B,CAAC,SAAS,OAAO,EACjB,WAAW,SAAS,kBAAkB,CAAC,CAAC,CAAC,EACzC,UAAU,SAAS,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;IAAE,IAAI,EAAE,UAAU,CAAA;CAAE,CAAC,CAAC,MAAM,CAAC,CAAC;AAGxH,KAAK,sBAAsB,CAAC,SAAS,SAAS,QAAQ,EAAE,SAAS,SAAS,MAAM,IAC5E,SAAS,SAAS,QAAQ,GAE1B,+BAA+B,CAAC,SAAS,EAAE,SAAS,CAAC,GAErD,4BAA4B,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;AAGvD,MAAM,MAAM,+BAA+B,CAAC,SAAS,SAAS,QAAQ,EAAE,SAAS,SAAS,QAAQ,IAC9F,SAAS,SAAS,SAAS,GAAG,2BAA2B,CAAC,SAAS,CAAC,GACpE,SAAS,SAAS,UAAU,MAAM,MAAM,GAAG,GAAG,sBAAsB,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE,GACzF,MAAM,CAAC,SAAS,CAAC,CAAC;AAGtB,KAAK,4BAA4B,CAAC,SAAS,SAAS,QAAQ,EAAE,SAAS,SAAS,MAAM,IAClF,SAAS,SAAS,GAAG,MAAM,eAAe,KAAK,MAAM,WAAW,KAAK,MAAM,WAAW,GAAG,EAAE,GAAG,IAAI,MAAM,WAAW,GAAG,EAAE,GACtH,GAAG,eAAe,KAAK,WAAW,EAAE,SAAS,MAAM,SAAS,GAC9D,SAAS,CAAC,WAAW,CAAC,SAAS,kBAAkB,CAAC,SAAS,CAAC,GAAG,eAAe,KAAK,WAAW,EAAE,CAAC,CAAC,GAClG,iBAAiB,CAAC,SAAS,EAAE,SAAS,CAAC,GAAG,eAAe,KAAK,WAAW,EAAE,CAAC,EAAE,SAAS,CAAC,WAAW,CAAC,CAAC,GAEnG,MAAM,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;AAGhE,MAAM,MAAM,iBAAiB,CACzB,SAAS,SAAS,QAAQ,EAC1B,IAAI,SAAS,OAAO,EACpB,WAAW,SAAS,kBAAkB,CAAC,IAAI,CAAC,IAAI;KAC3C,MAAM,IAAI,uBAAuB,CAAC,IAAI,EAAE,WAAW,CAAC,GACrD,sBAAsB,CAAC,SAAS,EAAE,0BAA0B,CAAC,IAAI,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;CAC3F,CAAC;AAEN,MAAM,MAAM,iCAAiC,CACzC,CAAC,SAAS,OAAO,EACjB,WAAW,SAAS,kBAAkB,CAAC,CAAC,CAAC,IACzC,aAAa,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,qBAAqB,CAAC,CAAC;AAEzD,MAAM,MAAM,8BAA8B,CACtC,CAAC,SAAS,OAAO,EACjB,WAAW,SAAS,kBAAkB,CAAC,CAAC,CAAC,IACzC,iBAAiB,CAAC,iCAAiC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC;AAEzE,KAAK,SAAS,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,GAAG,MAAM,MAAM,IAAI,MAAM,OAAO,GAAG,GAAG,GAAG,MAAM,EAAE,GAAG,CAAC,CAAC;AAEnG,MAAM,MAAM,QAAQ,GAAG;KAClB,QAAQ,IAAI,MAAM,GAAG,OAAO;CAChC,CAAC"}
+{"version":3,"file":"struct.d.ts","sourceRoot":"","sources":["../../../src/types/struct.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACnC,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAErE,KAAK,MAAM,CAAC,EAAE,SAAS,MAAM,IAAI,MAAM,CAAC;AAExC,MAAM,MAAM,2BAA2B,CAAC,CAAC,SAAS,SAAS,IACvD,CAAC,SAAS,MAAM,GAAG,OAAO,GAC1B,CAAC,SAAS,IAAI,GAAG,MAAM,GACvB,CAAC,SAAS,KAAK,GAAG,MAAM,GACxB,CAAC,SAAS,KAAK,GAAG,MAAM,GACxB,CAAC,SAAS,KAAK,GAAG,MAAM,GACxB,CAAC,SAAS,MAAM,GAAG,MAAM,GACzB,CAAC,SAAS,MAAM,GAAG,MAAM,GACzB,CAAC,SAAS,SAAS,GAAG,KAAK,MAAM,EAAE,GACnC,CAAC,SAAS,qBAAqB,GAAG,MAAM,GACxC,KAAK,CAAC;AAEV,KAAK,UAAU,CAAC,CAAC,SAAS,OAAO,IAAI,CAAC,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;AAE1D,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,OAAO,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;AAE1E,KAAK,uBAAuB,CACxB,CAAC,SAAS,OAAO,EACjB,WAAW,SAAS,kBAAkB,CAAC,CAAC,CAAC,IAAI,aAAa,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;AAEzG,KAAK,aAAa,CAAC,CAAC,SAAS,OAAO,EAAE,aAAa,SAAS,kBAAkB,CAAC,CAAC,CAAC,IAC7E,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE;IAAE,IAAI,EAAE,aAAa,CAAA;CAAE,CAAC,CAAC;AAEpD,KAAK,0BAA0B,CAC3B,CAAC,SAAS,OAAO,EACjB,WAAW,SAAS,kBAAkB,CAAC,CAAC,CAAC,EACzC,UAAU,SAAS,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;IAAE,IAAI,EAAE,UAAU,CAAA;CAAE,CAAC,CAAC,MAAM,CAAC,CAAC;AAGxH,KAAK,sBAAsB,CAAC,SAAS,SAAS,QAAQ,EAAE,SAAS,SAAS,MAAM,IAC5E,SAAS,SAAS,QAAQ,GAE1B,+BAA+B,CAAC,SAAS,EAAE,SAAS,CAAC,GACrD,SAAS,SAAS,uBAAuB,MAAM,MAAM,GAAG,GAExD,4BAA4B,CAAC,SAAS,EAAE,MAAM,CAAC,GAE/C,4BAA4B,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;AAGvD,MAAM,MAAM,+BAA+B,CAAC,SAAS,SAAS,QAAQ,EAAE,SAAS,SAAS,QAAQ,IAC9F,SAAS,SAAS,SAAS,GAAG,2BAA2B,CAAC,SAAS,CAAC,GACpE,SAAS,SAAS,UAAU,MAAM,MAAM,GAAG,GAAG,sBAAsB,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE,GACzF,MAAM,CAAC,SAAS,CAAC,CAAC;AAEtB,KAAK,4BAA4B,CAAC,SAAS,SAAS,QAAQ,EAAE,SAAS,SAAS,MAAM,IAAI;IACtF,GAAG,EAAE,CAAC,sBAAsB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,GAAG,EAAE,CAAC;CAC5D,CAAC;AAGF,KAAK,4BAA4B,CAAC,SAAS,SAAS,QAAQ,EAAE,SAAS,SAAS,MAAM,IAClF,SAAS,SAAS,GAAG,MAAM,eAAe,KAAK,MAAM,WAAW,KAAK,MAAM,WAAW,GAAG,EAAE,GAAG,IAAI,MAAM,WAAW,GAAG,EAAE,GACtH,GAAG,eAAe,KAAK,WAAW,EAAE,SAAS,MAAM,SAAS,GAC9D,SAAS,CAAC,WAAW,CAAC,SAAS,kBAAkB,CAAC,SAAS,CAAC,GAAG,eAAe,KAAK,WAAW,EAAE,CAAC,CAAC,GAClG,iBAAiB,CAAC,SAAS,EAAE,SAAS,CAAC,GAAG,eAAe,KAAK,WAAW,EAAE,CAAC,EAAE,SAAS,CAAC,WAAW,CAAC,CAAC,GAEnG,MAAM,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;AAGhE,MAAM,MAAM,iBAAiB,CACzB,SAAS,SAAS,QAAQ,EAC1B,IAAI,SAAS,OAAO,EACpB,WAAW,SAAS,kBAAkB,CAAC,IAAI,CAAC,IAAI;KAC3C,MAAM,IAAI,uBAAuB,CAAC,IAAI,EAAE,WAAW,CAAC,GACrD,sBAAsB,CAAC,SAAS,EAAE,0BAA0B,CAAC,IAAI,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;CAC3F,CAAC;AAEN,MAAM,MAAM,iCAAiC,CACzC,CAAC,SAAS,OAAO,EACjB,WAAW,SAAS,kBAAkB,CAAC,CAAC,CAAC,IACzC,aAAa,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,qBAAqB,CAAC,CAAC;AAEzD,MAAM,MAAM,8BAA8B,CACtC,CAAC,SAAS,OAAO,EACjB,WAAW,SAAS,kBAAkB,CAAC,CAAC,CAAC,IACzC,iBAAiB,CAAC,iCAAiC,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC;AAEzE,KAAK,SAAS,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,GAAG,MAAM,MAAM,IAAI,MAAM,OAAO,GAAG,GAAG,GAAG,MAAM,EAAE,GAAG,CAAC,CAAC;AAEnG,MAAM,MAAM,QAAQ,GAAG;KAClB,QAAQ,IAAI,MAAM,GAAG,OAAO;CAChC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thalalabs/surf",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "description": "TypeScript Interfaces & React Hooks for interacting with Aptos Smart Contracts with type safety.",
   "main": "./build/cjs/index.js",
   "module": "./build/esm/index.js",
@@ -40,10 +40,10 @@
     "@typescript-eslint/eslint-plugin": "~5.59",
     "@typescript-eslint/parser": "~5.59",
     "aptos": "^1.9.0",
-    "eslint": "~8.38",
+    "eslint": "~8.44",
     "eslint-config-prettier": "~8.8",
     "eslint-plugin-jest": "~27.2",
-    "jest": "~29.5",
+    "jest": "~29.6",
     "prettier": "~2.8",
     "react": "^18.2.0",
     "rimraf": "~5.0",

package/src/abi/aggregator.ts

@@ -0,0 +1,92 @@
+export const AGGREGATOR_ABI = {
+    "address": "0x1",
+    "name": "aggregator",
+    "friends": [],
+    "exposed_functions": [
+      {
+        "name": "add",
+        "visibility": "public",
+        "is_entry": false,
+        "is_view": false,
+        "generic_type_params": [],
+        "params": [
+          "&mut 0x1::aggregator::Aggregator",
+          "u128"
+        ],
+        "return": []
+      },
+      {
+        "name": "destroy",
+        "visibility": "public",
+        "is_entry": false,
+        "is_view": false,
+        "generic_type_params": [],
+        "params": [
+          "0x1::aggregator::Aggregator"
+        ],
+        "return": []
+      },
+      {
+        "name": "limit",
+        "visibility": "public",
+        "is_entry": false,
+        "is_view": false,
+        "generic_type_params": [],
+        "params": [
+          "&0x1::aggregator::Aggregator"
+        ],
+        "return": [
+          "u128"
+        ]
+      },
+      {
+        "name": "read",
+        "visibility": "public",
+        "is_entry": false,
+        "is_view": false,
+        "generic_type_params": [],
+        "params": [
+          "&0x1::aggregator::Aggregator"
+        ],
+        "return": [
+          "u128"
+        ]
+      },
+      {
+        "name": "sub",
+        "visibility": "public",
+        "is_entry": false,
+        "is_view": false,
+        "generic_type_params": [],
+        "params": [
+          "&mut 0x1::aggregator::Aggregator",
+          "u128"
+        ],
+        "return": []
+      }
+    ],
+    "structs": [
+      {
+        "name": "Aggregator",
+        "is_native": false,
+        "abilities": [
+          "store"
+        ],
+        "generic_type_params": [],
+        "fields": [
+          {
+            "name": "handle",
+            "type": "address"
+          },
+          {
+            "name": "key",
+            "type": "address"
+          },
+          {
+            "name": "limit",
+            "type": "u128"
+          }
+        ]
+      }
+    ]
+  } as const;

package/src/abi/optional_aggregator.ts

@@ -0,0 +1,133 @@
+export const OPTIONAL_AGGREGATOR_ABI = {
+    "address": "0x1",
+    "name": "optional_aggregator",
+    "friends": [
+      "0x1::coin"
+    ],
+    "exposed_functions": [
+      {
+        "name": "add",
+        "visibility": "public",
+        "is_entry": false,
+        "is_view": false,
+        "generic_type_params": [],
+        "params": [
+          "&mut 0x1::optional_aggregator::OptionalAggregator",
+          "u128"
+        ],
+        "return": []
+      },
+      {
+        "name": "destroy",
+        "visibility": "public",
+        "is_entry": false,
+        "is_view": false,
+        "generic_type_params": [],
+        "params": [
+          "0x1::optional_aggregator::OptionalAggregator"
+        ],
+        "return": []
+      },
+      {
+        "name": "is_parallelizable",
+        "visibility": "public",
+        "is_entry": false,
+        "is_view": false,
+        "generic_type_params": [],
+        "params": [
+          "&0x1::optional_aggregator::OptionalAggregator"
+        ],
+        "return": [
+          "bool"
+        ]
+      },
+      {
+        "name": "new",
+        "visibility": "friend",
+        "is_entry": false,
+        "is_view": false,
+        "generic_type_params": [],
+        "params": [
+          "u128",
+          "bool"
+        ],
+        "return": [
+          "0x1::optional_aggregator::OptionalAggregator"
+        ]
+      },
+      {
+        "name": "read",
+        "visibility": "public",
+        "is_entry": false,
+        "is_view": false,
+        "generic_type_params": [],
+        "params": [
+          "&0x1::optional_aggregator::OptionalAggregator"
+        ],
+        "return": [
+          "u128"
+        ]
+      },
+      {
+        "name": "sub",
+        "visibility": "public",
+        "is_entry": false,
+        "is_view": false,
+        "generic_type_params": [],
+        "params": [
+          "&mut 0x1::optional_aggregator::OptionalAggregator",
+          "u128"
+        ],
+        "return": []
+      },
+      {
+        "name": "switch",
+        "visibility": "public",
+        "is_entry": false,
+        "is_view": false,
+        "generic_type_params": [],
+        "params": [
+          "&mut 0x1::optional_aggregator::OptionalAggregator"
+        ],
+        "return": []
+      }
+    ],
+    "structs": [
+      {
+        "name": "Integer",
+        "is_native": false,
+        "abilities": [
+          "store"
+        ],
+        "generic_type_params": [],
+        "fields": [
+          {
+            "name": "value",
+            "type": "u128"
+          },
+          {
+            "name": "limit",
+            "type": "u128"
+          }
+        ]
+      },
+      {
+        "name": "OptionalAggregator",
+        "is_native": false,
+        "abilities": [
+          "store"
+        ],
+        "generic_type_params": [],
+        "fields": [
+          {
+            "name": "aggregator",
+            "type": "0x1::option::Option<0x1::aggregator::Aggregator>"
+          },
+          {
+            "name": "integer",
+            "type": "0x1::option::Option<0x1::optional_aggregator::Integer>"
+          }
+        ]
+      }
+    ]
+  } as const;