Documentation

    Implements

    Index

    Constructors

    • Parameters

      • Optionalclone: {
            commands: EnumOutputShapeWithKeys<
                {
                    $Intent: {
                        data: { [key: string]: unknown };
                        inputs: {
                            [key: string]:
                                | { $kind: "GasCoin"; GasCoin: true }
                                | { $kind: "Input"; Input: number; type?: "pure" }
                                | { $kind: "Input"; Input: number; type?: "object" }
                                | { $kind: "Result"; Result: number }
                                | { $kind: "NestedResult"; NestedResult: [number, number] }
                                | (
                                    | { $kind: ...; GasCoin: ... }
                                    | { $kind: ...; Input: ...; type?: ... }
                                    | { $kind: ...; Input: ...; type?: ... }
                                    | { $kind: ...; Result: ... }
                                    | { $kind: ...; NestedResult: ... }
                                )[];
                        };
                        name: string;
                    };
                    MakeMoveVec: {
                        elements: (
                            | { $kind: "GasCoin"; GasCoin: true }
                            | { $kind: "Input"; Input: number; type?: "pure" }
                            | { $kind: "Input"; Input: number; type?: "object" }
                            | { $kind: "Result"; Result: number }
                            | { $kind: "NestedResult"; NestedResult: [number, number] }
                        )[];
                        type: null | string;
                    };
                    MergeCoins: {
                        destination: | { $kind: "GasCoin"; GasCoin: true }
                        | { $kind: "Input"; Input: number; type?: "pure" }
                        | { $kind: "Input"; Input: number; type?: "object" }
                        | { $kind: "Result"; Result: number }
                        | { $kind: "NestedResult"; NestedResult: [number, number] };
                        sources: (
                            | { $kind: "GasCoin"; GasCoin: true }
                            | { $kind: "Input"; Input: number; type?: "pure" }
                            | { $kind: "Input"; Input: number; type?: "object" }
                            | { $kind: "Result"; Result: number }
                            | { $kind: "NestedResult"; NestedResult: [number, number] }
                        )[];
                    };
                    MoveCall: {
                        _argumentTypes?: | null
                        | { body: OpenMoveTypeSignatureBody; ref: null
                        | "&"
                        | "&mut" }[];
                        arguments: (
                            | { $kind: "GasCoin"; GasCoin: true }
                            | { $kind: "Input"; Input: number; type?: "pure" }
                            | { $kind: "Input"; Input: number; type?: "object" }
                            | { $kind: "Result"; Result: number }
                            | { $kind: "NestedResult"; NestedResult: [number, number] }
                        )[];
                        function: string;
                        module: string;
                        package: string;
                        typeArguments: string[];
                    };
                    Publish: { dependencies: string[]; modules: string[] };
                    SplitCoins: {
                        amounts: (
                            | { $kind: "GasCoin"; GasCoin: true }
                            | { $kind: "Input"; Input: number; type?: "pure" }
                            | { $kind: "Input"; Input: number; type?: "object" }
                            | { $kind: "Result"; Result: number }
                            | { $kind: "NestedResult"; NestedResult: [number, number] }
                        )[];
                        coin:
                            | { $kind: "GasCoin"; GasCoin: true }
                            | { $kind: "Input"; Input: number; type?: "pure" }
                            | { $kind: "Input"; Input: number; type?: "object" }
                            | { $kind: "Result"; Result: number }
                            | { $kind: "NestedResult"; NestedResult: [number, number] };
                    };
                    TransferObjects: {
                        address: | { $kind: "GasCoin"; GasCoin: true }
                        | { $kind: "Input"; Input: number; type?: "pure" }
                        | { $kind: "Input"; Input: number; type?: "object" }
                        | { $kind: "Result"; Result: number }
                        | { $kind: "NestedResult"; NestedResult: [number, number] };
                        objects: (
                            | { $kind: "GasCoin"; GasCoin: true }
                            | { $kind: "Input"; Input: number; type?: "pure" }
                            | { $kind: "Input"; Input: number; type?: "object" }
                            | { $kind: "Result"; Result: number }
                            | { $kind: "NestedResult"; NestedResult: [number, number] }
                        )[];
                    };
                    Upgrade: {
                        dependencies: string[];
                        modules: string[];
                        package: string;
                        ticket: | { $kind: "GasCoin"; GasCoin: true }
                        | { $kind: "Input"; Input: number; type?: "pure" }
                        | { $kind: "Input"; Input: number; type?: "object" }
                        | { $kind: "Result"; Result: number }
                        | { $kind: "NestedResult"; NestedResult: [number, number] };
                    };
                },
                | "MoveCall"
                | "TransferObjects"
                | "SplitCoins"
                | "MergeCoins"
                | "Publish"
                | "MakeMoveVec"
                | "Upgrade"
                | "$Intent",
            >[];
            expiration?: | null
            | EnumOutputShapeWithKeys<
                { Epoch: string
                | number; None: true },
                "None" | "Epoch",
            >;
            gasData: {
                budget: null | string | number;
                owner: null | string;
                payment:
                    | null
                    | { digest: string; objectId: string; version: string
                    | number }[];
                price: null | string | number;
            };
            inputs: EnumOutputShapeWithKeys<
                {
                    Object: EnumOutputShapeWithKeys<
                        {
                            ImmOrOwnedObject: {
                                digest: string;
                                objectId: string;
                                version: string
                                | number;
                            };
                            Receiving: {
                                digest: string;
                                objectId: string;
                                version: string
                                | number;
                            };
                            SharedObject: {
                                initialSharedVersion: string
                                | number;
                                mutable: boolean;
                                objectId: string;
                            };
                        },
                        "ImmOrOwnedObject"
                        | "SharedObject"
                        | "Receiving",
                    >;
                    Pure: { bytes: string };
                    UnresolvedObject: {
                        digest?: null | string;
                        initialSharedVersion?: null | string | number;
                        objectId: string;
                        version?: null | string | number;
                    };
                    UnresolvedPure: { value: unknown };
                },
                "Pure"
                | "Object"
                | "UnresolvedPure"
                | "UnresolvedObject",
            >[];
            sender?: null | string;
            version: 2;
        }

      Returns TransactionDataBuilder

    Properties

    commands: Command[]
    expiration:
        | null
        | EnumOutputShapeWithKeys<
            { Epoch: string
            | number; None: true },
            "None" | "Epoch",
        >
    gasData: {
        budget: null | string | number;
        owner: null | string;
        payment:
            | null
            | { digest: string; objectId: string; version: string
            | number }[];
        price: null | string | number;
    }
    inputs: EnumOutputShapeWithKeys<
        {
            Object: EnumOutputShapeWithKeys<
                {
                    ImmOrOwnedObject: {
                        digest: string;
                        objectId: string;
                        version: string
                        | number;
                    };
                    Receiving: {
                        digest: string;
                        objectId: string;
                        version: string
                        | number;
                    };
                    SharedObject: {
                        initialSharedVersion: string
                        | number;
                        mutable: boolean;
                        objectId: string;
                    };
                },
                "ImmOrOwnedObject"
                | "SharedObject"
                | "Receiving",
            >;
            Pure: { bytes: string };
            UnresolvedObject: {
                digest?: null | string;
                initialSharedVersion?: null | string | number;
                objectId: string;
                version?: null | string | number;
            };
            UnresolvedPure: { value: unknown };
        },
        "Pure"
        | "Object"
        | "UnresolvedPure"
        | "UnresolvedObject",
    >[]
    sender: null | string
    version: 2 = ...

    Accessors

    • get gasConfig(): {
          budget: null
          | string
          | number;
          owner: null | string;
          payment:
              | null
              | { digest: string; objectId: string; version: string
              | number }[];
          price: null | string | number;
      }

      Returns {
          budget: null | string | number;
          owner: null | string;
          payment:
              | null
              | { digest: string; objectId: string; version: string
              | number }[];
          price: null | string | number;
      }

    • set gasConfig(
          value: {
              budget: null | string | number;
              owner: null | string;
              payment:
                  | null
                  | { digest: string; objectId: string; version: string
                  | number }[];
              price: null | string | number;
          },
      ): void

      Parameters

      • value: {
            budget: null | string | number;
            owner: null | string;
            payment:
                | null
                | { digest: string; objectId: string; version: string
                | number }[];
            price: null | string | number;
        }

      Returns void

    Methods

    • Type Parameters

      • T extends "object" | "pure"

      Parameters

      Returns { $kind: "Input"; Input: number; type: T }

    • Parameters

      • __namedParameters: {
            maxSizeBytes?: number;
            onlyTransactionKind?: boolean;
            overrides?: {
                expiration?: EnumOutputShapeWithKeys<
                    { Epoch: string
                    | number; None: true },
                    "None" | "Epoch",
                >;
                gasConfig?: Partial<
                    {
                        budget: null
                        | string
                        | number;
                        owner: null | string;
                        payment:
                            | null
                            | { digest: string; objectId: string; version: string
                            | number }[];
                        price: null | string | number;
                    },
                >;
                gasData?: Partial<
                    {
                        budget: null
                        | string
                        | number;
                        owner: null | string;
                        payment:
                            | null
                            | { digest: string; objectId: string; version: string
                            | number }[];
                        price: null | string | number;
                    },
                >;
                sender?: string;
            };
        } = {}

      Returns Uint8Array<ArrayBufferLike>

    • Returns string

    • Parameters

      • index: number
      • fn: (
            arg:
                | { $kind: "GasCoin"; GasCoin: true }
                | { $kind: "Input"; Input: number; type?: "pure" }
                | { $kind: "Input"; Input: number; type?: "object" }
                | { $kind: "Result"; Result: number }
                | { $kind: "NestedResult"; NestedResult: [number, number] },
            command: Command,
        ) => void

      Returns void

    • Parameters

      • fn: (
            arg:
                | { $kind: "GasCoin"; GasCoin: true }
                | { $kind: "Input"; Input: number; type?: "pure" }
                | { $kind: "Input"; Input: number; type?: "object" }
                | { $kind: "Result"; Result: number }
                | { $kind: "NestedResult"; NestedResult: [number, number] },
            command: Command,
        ) =>
            | { $kind: "GasCoin"; GasCoin: true }
            | { $kind: "Input"; Input: number; type?: "pure" }
            | { $kind: "Input"; Input: number; type?: "object" }
            | { $kind: "Result"; Result: number }
            | { $kind: "NestedResult"; NestedResult: [number, number] }

      Returns void

    • Parameters

      Returns void

    • Returns {
          commands: EnumOutputShapeWithKeys<
              {
                  $Intent: {
                      data: { [key: string]: unknown };
                      inputs: {
                          [key: string]:
                              | { $kind: "GasCoin"; GasCoin: true }
                              | { $kind: "Input"; Input: number; type?: "pure" }
                              | { $kind: "Input"; Input: number; type?: "object" }
                              | { $kind: "Result"; Result: number }
                              | { $kind: "NestedResult"; NestedResult: [number, number] }
                              | (
                                  | { $kind: "GasCoin"; GasCoin: true }
                                  | { $kind: "Input"; Input: number; type?: (...) | (...) }
                                  | { $kind: "Input"; Input: number; type?: (...) | (...) }
                                  | { $kind: "Result"; Result: number }
                                  | { $kind: "NestedResult"; NestedResult: [(...), (...)] }
                              )[];
                      };
                      name: string;
                  };
                  MakeMoveVec: {
                      elements: (
                          | { $kind: "GasCoin"; GasCoin: true }
                          | { $kind: "Input"; Input: number; type?: "pure" }
                          | { $kind: "Input"; Input: number; type?: "object" }
                          | { $kind: "Result"; Result: number }
                          | { $kind: "NestedResult"; NestedResult: [number, number] }
                      )[];
                      type: null | string;
                  };
                  MergeCoins: {
                      destination: | { $kind: "GasCoin"; GasCoin: true }
                      | { $kind: "Input"; Input: number; type?: "pure" }
                      | { $kind: "Input"; Input: number; type?: "object" }
                      | { $kind: "Result"; Result: number }
                      | { $kind: "NestedResult"; NestedResult: [number, number] };
                      sources: (
                          | { $kind: "GasCoin"; GasCoin: true }
                          | { $kind: "Input"; Input: number; type?: "pure" }
                          | { $kind: "Input"; Input: number; type?: "object" }
                          | { $kind: "Result"; Result: number }
                          | { $kind: "NestedResult"; NestedResult: [number, number] }
                      )[];
                  };
                  MoveCall: {
                      _argumentTypes?: | null
                      | { body: OpenMoveTypeSignatureBody; ref: null
                      | "&"
                      | "&mut" }[];
                      arguments: (
                          | { $kind: "GasCoin"; GasCoin: true }
                          | { $kind: "Input"; Input: number; type?: "pure" }
                          | { $kind: "Input"; Input: number; type?: "object" }
                          | { $kind: "Result"; Result: number }
                          | { $kind: "NestedResult"; NestedResult: [number, number] }
                      )[];
                      function: string;
                      module: string;
                      package: string;
                      typeArguments: string[];
                  };
                  Publish: { dependencies: string[]; modules: string[] };
                  SplitCoins: {
                      amounts: (
                          | { $kind: "GasCoin"; GasCoin: true }
                          | { $kind: "Input"; Input: number; type?: "pure" }
                          | { $kind: "Input"; Input: number; type?: "object" }
                          | { $kind: "Result"; Result: number }
                          | { $kind: "NestedResult"; NestedResult: [number, number] }
                      )[];
                      coin:
                          | { $kind: "GasCoin"; GasCoin: true }
                          | { $kind: "Input"; Input: number; type?: "pure" }
                          | { $kind: "Input"; Input: number; type?: "object" }
                          | { $kind: "Result"; Result: number }
                          | { $kind: "NestedResult"; NestedResult: [number, number] };
                  };
                  TransferObjects: {
                      address: | { $kind: "GasCoin"; GasCoin: true }
                      | { $kind: "Input"; Input: number; type?: "pure" }
                      | { $kind: "Input"; Input: number; type?: "object" }
                      | { $kind: "Result"; Result: number }
                      | { $kind: "NestedResult"; NestedResult: [number, number] };
                      objects: (
                          | { $kind: "GasCoin"; GasCoin: true }
                          | { $kind: "Input"; Input: number; type?: "pure" }
                          | { $kind: "Input"; Input: number; type?: "object" }
                          | { $kind: "Result"; Result: number }
                          | { $kind: "NestedResult"; NestedResult: [number, number] }
                      )[];
                  };
                  Upgrade: {
                      dependencies: string[];
                      modules: string[];
                      package: string;
                      ticket: | { $kind: "GasCoin"; GasCoin: true }
                      | { $kind: "Input"; Input: number; type?: "pure" }
                      | { $kind: "Input"; Input: number; type?: "object" }
                      | { $kind: "Result"; Result: number }
                      | { $kind: "NestedResult"; NestedResult: [number, number] };
                  };
              },
              | "MoveCall"
              | "TransferObjects"
              | "SplitCoins"
              | "MergeCoins"
              | "Publish"
              | "MakeMoveVec"
              | "Upgrade"
              | "$Intent",
          >[];
          expiration?: | null
          | EnumOutputShapeWithKeys<
              { Epoch: string
              | number; None: true },
              "None" | "Epoch",
          >;
          gasData: {
              budget: null | string | number;
              owner: null | string;
              payment:
                  | null
                  | { digest: string; objectId: string; version: string
                  | number }[];
              price: null | string | number;
          };
          inputs: EnumOutputShapeWithKeys<
              {
                  Object: EnumOutputShapeWithKeys<
                      {
                          ImmOrOwnedObject: {
                              digest: string;
                              objectId: string;
                              version: string
                              | number;
                          };
                          Receiving: {
                              digest: string;
                              objectId: string;
                              version: string
                              | number;
                          };
                          SharedObject: {
                              initialSharedVersion: string
                              | number;
                              mutable: boolean;
                              objectId: string;
                          };
                      },
                      "ImmOrOwnedObject"
                      | "SharedObject"
                      | "Receiving",
                  >;
                  Pure: { bytes: string };
                  UnresolvedObject: {
                      digest?: null | string;
                      initialSharedVersion?: null | string | number;
                      objectId: string;
                      version?: null | string | number;
                  };
                  UnresolvedPure: { value: unknown };
              },
              "Pure"
              | "Object"
              | "UnresolvedPure"
              | "UnresolvedObject",
          >[];
          sender?: null | string;
          version: 2;
      }

    • Generate transaction digest.

      Parameters

      • bytes: Uint8Array

        BCS serialized transaction data

      Returns string

      transaction digest.

    • Parameters

      • data:
            | {
                expiration?: null
                | { Epoch: number }
                | { None: null | true };
                gasConfig: {
                    budget?: string | number | bigint;
                    owner?: string;
                    payment?: {
                        digest: string;
                        objectId: string;
                        version: string | number | bigint;
                    }[];
                    price?: string
                    | number
                    | bigint;
                };
                inputs: (
                    | { index: number; kind: "Input"; type?: "object"; value: unknown }
                    | { index: number; kind: "Input"; type: "pure"; value: unknown }
                )[];
                sender?: string;
                transactions: (
                    | {
                        arguments: (
                            | { index: number; kind: "Input"; type?: "object"; value: unknown }
                            | { index: number; kind: "Input"; type: "pure"; value: unknown }
                            | { kind: "GasCoin" }
                            | { index: number; kind: "Result" }
                            | { index: number; kind: "NestedResult"; resultIndex: number }
                        )[];
                        kind: "MoveCall";
                        target: `${string}::${string}::${string}`;
                        typeArguments: string[];
                    }
                    | {
                        address: | {
                            index: number;
                            kind: "Input";
                            type?: "object";
                            value: unknown;
                        }
                        | { index: number; kind: "Input"; type: "pure"; value: unknown }
                        | { kind: "GasCoin" }
                        | { index: number; kind: "Result" }
                        | { index: number; kind: "NestedResult"; resultIndex: number };
                        kind: "TransferObjects";
                        objects: (
                            | { index: number; kind: "Input"; type?: "object"; value: unknown }
                            | { index: number; kind: "Input"; type: "pure"; value: unknown }
                            | { kind: "GasCoin" }
                            | { index: number; kind: "Result" }
                            | { index: number; kind: "NestedResult"; resultIndex: number }
                        )[];
                    }
                    | {
                        amounts: (
                            | { index: number; kind: "Input"; type?: "object"; value: unknown }
                            | { index: number; kind: "Input"; type: "pure"; value: unknown }
                            | { kind: "GasCoin" }
                            | { index: number; kind: "Result" }
                            | { index: number; kind: "NestedResult"; resultIndex: number }
                        )[];
                        coin:
                            | { index: number; kind: "Input"; type?: "object"; value: unknown }
                            | { index: number; kind: "Input"; type: "pure"; value: unknown }
                            | { kind: "GasCoin" }
                            | { index: number; kind: "Result" }
                            | { index: number; kind: "NestedResult"; resultIndex: number };
                        kind: "SplitCoins";
                    }
                    | {
                        destination: | {
                            index: number;
                            kind: "Input";
                            type?: "object";
                            value: unknown;
                        }
                        | { index: number; kind: "Input"; type: "pure"; value: unknown }
                        | { kind: "GasCoin" }
                        | { index: number; kind: "Result" }
                        | { index: number; kind: "NestedResult"; resultIndex: number };
                        kind: "MergeCoins";
                        sources: (
                            | { index: number; kind: "Input"; type?: "object"; value: unknown }
                            | { index: number; kind: "Input"; type: "pure"; value: unknown }
                            | { kind: "GasCoin" }
                            | { index: number; kind: "Result" }
                            | { index: number; kind: "NestedResult"; resultIndex: number }
                        )[];
                    }
                    | {
                        kind: "MakeMoveVec";
                        objects: (
                            | { index: number; kind: "Input"; type?: "object"; value: unknown }
                            | { index: number; kind: "Input"; type: "pure"; value: unknown }
                            | { kind: "GasCoin" }
                            | { index: number; kind: "Result" }
                            | { index: number; kind: "NestedResult"; resultIndex: number }
                        )[];
                        type: { Some: TypeTag } | { None: null | true };
                    }
                    | { dependencies: string[]; kind: "Publish"; modules: number[][] }
                    | {
                        dependencies: string[];
                        kind: "Upgrade";
                        modules: number[][];
                        packageId: string;
                        ticket:
                            | { index: number; kind: "Input"; type?: "object"; value: unknown }
                            | { index: number; kind: "Input"; type: "pure"; value: unknown }
                            | { kind: "GasCoin" }
                            | { index: number; kind: "Result" }
                            | { index: number; kind: "NestedResult"; resultIndex: number };
                    }
                )[];
                version: 1;
            }
            | {
                commands: EnumInputShape<
                    {
                        $Intent: {
                            data: { [key: string]: unknown };
                            inputs: {
                                [key: string]:
                                    | EnumInputShape<
                                        {
                                            GasCoin: true;
                                            Input: number;
                                            NestedResult: [(...), (...)];
                                            Result: number;
                                        },
                                    >
                                    | EnumInputShape<
                                        { GasCoin: ...; Input: ...; NestedResult: ...; Result: ... },
                                    >[];
                            };
                            name: string;
                        };
                        MakeMoveVec: {
                            elements: EnumInputShape<
                                {
                                    GasCoin: true;
                                    Input: number;
                                    NestedResult: [number, number];
                                    Result: number;
                                },
                            >[];
                            type: null
                            | string;
                        };
                        MergeCoins: {
                            destination: EnumInputShape<
                                {
                                    GasCoin: true;
                                    Input: number;
                                    NestedResult: [number, number];
                                    Result: number;
                                },
                            >;
                            sources: EnumInputShape<
                                {
                                    GasCoin: true;
                                    Input: number;
                                    NestedResult: [number, number];
                                    Result: number;
                                },
                            >[];
                        };
                        MoveCall: {
                            arguments: EnumInputShape<
                                {
                                    GasCoin: true;
                                    Input: number;
                                    NestedResult: [number, number];
                                    Result: number;
                                },
                            >[];
                            function: string;
                            module: string;
                            package: string;
                            typeArguments: string[];
                        };
                        Publish: { dependencies: string[]; modules: string[] };
                        SplitCoins: {
                            amounts: EnumInputShape<
                                {
                                    GasCoin: true;
                                    Input: number;
                                    NestedResult: [number, number];
                                    Result: number;
                                },
                            >[];
                            coin: EnumInputShape<
                                {
                                    GasCoin: true;
                                    Input: number;
                                    NestedResult: [number, number];
                                    Result: number;
                                },
                            >;
                        };
                        TransferObjects: {
                            address: EnumInputShape<
                                {
                                    GasCoin: true;
                                    Input: number;
                                    NestedResult: [number, number];
                                    Result: number;
                                },
                            >;
                            objects: EnumInputShape<
                                {
                                    GasCoin: true;
                                    Input: number;
                                    NestedResult: [number, number];
                                    Result: number;
                                },
                            >[];
                        };
                        Upgrade: {
                            dependencies: string[];
                            modules: string[];
                            package: string;
                            ticket: EnumInputShape<
                                {
                                    GasCoin: true;
                                    Input: number;
                                    NestedResult: [number, number];
                                    Result: number;
                                },
                            >;
                        };
                    },
                >[];
                expiration?: null
                | EnumInputShape<{ Epoch: string | number; None: true }>;
                gasData: {
                    budget: null | string | number;
                    owner: null | string;
                    payment:
                        | null
                        | { digest: string; objectId: string; version: string
                        | number }[];
                    price: null | string | number;
                };
                inputs: EnumInputShape<
                    {
                        Object: EnumInputShape<
                            {
                                ImmOrOwnedObject: {
                                    digest: string;
                                    objectId: string;
                                    version: string
                                    | number;
                                };
                                Receiving: {
                                    digest: string;
                                    objectId: string;
                                    version: string
                                    | number;
                                };
                                SharedObject: {
                                    initialSharedVersion: string
                                    | number;
                                    mutable: boolean;
                                    objectId: string;
                                };
                            },
                        >;
                        Pure: { bytes: string };
                        UnresolvedObject: {
                            digest?: null | string;
                            initialSharedVersion?: null | string | number;
                            objectId: string;
                            version?: null | string | number;
                        };
                        UnresolvedPure: { value: unknown };
                    },
                >[];
                sender?: null
                | string;
                version: 2;
            }

      Returns TransactionDataBuilder

    MMNEPVFCICPMFPCPTTAAATR