Class Transaction

Transaction Builder

Constructors

constructor

new Transaction(): Transaction
Returns Transaction
- Defined in sdk/typescript/src/transactions/Transaction.ts:236

Accessors

[TRANSACTION_BRAND]

get [TRANSACTION_BRAND](): boolean
Returns boolean
- Defined in sdk/typescript/src/transactions/Transaction.ts:203

blockData

get blockData(): {
    expiration: undefined | 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: undefined | 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;
}
- expiration: undefined | 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;
  }
  - Optional budget?: string | number | bigint
  - Optional owner?: string
  - Optional payment?: {
        digest: string;
        objectId: string;
        version: string | number | bigint;
    }[]
  - Optional price?: string | number | bigint
- inputs: ({
      index: number;
      kind: "Input";
      type?: "object";
      value: unknown;
  } | {
      index: number;
      kind: "Input";
      type: "pure";
      value: unknown;
  })[]
- Optional 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 sdk/typescript/src/transactions/Transaction.ts:192

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;
}
- $kind: "GasCoin"
- GasCoin: true
- Defined in sdk/typescript/src/transactions/Transaction.ts:241

pure

get pure(): {
    id: ((value) => {
        $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): {
        $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): {
        $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): {
        $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): {
        $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): {
        $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): {
        $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): {
        $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): {
        $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): {
        $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): Argument;
}
Returns {
    id: ((value) => {
        $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): {
        $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): {
        $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): {
        $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): {
        $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): {
        $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): {
        $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): {
        $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): {
        $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): {
        $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): Argument;
}
- - (value): Argument
  - Parameters
    - value: Uint8Array | 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 Argument
- id: ((value) => {
      $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): {
          $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];
      }
- address:function
  - address(value): {
        $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 sdk/typescript/src/transactions/pure.ts:28
- bool:function
  - bool(value): {
        $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 sdk/typescript/src/transactions/pure.ts:26
- string:function
  - string(value): {
        $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 sdk/typescript/src/transactions/pure.ts:27
- u128:function
  - u128(value): {
        $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 sdk/typescript/src/transactions/pure.ts:24
- u16:function
  - u16(value): {
        $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 sdk/typescript/src/transactions/pure.ts:21
- u256:function
  - u256(value): {
        $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 sdk/typescript/src/transactions/pure.ts:25
- u32:function
  - u32(value): {
        $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 sdk/typescript/src/transactions/pure.ts:22
- u64:function
  - u64(value): {
        $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 sdk/typescript/src/transactions/pure.ts:23
- u8:function
  - u8(value): {
        $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 sdk/typescript/src/transactions/pure.ts:20
- Defined in sdk/typescript/src/transactions/Transaction.ts:208

Methods

add

add<T>(command): T
Add a transaction to the transaction
Type Parameters
- T = TransactionResult
Parameters
- command: Command | ((tx) => T)
Returns T
- Defined in sdk/typescript/src/transactions/Transaction.ts:305

addBuildPlugin

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

addIntentResolver

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

addSerializationPlugin

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

build

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

getData

getData(): {
    commands: EnumOutputShapeWithKeys<{
        $Intent: {
            data: {};
            inputs: {};
            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: undefined | 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: undefined | null | string;
    version: 2;
}
Get a snapshot of the transaction data, in JSON form:

Returns {
    commands: EnumOutputShapeWithKeys<{
        $Intent: {
            data: {};
            inputs: {};
            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: undefined | 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: undefined | null | string;
    version: 2;
}
- commands: EnumOutputShapeWithKeys<{
      $Intent: {
          data: {};
          inputs: {};
          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: undefined | 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;
  }
  - 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: undefined | null | string
- version: 2
- Defined in sdk/typescript/src/transactions/Transaction.ts:197

getDigest

getDigest(options?): Promise<string>
Derive transaction digest
Parameters
- options: {
  client?: SuiClient;
  } = {}
  - Optional client?: SuiClient
Returns Promise<string>
- Defined in sdk/typescript/src/transactions/Transaction.ts:472

makeMoveVec

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

mergeCoins

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

moveCall

moveCall(__namedParameters): 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 sdk/typescript/src/transactions/Transaction.ts:387

object

object(value): {
    $kind: "Input";
    Input: number;
    type?: "object";
}
Add a new object input to the transaction.
Parameters
- value: TransactionObjectInput
Returns {
    $kind: "Input";
    Input: number;
    type?: "object";
}
- $kind: "Input"
- Input: number
- Optional type?: "object"
- Defined in sdk/typescript/src/transactions/Transaction.ts:248

objectRef

objectRef(...args): {
    $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
- Rest ...args: [{
      digest: string;
      objectId: string;
      version: string | number;
  }]
Returns {
    $kind: "Input";
    Input: number;
    type?: "object";
}
- $kind: "Input"
- Input: number
- Optional type?: "object"
- Defined in sdk/typescript/src/transactions/Transaction.ts:284

prepareForSerialization

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

publish

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

receivingRef

receivingRef(...args): {
    $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
- Rest ...args: [{
      digest: string;
      objectId: string;
      version: string | number;
  }]
Returns {
    $kind: "Input";
    Input: number;
    type?: "object";
}
- $kind: "Input"
- Input: number
- Optional type?: "object"
- Defined in sdk/typescript/src/transactions/Transaction.ts:292

serialize

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

setExpiration

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

setGasBudget

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

setGasOwner

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

setGasPayment

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

setGasPrice

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

setSender

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

setSenderIfNotSet

setSenderIfNotSet(sender): 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 sdk/typescript/src/transactions/Transaction.ts:168

sharedObjectRef

sharedObjectRef(...args): {
    $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
- Rest ...args: [{
      initialSharedVersion: string | number;
      mutable: boolean;
      objectId: string;
  }]
Returns {
    $kind: "Input";
    Input: number;
    type?: "object";
}
- $kind: "Input"
- Input: number
- Optional type?: "object"
- Defined in sdk/typescript/src/transactions/Transaction.ts:300

sign

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

splitCoins

splitCoins(coin, amounts): TransactionResult
Parameters
- coin: string | TransactionObjectArgument
- amounts: (string | number | bigint | SerializedBcs<any, any> | TransactionArgument)[]
Returns TransactionResult
- Defined in sdk/typescript/src/transactions/Transaction.ts:333

toJSON

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

transferObjects

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

upgrade

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

`Static` from

from(transaction): 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 | Transaction
Returns Transaction
- Defined in sdk/typescript/src/transactions/Transaction.ts:129

`Static` fromKind

fromKind(serialized): 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
Returns Transaction
- Defined in sdk/typescript/src/transactions/Transaction.ts:113

Class Transaction

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns Transaction

Accessors

[TRANSACTION_BRAND]

Returns boolean

blockData

expiration: undefined | 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; }

Optional budget?: string | number | bigint

Optional owner?: string

Optional payment?: { digest: string; objectId: string; version: string | number | bigint; }[]

Optional price?: string | number | bigint

inputs: ({ index: number; kind: "Input"; type?: "object"; value: unknown; } | { index: number; kind: "Input"; type: "pure"; value: unknown; })[]

Optional sender?: string

version: 1

Deprecated

gas

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

$kind: "GasCoin"

GasCoin: true

pure

Parameters

Returns Argument

id: ((value) => { $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]; }

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]; }

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]; }

Methods

add

Type Parameters

Parameters

Returns T

addBuildPlugin

Parameters

Returns void

addIntentResolver

Parameters

Returns void

addSerializationPlugin

Parameters

Returns void

build

Parameters

Returns Promise<Uint8Array>

getData

expiration: undefined | 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; }

budget: null | string | number

expiration: undefined | 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;
}

`Optional` budget?: string | number | bigint

`Optional` owner?: string

`Optional` payment?: {
digest: string;
objectId: string;
version: string | number | bigint;
}[]

`Optional` price?: string | number | bigint

inputs: ({
index: number;
kind: "Input";
type?: "object";
value: unknown;
} | {
index: number;
kind: "Input";
type: "pure";
value: unknown;
})[]

`Optional` sender?: string

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

id: ((value) => {
$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];
}

expiration: undefined | 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;
}

payment: null | {
digest: string;
objectId: string;
version: string | number;
}[]

`Optional` client?: SuiClient

`Optional` type?: string

Returns {
$kind: "Input";
Input: number;
type?: "object";
}

`Optional` type?: "object"

Returns {
$kind: "Input";
Input: number;
type?: "object";
}

`Optional` type?: "object"

Returns {
$kind: "Input";
Input: number;
type?: "object";
}

`Optional` type?: "object"