Class Transaction

Transaction Builder

Indexable

[key: number]: boolean

Constructors

constructor

new Transaction(): Transaction
Returns Transaction
- Defined in packages/typescript/src/transactions/Transaction.ts:356

Properties

object

object: {
    clock(): { $kind: "Input"; Input: number; type?: "object" };
    denyList(
        options?: { mutable?: boolean },
    ): { $kind: "Input"; Input: number; type?: "object" };
    option(
        __namedParameters: {
            type: string;
            value: null | TransactionObjectInput;
        },
    ): (tx: Transaction) => TransactionResult;
    random(): { $kind: "Input"; Input: number; type?: "object" };
    system(
        options?: { mutable?: boolean },
    ): { $kind: "Input"; Input: number; type?: "object" };
    (
        value: TransactionObjectInput,
    ): { $kind: "Input"; Input: number; type?: "object" };
} = ...

Add a new object input to the transaction.

Accessors

blockData

get blockData(): {
    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;
}
Returns {
    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;
}
Deprecated
Use getData() instead.
- Defined in packages/typescript/src/transactions/Transaction.ts:312

gas

get gas(): { $kind: "GasCoin"; GasCoin: true }
Returns an argument for the gas coin, to be used in a transaction.

Returns { $kind: "GasCoin"; GasCoin: true }
- Defined in packages/typescript/src/transactions/Transaction.ts:364

pure

get pure(): {
    id: (
        value: 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] };
    address(
        value: 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] };
    bool(
        value: boolean,
    ):
        | { $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] };
    option<Type extends PureTypeName>(
        type: Type extends PureTypeName ? ValidPureTypeName<Type<Type>> : Type,
        value: undefined | null | ShapeFromPureTypeName<Type>,
    ):
        | { $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] };
    string(
        value: 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] };
    u128(
        value: string | number | bigint,
    ):
        | { $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] };
    u16(
        value: number,
    ):
        | { $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] };
    u256(
        value: string | number | bigint,
    ):
        | { $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] };
    u32(
        value: number,
    ):
        | { $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] };
    u64(
        value: string | number | bigint,
    ):
        | { $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] };
    u8(
        value: number,
    ):
        | { $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] };
    vector<Type extends PureTypeName>(
        type: Type extends PureTypeName ? ValidPureTypeName<Type<Type>> : Type,
        value: Iterable<ShapeFromPureTypeName<Type>, any, any> & {
            length: number;
        },
    ): | { $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 extends PureTypeName>(
        type: Type extends PureTypeName ? ValidPureTypeName<Type<Type>> : Type,
        value: ShapeFromPureTypeName<Type>,
    ):
        | { $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] };
    (
        value: Uint8Array<ArrayBufferLike> | SerializedBcs<any, any>,
    ):
        | { $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 {
    id: (
        value: 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] };
    address(
        value: 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] };
    bool(
        value: boolean,
    ):
        | { $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] };
    option<Type extends PureTypeName>(
        type: Type extends PureTypeName ? ValidPureTypeName<Type<Type>> : Type,
        value: undefined | null | ShapeFromPureTypeName<Type>,
    ):
        | { $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] };
    string(
        value: 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] };
    u128(
        value: string | number | bigint,
    ):
        | { $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] };
    u16(
        value: number,
    ):
        | { $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] };
    u256(
        value: string | number | bigint,
    ):
        | { $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] };
    u32(
        value: number,
    ):
        | { $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] };
    u64(
        value: string | number | bigint,
    ):
        | { $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] };
    u8(
        value: number,
    ):
        | { $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] };
    vector<Type extends PureTypeName>(
        type: Type extends PureTypeName ? ValidPureTypeName<Type<Type>> : Type,
        value: Iterable<ShapeFromPureTypeName<Type>, any, any> & {
            length: number;
        },
    ): | { $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 extends PureTypeName>(
        type: Type extends PureTypeName ? ValidPureTypeName<Type<Type>> : Type,
        value: ShapeFromPureTypeName<Type>,
    ):
        | { $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] };
    (
        value: Uint8Array<ArrayBufferLike> | SerializedBcs<any, any>,
    ):
        | { $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 extends PureTypeName>(
        type: Type extends PureTypeName ? ValidPureTypeName<Type<Type>> : Type,
        value: ShapeFromPureTypeName<Type>,
    ):
        | { $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 Parameters
    Type extends PureTypeName
    Parameters
    type: Type extends PureTypeName ? ValidPureTypeName<Type<Type>> : Type
    value: ShapeFromPureTypeName<Type>
    Returns
        | { $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] }
  - (
        value: Uint8Array<ArrayBufferLike> | SerializedBcs<any, any>,
    ):
        | { $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] }
  - Parameters
    value: Uint8Array<ArrayBufferLike> | SerializedBcs<any, any>
    The pure value, serialized to BCS. If this is a Uint8Array, then the value is assumed to be raw bytes, and will be used directly.
    Returns
        | { $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] }
