Documentation
    Preparing search index...

    Variable TransactionCommandsConst

    TransactionCommands: {
        Intent(
            __namedParameters: {
                data?: Record<string, unknown>;
                inputs?: Record<
                    string,
                    | { $kind?: "GasCoin"; GasCoin: true }
                    | {
                        $kind?: "Input";
                        Input: number;
                        type?: "object" | "pure" | "withdrawal";
                    }
                    | { $kind?: "Result"; Result: number }
                    | { $kind?: "NestedResult"; NestedResult: [number, number] }
                    | (
                        | { $kind?: "GasCoin"; GasCoin: true }
                        | {
                            $kind?: "Input";
                            Input: number;
                            type?: "object" | "pure" | "withdrawal";
                        }
                        | { $kind?: "Result"; Result: number }
                        | { $kind?: "NestedResult"; NestedResult: [number, number] }
                    )[],
                >;
                name: string;
            },
        ): TransactionShape<"$Intent">;
        MakeMoveVec(
            __namedParameters: {
                elements: (
                    | { $kind?: "GasCoin"; GasCoin: true }
                    | {
                        $kind?: "Input";
                        Input: number;
                        type?: "object" | "pure" | "withdrawal";
                    }
                    | { $kind?: "Result"; Result: number }
                    | { $kind?: "NestedResult"; NestedResult: [number, number] }
                )[];
                type?: string;
            },
        ): TransactionShape<"MakeMoveVec">;
        MergeCoins(
            destination:
                | { $kind?: "GasCoin"; GasCoin: true }
                | {
                    $kind?: "Input";
                    Input: number;
                    type?: "object" | "pure" | "withdrawal";
                }
                | { $kind?: "Result"; Result: number }
                | { $kind?: "NestedResult"; NestedResult: [number, number] },
            sources: (
                | { $kind?: "GasCoin"; GasCoin: true }
                | {
                    $kind?: "Input";
                    Input: number;
                    type?: "object" | "pure" | "withdrawal";
                }
                | { $kind?: "Result"; Result: number }
                | { $kind?: "NestedResult"; NestedResult: [number, number] }
            )[],
        ): TransactionShape<"MergeCoins">;
        MoveCall(
            input:
                | {
                    arguments?: (
                        | { $kind: "GasCoin"; GasCoin: true }
                        | {
                            $kind: "Input";
                            Input: number;
                            type?: "object" | "pure" | "withdrawal";
                        }
                        | { $kind: "Result"; Result: number }
                        | { $kind: "NestedResult"; NestedResult: [number, number] }
                    )[];
                    function: string;
                    module: string;
                    package: string;
                    typeArguments?: string[];
                }
                | {
                    arguments?: (
                        | { $kind: "GasCoin"; GasCoin: true }
                        | {
                            $kind: "Input";
                            Input: number;
                            type?: "object" | "pure" | "withdrawal";
                        }
                        | { $kind: "Result"; Result: number }
                        | { $kind: "NestedResult"; NestedResult: [number, number] }
                    )[];
                    target: string;
                    typeArguments?: string[];
                },
        ): TransactionShape<"MoveCall">;
        Publish(
            __namedParameters: {
                dependencies: string[];
                modules: string[] | number[][];
            },
        ): TransactionShape<"Publish">;
        SplitCoins(
            coin:
                | { $kind?: "GasCoin"; GasCoin: true }
                | {
                    $kind?: "Input";
                    Input: number;
                    type?: "object" | "pure" | "withdrawal";
                }
                | { $kind?: "Result"; Result: number }
                | { $kind?: "NestedResult"; NestedResult: [number, number] },
            amounts: (
                | { $kind?: "GasCoin"; GasCoin: true }
                | {
                    $kind?: "Input";
                    Input: number;
                    type?: "object" | "pure" | "withdrawal";
                }
                | { $kind?: "Result"; Result: number }
                | { $kind?: "NestedResult"; NestedResult: [number, number] }
            )[],
        ): TransactionShape<"SplitCoins">;
        TransferObjects(
            objects: (
                | { $kind?: "GasCoin"; GasCoin: true }
                | {
                    $kind?: "Input";
                    Input: number;
                    type?: "object" | "pure" | "withdrawal";
                }
                | { $kind?: "Result"; Result: number }
                | { $kind?: "NestedResult"; NestedResult: [number, number] }
            )[],
            address:
                | { $kind?: "GasCoin"; GasCoin: true }
                | {
                    $kind?: "Input";
                    Input: number;
                    type?: "object" | "pure" | "withdrawal";
                }
                | { $kind?: "Result"; Result: number }
                | { $kind?: "NestedResult"; NestedResult: [number, number] },
        ): TransactionShape<"TransferObjects">;
        Upgrade(
            __namedParameters: {
                dependencies: string[];
                modules: string[] | number[][];
                package: string;
                ticket:
                    | { $kind?: "GasCoin"; GasCoin: true }
                    | {
                        $kind?: "Input";
                        Input: number;
                        type?: "object" | "pure" | "withdrawal";
                    }
                    | { $kind?: "Result"; Result: number }
                    | { $kind?: "NestedResult"; NestedResult: [number, number] };
            },
        ): TransactionShape<"Upgrade">;
    } = ...

    Simple helpers used to construct transactions:

    Type Declaration

    • Intent: function
      • Parameters

        • __namedParameters: {
              data?: Record<string, unknown>;
              inputs?: Record<
                  string,
                  | { $kind?: "GasCoin"; GasCoin: true }
                  | {
                      $kind?: "Input";
                      Input: number;
                      type?: "object" | "pure" | "withdrawal";
                  }
                  | { $kind?: "Result"; Result: number }
                  | { $kind?: "NestedResult"; NestedResult: [number, number] }
                  | (
                      | { $kind?: "GasCoin"; GasCoin: true }
                      | {
                          $kind?: "Input";
                          Input: number;
                          type?: "object" | "pure" | "withdrawal";
                      }
                      | { $kind?: "Result"; Result: number }
                      | { $kind?: "NestedResult"; NestedResult: [number, number] }
                  )[],
              >;
              name: string;
          }

        Returns TransactionShape<"$Intent">

    • MakeMoveVec: function
      • Parameters

        • __namedParameters: {
              elements: (
                  | { $kind?: "GasCoin"; GasCoin: true }
                  | {
                      $kind?: "Input";
                      Input: number;
                      type?: "object" | "pure" | "withdrawal";
                  }
                  | { $kind?: "Result"; Result: number }
                  | { $kind?: "NestedResult"; NestedResult: [number, number] }
              )[];
              type?: string;
          }

        Returns TransactionShape<"MakeMoveVec">

    • MergeCoins: function
      • Parameters

        • destination:
              | { $kind?: "GasCoin"; GasCoin: true }
              | {
                  $kind?: "Input";
                  Input: number;
                  type?: "object" | "pure" | "withdrawal";
              }
              | { $kind?: "Result"; Result: number }
              | { $kind?: "NestedResult"; NestedResult: [number, number] }
        • sources: (
              | { $kind?: "GasCoin"; GasCoin: true }
              | {
                  $kind?: "Input";
                  Input: number;
                  type?: "object" | "pure" | "withdrawal";
              }
              | { $kind?: "Result"; Result: number }
              | { $kind?: "NestedResult"; NestedResult: [number, number] }
          )[]

        Returns TransactionShape<"MergeCoins">

    • MoveCall: function
      • Parameters

        • input:
              | {
                  arguments?: (
                      | { $kind: "GasCoin"; GasCoin: true }
                      | {
                          $kind: "Input";
                          Input: number;
                          type?: "object" | "pure" | "withdrawal";
                      }
                      | { $kind: "Result"; Result: number }
                      | { $kind: "NestedResult"; NestedResult: [number, number] }
                  )[];
                  function: string;
                  module: string;
                  package: string;
                  typeArguments?: string[];
              }
              | {
                  arguments?: (
                      | { $kind: "GasCoin"; GasCoin: true }
                      | {
                          $kind: "Input";
                          Input: number;
                          type?: "object" | "pure" | "withdrawal";
                      }
                      | { $kind: "Result"; Result: number }
                      | { $kind: "NestedResult"; NestedResult: [number, number] }
                  )[];
                  target: string;
                  typeArguments?: string[];
              }

        Returns TransactionShape<"MoveCall">

    • Publish: function
      • Parameters

        • __namedParameters: { dependencies: string[]; modules: string[] | number[][] }

        Returns TransactionShape<"Publish">

    • SplitCoins: function
      • Parameters

        • coin:
              | { $kind?: "GasCoin"; GasCoin: true }
              | {
                  $kind?: "Input";
                  Input: number;
                  type?: "object" | "pure" | "withdrawal";
              }
              | { $kind?: "Result"; Result: number }
              | { $kind?: "NestedResult"; NestedResult: [number, number] }
        • amounts: (
              | { $kind?: "GasCoin"; GasCoin: true }
              | {
                  $kind?: "Input";
                  Input: number;
                  type?: "object" | "pure" | "withdrawal";
              }
              | { $kind?: "Result"; Result: number }
              | { $kind?: "NestedResult"; NestedResult: [number, number] }
          )[]

        Returns TransactionShape<"SplitCoins">

    • TransferObjects: function
      • Parameters

        • objects: (
              | { $kind?: "GasCoin"; GasCoin: true }
              | {
                  $kind?: "Input";
                  Input: number;
                  type?: "object" | "pure" | "withdrawal";
              }
              | { $kind?: "Result"; Result: number }
              | { $kind?: "NestedResult"; NestedResult: [number, number] }
          )[]
        • address:
              | { $kind?: "GasCoin"; GasCoin: true }
              | {
                  $kind?: "Input";
                  Input: number;
                  type?: "object" | "pure" | "withdrawal";
              }
              | { $kind?: "Result"; Result: number }
              | { $kind?: "NestedResult"; NestedResult: [number, number] }

        Returns TransactionShape<"TransferObjects">

    • Upgrade: function
      • Parameters

        • __namedParameters: {
              dependencies: string[];
              modules: string[] | number[][];
              package: string;
              ticket:
                  | { $kind?: "GasCoin"; GasCoin: true }
                  | {
                      $kind?: "Input";
                      Input: number;
                      type?: "object" | "pure" | "withdrawal";
                  }
                  | { $kind?: "Result"; Result: number }
                  | { $kind?: "NestedResult"; NestedResult: [number, number] };
          }

        Returns TransactionShape<"Upgrade">