@wgb5445/aptos-intent-npm 0.1.2 → 0.1.4

package/dist/aptos_dynamic_transaction_composer.d.ts

@@ -0,0 +1,203 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Wrapper to decompile script in its serialized form and wrap it with wasm errors.
+ * @param {Uint8Array} script
+ * @returns {(MoveFunctionCall)[]}
+ */
+export function generate_batched_call_payload_wasm(script: Uint8Array): (MoveFunctionCall)[];
+/**
+ * How to consume the returned value coming from a previous `MoveFunctionCall`.
+ */
+export enum ArgumentOperation {
+  /**
+   * Move the returned value to the next caller. This can be used for values that don't have
+   * `copy` ability.
+   */
+  Move = 0,
+  /**
+   * Copy the returned value and pass it to the next caller.
+   */
+  Copy = 1,
+  /**
+   * Borrow an immutable reference from a returned value and pass it to the next caller.
+   */
+  Borrow = 2,
+  /**
+   * Borrow a mutable reference from a returned value and pass it to the next caller.
+   */
+  BorrowMut = 3,
+}
+export interface AllocatedLocal {
+    op_type: ArgumentOperation;
+    is_parameter: boolean;
+    local_idx: number;
+}
+
+/**
+ * Arguments to the `MoveFunctionCall`.
+ */
+// export type CallArgument = { Raw: number[] } | { Signer: number } | { PreviousResult: PreviousResult };
+
+export class CallArgument {
+  free(): void;
+  /**
+   * @param {Uint8Array} bytes
+   * @returns {CallArgument}
+   */
+  static new_bytes(bytes: Uint8Array) : CallArgument;
+  /**
+   * @param {number} signer_idx
+   * @returns {CallArgument}
+   */
+  static new_signer(signer_idx: number) : CallArgument
+  /**
+   * @returns {CallArgument}
+   */
+  borrow(): CallArgument
+  /**
+   * @returns {CallArgument}
+   */
+  borrow_mut() :CallArgument
+  /**
+   * @returns {CallArgument}
+   */
+  copy() :CallArgument
+}
+
+
+export class AllocatedLocal {
+  free(): void;
+}
+export class BuilderCall {
+  free(): void;
+}
+export class IntoUnderlyingByteSource {
+  free(): void;
+  /**
+   * @param {any} controller
+   */
+  start(controller: any): void;
+  /**
+   * @param {any} controller
+   * @returns {Promise<any>}
+   */
+  pull(controller: any): Promise<any>;
+  cancel(): void;
+  readonly autoAllocateChunkSize: number;
+  readonly type: string;
+}
+export class IntoUnderlyingSink {
+  free(): void;
+  /**
+   * @param {any} chunk
+   * @returns {Promise<any>}
+   */
+  write(chunk: any): Promise<any>;
+  /**
+   * @returns {Promise<any>}
+   */
+  close(): Promise<any>;
+  /**
+   * @param {any} reason
+   * @returns {Promise<any>}
+   */
+  abort(reason: any): Promise<any>;
+}
+export class IntoUnderlyingSource {
+  free(): void;
+  /**
+   * @param {any} controller
+   * @returns {Promise<any>}
+   */
+  pull(controller: any): Promise<any>;
+  cancel(): void;
+}
+/**
+ * Calling a Move function.
+ *
+ * Similar to a public entry function call, but the arguments could specified as `CallArgument`,
+ * which can be a return value of a previous `MoveFunctionCall`.
+ */
+export class MoveFunctionCall {
+  free(): void;
+}
+/**
+ * Raw options for [`pipeTo()`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream/pipeTo).
+ */
+export class PipeOptions {
+  free(): void;
+  readonly preventAbort: boolean;
+  readonly preventCancel: boolean;
+  readonly preventClose: boolean;
+  readonly signal: AbortSignal | undefined;
+}
+/**
+ * Representing a returned value from a previous list of `MoveFunctionCall`s.
+ */
+export class PreviousResult {
+  free(): void;
+}
+export class QueuingStrategy {
+  free(): void;
+  readonly highWaterMark: number;
+}
+/**
+ * Raw options for [`getReader()`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream/getReader).
+ */
+export class ReadableStreamGetReaderOptions {
+  free(): void;
+  readonly mode: any;
+}
+export class TransactionComposer {
+  free(): void;
+  /**
+   * Create a builder with one distinct signer available. This should be the default configuration.
+   * @returns {TransactionComposer}
+   */
+  static single_signer(): TransactionComposer;
+  /**
+   * Create a builder with one signer needed for script. This would be needed for multi-agent
+   * transaction where multiple signers are present.
+   * @param {number} signer_count
+   * @returns {TransactionComposer}
+   */
+  static multi_signer(signer_count: number): TransactionComposer;
+  /**
+   * Consume the builder and generate a serialized script with calls in the builder.
+   * @param {boolean} with_metadata
+   * @returns {Uint8Array}
+   */
+  generate_batched_calls(with_metadata: boolean): Uint8Array;
+  /**
+   * Load up a module from a remote endpoint. Will need to invoke this function prior to the
+   * call.
+   * @param {string} api_url
+   * @param {string} module_name
+   * @returns {Promise<void>}
+   */
+  load_module(api_url: string, module_name: string): Promise<void>;
+  /**
+   * Load up the dependency modules of a TypeTag from a remote endpoint.
+   * @param {string} api_url
+   * @param {string} type_tag
+   * @returns {Promise<void>}
+   */
+  load_type_tag(api_url: string, type_tag: string): Promise<void>;
+  /**
+   * This would be the core api for the `TransactionComposer`. The function would:
+   * - add the function call to the builder
+   * - allocate the locals and parameters needed for this function call
+   * - return the arguments back to the caller which could be passed into subsequent calls
+   *   into `add_batched_call`.
+   *
+   * This function would also check for the ability and type safety when passing values
+   * into the function call, and will abort if there's a violation.
+   * @param {string} module
+   * @param {string} _function
+   * @param {(string)[]} ty_args
+   * @param {(CallArgument)[]} args
+   * @returns {(CallArgument)[]}
+   */
+  add_batched_call(module: string, _function: string, ty_args: (string)[], args: (CallArgument)[]): (CallArgument)[];
+}