- id: (
      value: 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] }
- address: function
  - address(
        value: 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] }
    Parameters
    value: string
    Returns
        | { $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] }
    Defined in packages/typescript/src/transactions/pure.ts:48
- bool: function
  - bool(
        value: boolean,
    ):
        | { $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] }
    Parameters
    value: boolean
    Returns
        | { $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] }
    Defined in packages/typescript/src/transactions/pure.ts:46
- option: function
  - option<Type extends PureTypeName>(
        type: Type extends PureTypeName ? ValidPureTypeName<Type<Type>> : Type,
        value: undefined | null | ShapeFromPureTypeName<Type>,
    ):
        | { $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 Parameters
    Type extends PureTypeName
    Parameters
    type: Type extends PureTypeName ? ValidPureTypeName<Type<Type>> : Type
    value: undefined | null | ShapeFromPureTypeName<Type>
    Returns
        | { $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] }
    Defined in packages/typescript/src/transactions/pure.ts:58
- string: function
  - string(
        value: 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] }
    Parameters
    value: string
    Returns
        | { $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] }
    Defined in packages/typescript/src/transactions/pure.ts:47
- u128: function
  - u128(
        value: string | number | bigint,
    ):
        | { $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] }
    Parameters
    value: string | number | bigint
    Returns
        | { $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] }
    Defined in packages/typescript/src/transactions/pure.ts:44
- u16: function
  - u16(
        value: number,
    ):
        | { $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] }
    Parameters
    value: number
    Returns
        | { $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] }
    Defined in packages/typescript/src/transactions/pure.ts:41
- u256: function
  - u256(
        value: string | number | bigint,
    ):
        | { $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] }
    Parameters
    value: string | number | bigint
    Returns
        | { $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] }
    Defined in packages/typescript/src/transactions/pure.ts:45
- u32: function
  - u32(
        value: number,
    ):
        | { $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] }
    Parameters
    value: number
    Returns
        | { $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] }
    Defined in packages/typescript/src/transactions/pure.ts:42
- u64: function
  - u64(
        value: string | number | bigint,
    ):
        | { $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] }
    Parameters
    value: string | number | bigint
    Returns
        | { $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] }
    Defined in packages/typescript/src/transactions/pure.ts:43
- u8: function
  - u8(
        value: number,
    ):
        | { $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] }
    Parameters
    value: number
    Returns
        | { $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] }
    Defined in packages/typescript/src/transactions/pure.ts:40
- vector: function
  - vector<Type extends PureTypeName>(
        type: Type extends PureTypeName ? ValidPureTypeName<Type<Type>> : Type,
        value: Iterable<ShapeFromPureTypeName<Type>, any, any> & { length: number },
    ):
        | { $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 Parameters
    Type extends PureTypeName
    Parameters
    type: Type extends PureTypeName ? ValidPureTypeName<Type<Type>> : Type
    value: Iterable<ShapeFromPureTypeName<Type>, any, any> & { length: number }
    Returns
        | { $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] }
    Defined in packages/typescript/src/transactions/pure.ts:50
