Skip to content
This repository has been archived by the owner on Jan 5, 2024. It is now read-only.

[Unity] Add contract.Prepare / tx builder #865

Merged
merged 4 commits into from
Sep 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
148 changes: 148 additions & 0 deletions docs/unity/interacting-with-contracts/prepare.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
---
title: Transaction Builder
slug: /contract.prepare
hide_title: true
---

# Transaction Builder

By default, all transactions initiated using the SDK perform every step of the process for a transaction; From preparing and building the transaction all the way to waiting until it has been mined, and the data is available to be read from the blockchain.

To gain more granular control over the transaction process, all Contract objects come with a Prepare function that returns a Transaction object, which can be used to build, fine-tune, and execute the transaction.

## Usage

```csharp
string connectedAddress = await ThirdwebManager.Instance.SDK.wallet.GetAddress();
Transaction transaction = await contract.Prepare(
functionName: "claim",
from: connectedAddress, // optional, defaults to connected address
args: new object[] { connectedAddress, 0, 1 }
);
// transaction.SetValue("0.00000000001");
// transaction.SetGasLimit("100000");

try
{
var data = await transaction.Simulate();
Debugger.Instance.Log("[Custom Call] Simulate Successful", "Data: " + data.ToString()");
}
catch (System.Exception e)
{
Debugger.Instance.Log("[Custom Call] Simulate Error", e.Message);
return;
}

await transaction.EstimateAndSetGasLimitAsync();

var gasPrice = await transaction.GetGasPrice();
Debug.Log($"Gas Price: {gasPrice}");

var gasCosts = await transaction.EstimateGasCosts();
Debug.Log($"Gas Cost: {gasCosts.wei} WEI");

Debugger.Instance.Log("[Custom Call] Transaction Preview", transaction.ToString());

try
{
string transactionResult = await transaction.Send(gasless: false);
Debugger.Instance.Log("[Custom Call] Send Successful", "Tx Hash: " + transactionResult);
}
catch (System.Exception e)
{
Debugger.Instance.Log("[Custom Call] Send Error", e.ToString());
}
}
```

## EstimateGasCost

Estimate the gas cost for a transaction.

```csharp
var gasCost = await tx.EstimateGasCosts();
```

<details>
<summary>Configuration</summary>
<div>

### Return Value

Returns the gas cost for this transaction in both `ether` and `wei`.

```csharp
GasCosts;
```

</div>
</details>

## EstimateGasLimit

Estimate the gas limit for a transaction.

```csharp
var gasLimit = await tx.EstimateGasLimit();
```

<details>
<summary>Configuration</summary>
<div>

### Return Value

Returns the gas limit for this transaction.

```csharp
BigInteger;
```

</div>
</details>

## Send

Send the transaction without waiting for it to be mined. This is useful for when you want the transaction to be executed, but don’t need the data returned.

```csharp
string txHash = await tx.Send();
```

<details>
<summary>Configuration</summary>
<div>

### Return Value

Returns the transaction hash as a `string`.

```csharp
string;
```

</div>
</details>

## Execute

Send the transaction and wait for it to be mined. This is useful for when you want the transaction to be executed, and need the data returned.

```csharp
TransactionResult result = await tx.SendAndWaitForTransactionResult();
```

<details>
<summary>Configuration</summary>
<div>

### Return Value

Returns the transaction result as a <see cref="TransactionResult"/> object.

```csharp
TransactionResult;
```

</div>
</details>
5 changes: 5 additions & 0 deletions sidebars/unity.js
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,11 @@ const sidebars = {
label: "Initiate Contract Transactions",
id: "interacting-with-contracts/write",
},
{
type: "doc",
label: "Transaction Builder",
id: "interacting-with-contracts/prepare",
},
{
type: "category",
label: "Using Extensions",
Expand Down