- Defined in packages/typescript/src/transactions/Transaction.ts:328

Methods

add

add<T extends Command>(command: T): TransactionResult
Add a transaction to the transaction
Type Parameters
- T extends Command
Parameters
- command: T
Returns TransactionResult
- Defined in packages/typescript/src/transactions/Transaction.ts:453
add<T extends void | Command | TransactionResultArgument | TransactionArgument>(
thunk: (tx: Transaction) => T,
): T
Add a transaction to the transaction
Type Parameters
- T extends void | Command | TransactionResultArgument | TransactionArgument
Parameters
- thunk: (tx: Transaction) => T
Returns T
- Defined in packages/typescript/src/transactions/Transaction.ts:454
add<T extends void | TransactionResultArgument>(
asyncTransactionThunk: AsyncTransactionThunk<T>,
): T
Add a transaction to the transaction
Type Parameters
- T extends void | TransactionResultArgument
Parameters
- asyncTransactionThunk: AsyncTransactionThunk<T>
Returns T
- Defined in packages/typescript/src/transactions/Transaction.ts:457

addBuildPlugin

addBuildPlugin(step: TransactionPlugin): void
Parameters
- step: TransactionPlugin
Returns void
- Defined in packages/typescript/src/transactions/Transaction.ts:262

addIntentResolver

addIntentResolver(intent: string, resolver: TransactionPlugin): void
Parameters
- intent: string
- resolver: TransactionPlugin
Returns void
- Defined in packages/typescript/src/transactions/Transaction.ts:266

addSerializationPlugin

addSerializationPlugin(step: TransactionPlugin): void
Parameters
- step: TransactionPlugin
Returns void
- Defined in packages/typescript/src/transactions/Transaction.ts:258

build

build(options?: BuildTransactionOptions): Promise<Uint8Array<ArrayBuffer>>
Build the transaction to BCS bytes.
Parameters
- options: BuildTransactionOptions = {}
Returns Promise<Uint8Array<ArrayBuffer>>
- Defined in packages/typescript/src/transactions/Transaction.ts:736

getData

getData(): {
    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;
                mutable?: null | boolean;
                objectId: string;
                version?: null | string | number;
            };
            UnresolvedPure: { value: unknown };
        },
        "Pure"
        | "Object"
        | "UnresolvedPure"
        | "UnresolvedObject",
    >[];
    sender?: null | string;
    version: 2;
}
Get a snapshot of the transaction data, in JSON form:

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;
                mutable?: null | boolean;
                objectId: string;
                version?: null | string | number;
            };
            UnresolvedPure: { value: unknown };
        },
        "Pure"
        | "Object"
        | "UnresolvedPure"
        | "UnresolvedObject",
    >[];
    sender?: null | string;
    version: 2;
}
- Defined in packages/typescript/src/transactions/Transaction.ts:317

getDigest

getDigest(options?: { client?: ClientWithCoreApi }): Promise<string>
Derive transaction digest
Parameters
- options: { client?: ClientWithCoreApi } = {}
Returns Promise<string>
- Defined in packages/typescript/src/transactions/Transaction.ts:745

isFullyResolved

isFullyResolved(): boolean
Ensures that:
- All objects have been fully resolved to a specific version
- All pure inputs have been serialized to bytes
- All async thunks have been fully resolved
- All transaction intents have been resolved
  - The gas payment, budget, and price have been set
- The transaction sender has been set
When true, the transaction will always be built to the same bytes and digest (unless the transaction is mutated)
Returns boolean
- Defined in packages/typescript/src/transactions/Transaction.ts:715

makeMoveVec

makeMoveVec(
    __namedParameters: {
        elements: (string | TransactionObjectArgument)[];
        type?: string;
    },
): TransactionResult
Parameters
- __namedParameters: { elements: (string | TransactionObjectArgument)[]; type?: string }
Returns TransactionResult
- Defined in packages/typescript/src/transactions/Transaction.ts:656

mergeCoins

mergeCoins(
destination: string | TransactionObjectArgument,
sources: (string | TransactionObjectArgument)[],
): TransactionResult
Parameters
- destination: string | TransactionObjectArgument
- sources: (string | TransactionObjectArgument)[]
Returns TransactionResult
- Defined in packages/typescript/src/transactions/Transaction.ts:581

moveCall

moveCall(
    __namedParameters:
        | {
            arguments?: (SerializedBcs<any, any> | TransactionArgument)[];
            function: string;
            module: string;
            package: string;
            typeArguments?: string[];
        }
        | {
            arguments?: (SerializedBcs<any, any> | TransactionArgument)[];
            target: string;
            typeArguments?: string[];
        },
): TransactionResult
Parameters
- __namedParameters:
      | {
          arguments?: (SerializedBcs<any, any> | TransactionArgument)[];
          function: string;
          module: string;
          package: string;
          typeArguments?: string[];
      }
      | {
          arguments?: (SerializedBcs<any, any> | TransactionArgument)[];
          target: string;
          typeArguments?: string[];
      }
Returns TransactionResult
- Defined in packages/typescript/src/transactions/Transaction.ts:620

objectRef

objectRef(
    ...args: [
        { digest: string; objectId: string; version: string
        | number },
    ],
): { $kind: "Input"; Input: number; type?: "object" }
Add a new object input to the transaction using the fully-resolved object reference. If you only have an object ID, use builder.object(id) instead.
Parameters
- ...args: [{ digest: string; objectId: string; version: string | number }]
Returns { $kind: "Input"; Input: number; type?: "object" }
- Defined in packages/typescript/src/transactions/Transaction.ts:415

prepareForSerialization

prepareForSerialization(options: SerializeTransactionOptions): Promise<void>
Parameters
- options: SerializeTransactionOptions
Returns Promise<void>
- Defined in packages/typescript/src/transactions/Transaction.ts:898

publish

publish(
    __namedParameters: {
        dependencies: string[];
        modules: string[] | number[][];
    },
): TransactionResult
Parameters
- __namedParameters: { dependencies: string[]; modules: string[] | number[][] }
Returns TransactionResult
- Defined in packages/typescript/src/transactions/Transaction.ts:592

receivingRef

receivingRef(
    ...args: [
        { digest: string; objectId: string; version: string
        | number },
    ],
): { $kind: "Input"; Input: number; type?: "object" }
Add a new receiving input to the transaction using the fully-resolved object reference. If you only have an object ID, use builder.object(id) instead.
Parameters
- ...args: [{ digest: string; objectId: string; version: string | number }]
Returns { $kind: "Input"; Input: number; type?: "object" }
- Defined in packages/typescript/src/transactions/Transaction.ts:423

serialize

serialize(): string
Returns string
Deprecated
Use toJSON instead. For synchronous serialization, you can use getData()
- Defined in packages/typescript/src/transactions/Transaction.ts:675

setExpiration

setExpiration(
    expiration?:
        | null
        | EnumInputShape<{ Epoch: string | number; None: true }>,
): void
Parameters
- Optionalexpiration: null | EnumInputShape<{ Epoch: string | number; None: true }>
Returns void
- Defined in packages/typescript/src/transactions/Transaction.ts:286

setGasBudget

setGasBudget(budget: number | bigint): void
Parameters
- budget: number | bigint
Returns void
- Defined in packages/typescript/src/transactions/Transaction.ts:292

setGasBudgetIfNotSet

setGasBudgetIfNotSet(budget: number | bigint): void
Parameters
- budget: number | bigint
Returns void
- Defined in packages/typescript/src/transactions/Transaction.ts:296

setGasOwner

setGasOwner(owner: string): void
Parameters
- owner: string
Returns void
- Defined in packages/typescript/src/transactions/Transaction.ts:302

setGasPayment

setGasPayment(
payments: { digest: string; objectId: string; version: string | number }[],
): void
Parameters
- payments: { digest: string; objectId: string; version: string | number }[]
Returns void
- Defined in packages/typescript/src/transactions/Transaction.ts:305

setGasPrice

setGasPrice(price: number | bigint): void
Parameters
- price: number | bigint
Returns void
- Defined in packages/typescript/src/transactions/Transaction.ts:289

setSender

setSender(sender: string): void
Parameters
- sender: string
Returns void
- Defined in packages/typescript/src/transactions/Transaction.ts:274

setSenderIfNotSet

setSenderIfNotSet(sender: string): void
Sets the sender only if it has not already been set. This is useful for sponsored transaction flows where the sender may not be the same as the signer address.
Parameters
- sender: string
Returns void
- Defined in packages/typescript/src/transactions/Transaction.ts:281

sharedObjectRef

sharedObjectRef(
    ...args: [
        {
            initialSharedVersion: string
            | number;
            mutable: boolean;
            objectId: string;
        },
    ],
): { $kind: "Input"; Input: number; type?: "object" }
Add a new shared object input to the transaction using the fully-resolved shared object reference. If you only have an object ID, use builder.object(id) instead.
Parameters
- ...args: [{ initialSharedVersion: string | number; mutable: boolean; objectId: string }]
Returns { $kind: "Input"; Input: number; type?: "object" }
- Defined in packages/typescript/src/transactions/Transaction.ts:431

sign

sign(options: SignOptions): Promise<SignatureWithBytes>
Build the transaction to BCS bytes, and sign it with the provided keypair.
Parameters
- options: SignOptions
Returns Promise<SignatureWithBytes>
- Defined in packages/typescript/src/transactions/Transaction.ts:698

splitCoins

splitCoins<
    const Amounts extends
        (
            | string
            | number
            | bigint
            | SerializedBcs<any, any>
            | TransactionArgument
        )[],
>(
    coin: string | TransactionObjectArgument,
    amounts: Amounts,
): { $kind: "Result"; Result: number } & {
    [K in string | number | symbol]: {
        $kind: "NestedResult";
        NestedResult: [number, number];
    }
}
Type Parameters
- const Amounts extends (string | number | bigint | SerializedBcs<any, any> | TransactionArgument)[]
Parameters
- coin: string | TransactionObjectArgument
- amounts: Amounts
Returns { $kind: "Result"; Result: number } & {
    [K in string | number | symbol]: {
        $kind: "NestedResult";
        NestedResult: [number, number];
    }
}
- Defined in packages/typescript/src/transactions/Transaction.ts:562

toJSON

toJSON(options?: SerializeTransactionOptions): Promise<string>
Parameters
- options: SerializeTransactionOptions = {}
Returns Promise<string>
- Defined in packages/typescript/src/transactions/Transaction.ts:679

transferObjects

transferObjects(
objects: (string | TransactionObjectArgument)[],
address: string | SerializedBcs<any, any> | TransactionArgument,
): TransactionResult
Parameters
- objects: (string | TransactionObjectArgument)[]
- address: string | SerializedBcs<any, any> | TransactionArgument
Returns TransactionResult
- Defined in packages/typescript/src/transactions/Transaction.ts:643

upgrade

upgrade(
    __namedParameters: {
        dependencies: string[];
        modules: string[] | number[][];
        package: string;
        ticket: string | TransactionObjectArgument;
    },
): TransactionResult
Parameters
- __namedParameters: {
      dependencies: string[];
      modules: string[] | number[][];
      package: string;
      ticket: string | TransactionObjectArgument;
  }
Returns TransactionResult
- Defined in packages/typescript/src/transactions/Transaction.ts:600

`Static`from

from(
transaction: string | Uint8Array<ArrayBufferLike> | TransactionLike,
): Transaction
Converts from a serialized transaction format to a Transaction class. There are two supported serialized formats:
- A string returned from Transaction#serialize. The serialized format must be compatible, or it will throw an error.
- A byte array (or base64-encoded bytes) containing BCS transaction data.
Parameters
- transaction: string | Uint8Array<ArrayBufferLike> | TransactionLike
Returns Transaction
- Defined in packages/typescript/src/transactions/Transaction.ts:202

`Static`fromKind

fromKind(serialized: string | Uint8Array<ArrayBufferLike>): Transaction
Converts from a serialize transaction kind (built with build({ onlyTransactionKind: true })) to a Transaction class. Supports either a byte array, or base64-encoded bytes.
Parameters
- serialized: string | Uint8Array<ArrayBufferLike>
Returns Transaction
- Defined in packages/typescript/src/transactions/Transaction.ts:182

`Static`registerGlobalBuildPlugin

registerGlobalBuildPlugin(step: TransactionPlugin): void
Parameters
- step: TransactionPlugin
Returns void
Deprecated
global plugins should be registered with a name
- Defined in packages/typescript/src/transactions/Transaction.ts:242
registerGlobalBuildPlugin(name: string, step: TransactionPlugin): void
Parameters
- name: string
- step: TransactionPlugin
Returns void
Deprecated
global plugins should be registered with a name
- Defined in packages/typescript/src/transactions/Transaction.ts:243

`Static`registerGlobalSerializationPlugin

registerGlobalSerializationPlugin(step: TransactionPlugin): void
Parameters
- step: TransactionPlugin
Returns void
Deprecated
global plugins should be registered with a name
- Defined in packages/typescript/src/transactions/Transaction.ts:225
registerGlobalSerializationPlugin(name: string, step: TransactionPlugin): void
Parameters
- name: string
- step: TransactionPlugin
Returns void
Deprecated
global plugins should be registered with a name
- Defined in packages/typescript/src/transactions/Transaction.ts:226

`Static`unregisterGlobalBuildPlugin

unregisterGlobalBuildPlugin(name: string): void
Parameters
- name: string
Returns void
- Defined in packages/typescript/src/transactions/Transaction.ts:254

`Static`unregisterGlobalSerializationPlugin

unregisterGlobalSerializationPlugin(name: string): void
Parameters
- name: string
Returns void
- Defined in packages/typescript/src/transactions/Transaction.ts:237

Class Transaction

Indexable

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Transaction

Properties

object

Accessors

blockData

Deprecated

gas

Returns { $kind: "GasCoin"; GasCoin: true }

pure

Type Parameters

Parameters

Returns | { $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] }

Parameters

Returns | { $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] }

id: ( value: 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] }

address: function

Parameters

Returns | { $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] }

bool: function

Parameters

Returns | { $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] }

option: function

Type Parameters

Parameters

Returns | { $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] }

string: function

Parameters

Returns | { $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] }

u128: function

Parameters

Returns | { $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] }

u16: function

Parameters

Returns | { $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] }

u256: function

Parameters

Returns | { $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] }

u32: function

Parameters

Returns | { $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] }

u64: function

Parameters

Returns | { $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] }

u8: function

Parameters

Returns | { $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] }

vector: function

Type Parameters

Parameters

Returns | { $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] }

Methods

add

Type Parameters

Parameters

Returns TransactionResult

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns T

addBuildPlugin

Parameters

Returns void

addIntentResolver

Parameters

Returns void

addSerializationPlugin

Parameters

Returns void

build

Returns
| { $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
| { $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] }

id: (
value: 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] }

Returns
| { $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
| { $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
| { $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
| { $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
| { $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
| { $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
| { $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
| { $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
| { $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
| { $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
| { $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 { $kind: "Result"; Result: number } & {
[K in string | number | symbol]: {
$kind: "NestedResult";
NestedResult: [number, number];
}
}