Skip to content

SmartContract methods for UnityAPI #597

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
noescape00 merged 4 commits into from
Jun 30, 2021
Merged

SmartContract methods for UnityAPI #597

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
907a376
added sc related api methods
noescape00 Jun 28, 2021
f4bd368
fix
noescape00 Jun 28, 2021
cb86c14
explicit return types
noescape00 Jun 28, 2021
c9fcf9b
codestyle
noescape00 Jun 28, 2021
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
133 changes: 132 additions & 1 deletion src/Stratis.Features.Unity3dApi/Controllers/Unity3dController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,35 @@
using System.Net;
using System.Threading;
using System.Threading.Tasks;
using CSharpFunctionalExtensions;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;
using NBitcoin;
using Newtonsoft.Json;
using Stratis.Bitcoin.Base;
using Stratis.Bitcoin.Controllers.Models;
using Stratis.Bitcoin.Features.BlockStore.AddressIndexing;
using Stratis.Bitcoin.Features.BlockStore.Controllers;
using Stratis.Bitcoin.Features.BlockStore.Models;
using Stratis.Bitcoin.Features.Consensus;
using Stratis.Bitcoin.Features.Consensus.CoinViews;
using Stratis.Bitcoin.Features.SmartContracts;
using Stratis.Bitcoin.Features.SmartContracts.Models;
using Stratis.Bitcoin.Features.SmartContracts.ReflectionExecutor;
using Stratis.Bitcoin.Features.SmartContracts.Wallet;
using Stratis.Bitcoin.Features.Wallet.Controllers;
using Stratis.Bitcoin.Features.Wallet.Models;
using Stratis.Bitcoin.Interfaces;
using Stratis.Bitcoin.Utilities;
using Stratis.Bitcoin.Utilities.JsonErrors;
using Stratis.Bitcoin.Utilities.ModelStateErrors;
using Stratis.SmartContracts.CLR;
using Stratis.SmartContracts.CLR.Caching;
using Stratis.SmartContracts.CLR.Compilation;
using Stratis.SmartContracts.CLR.Local;
using Stratis.SmartContracts.CLR.Serialization;
using Stratis.SmartContracts.Core.Receipts;
using Stratis.SmartContracts.Core.State;

namespace Stratis.Features.Unity3dApi.Controllers
{
Expand All @@ -45,8 +59,22 @@ public class Unity3dController : Controller
/// <summary>Instance logger.</summary>
private readonly ILogger logger;

private readonly IContractPrimitiveSerializer primitiveSerializer;

private readonly IStateRepositoryRoot stateRoot;

private readonly IContractAssemblyCache contractAssemblyCache;

private readonly IReceiptRepository receiptRepository;

private readonly ISmartContractTransactionService smartContractTransactionService;

private readonly ILocalExecutor localExecutor;

public Unity3dController(ILoggerFactory loggerFactory, IAddressIndexer addressIndexer,
IBlockStore blockStore, IChainState chainState, Network network, ICoinView coinView, WalletController walletController, ChainIndexer chainIndexer, IStakeChain stakeChain = null)
IBlockStore blockStore, IChainState chainState, Network network, ICoinView coinView, WalletController walletController, ChainIndexer chainIndexer, IStakeChain stakeChain = null,
IContractPrimitiveSerializer primitiveSerializer = null, IStateRepositoryRoot stateRoot = null, IContractAssemblyCache contractAssemblyCache = null,
IReceiptRepository receiptRepository = null, ISmartContractTransactionService smartContractTransactionService = null, ILocalExecutor localExecutor = null)
{
Guard.NotNull(loggerFactory, nameof(loggerFactory));
this.logger = loggerFactory.CreateLogger(this.GetType().FullName);
Expand All @@ -58,6 +86,13 @@ public Unity3dController(ILoggerFactory loggerFactory, IAddressIndexer addressIn
this.walletController = Guard.NotNull(walletController, nameof(walletController));
this.chainIndexer = Guard.NotNull(chainIndexer, nameof(chainIndexer));
this.stakeChain = stakeChain;

this.primitiveSerializer = primitiveSerializer;
this.stateRoot = stateRoot;
this.contractAssemblyCache = contractAssemblyCache;
this.receiptRepository = receiptRepository;
this.smartContractTransactionService = smartContractTransactionService;
this.localExecutor = localExecutor;
}

/// <summary>
Expand Down Expand Up @@ -406,5 +441,101 @@ public TipModel GetTip()
return null;
}
}

/// <summary>
/// Gets a smart contract transaction receipt. Receipts contain information about how a smart contract transaction was executed.
/// This includes the value returned from a smart contract call and how much gas was used.
/// </summary>
/// <param name="txHash">A hash of the smart contract transaction (the transaction ID).</param>
/// <returns>The receipt for the smart contract.</returns>
/// <response code="200">Returns transaction receipt</response>
/// <response code="400">Transaction not found</response>
[Route("api/[controller]/receipt")]
[HttpGet]
[ProducesResponseType((int)HttpStatusCode.OK)]
[ProducesResponseType((int)HttpStatusCode.BadRequest)]
public ReceiptResponse GetReceiptAPI([FromQuery] string txHash)
{
ReceiptResponse receiptResponse;
uint256 txHashNum = new uint256(txHash);
Receipt receipt = this.receiptRepository.Retrieve(txHashNum);

if (receipt == null)
return null;

uint160 address = receipt.NewContractAddress ?? receipt.To;

if (!receipt.Logs.Any())
{
receiptResponse = new ReceiptResponse(receipt, new List<LogResponse>(), this.network);
}
else
{
var deserializer = new ApiLogDeserializer(this.primitiveSerializer, this.network, this.stateRoot, this.contractAssemblyCache);
List<LogResponse> logResponses = deserializer.MapLogResponses(receipt.Logs);

receiptResponse = new ReceiptResponse(receipt, logResponses, this.network);
}

return receiptResponse;
Copy link
Contributor

@fassadlr fassadlr Jun 30, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good Ivan, I would just add this controller method and the one below in a try catch, like we do in all the other controller methods. Just so that there is some consistency? WDYT?

Example:

https://github.com/stratisproject/StratisFullNode/blob/master/src/Stratis.Bitcoin.Features.BlockStore/Controllers/BlockStoreController.cs#L100

Copy link
Contributor Author

@noescape00 noescape00 Jun 30, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no need for try catch since if there is an exception it will be seen in node's logs.
Also we can't use same error handling since controller's methods return explicit types, not json like our other controllers.

}

/// <summary>
/// Makes a local call to a method on a smart contract that has been successfully deployed. A transaction
/// is not created as the call is never propagated across the network. All persistent data held by the
/// smart contract is copied before the call is made. Only this copy is altered by the call
/// and the actual data is unaffected. Even if an amount of funds are specified to send with the call,
/// no funds are in fact sent.
/// The purpose of this function is to query and test methods.
/// </summary>
/// <param name="request">An object containing the necessary parameters to build the transaction.</param>
/// <results>The result of the local call to the smart contract method.</results>
/// <response code="200">Returns call response</response>
/// <response code="400">Invalid request</response>
/// <response code="500">Unable to deserialize method parameters</response>
[Route("api/[controller]/local-call")]
[HttpPost]
[ProducesResponseType((int)HttpStatusCode.OK)]
[ProducesResponseType((int)HttpStatusCode.BadRequest)]
[ProducesResponseType((int)HttpStatusCode.InternalServerError)]
public LocalExecutionResult LocalCallSmartContractTransaction([FromBody] LocalCallContractRequest request)
{
// Rewrite the method name to a property name
this.RewritePropertyGetterName(request);

ContractTxData txData = this.smartContractTransactionService.BuildLocalCallTxData(request);

ulong height = request.BlockHeight.HasValue ? request.BlockHeight.Value : (ulong)this.chainIndexer.Height;

ILocalExecutionResult result = this.localExecutor.Execute(height, request.Sender?.ToUint160(this.network) ?? new uint160(),
string.IsNullOrWhiteSpace(request.Amount) ? (Money)request.Amount : 0, txData);

return result as LocalExecutionResult;
}

/// <summary>
/// If the call is to a property, rewrites the method name to the getter method's name.
/// </summary>
private void RewritePropertyGetterName(LocalCallContractRequest request)
{
// Don't rewrite if there are params
if (request.Parameters != null && request.Parameters.Any())
return;

byte[] contractCode = this.stateRoot.GetCode(request.ContractAddress.ToUint160(this.network));

string contractType = this.stateRoot.GetContractType(request.ContractAddress.ToUint160(this.network));

Result<IContractModuleDefinition> readResult = ContractDecompiler.GetModuleDefinition(contractCode);

if (readResult.IsSuccess)
{
IContractModuleDefinition contractModule = readResult.Value;
string propertyGetterName = contractModule.GetPropertyGetterMethodName(contractType, request.MethodName);

if (propertyGetterName != null)
request.MethodName = propertyGetterName;
}
}
}
}
1 change: 1 addition & 0 deletions src/Stratis.Features.Unity3dApi/Stratis.Features.Unity3dApi.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
<ItemGroup>
<ProjectReference Include="..\Stratis.Bitcoin.Features.Api\Stratis.Bitcoin.Features.Api.csproj" />
<ProjectReference Include="..\Stratis.Bitcoin.Features.BlockStore\Stratis.Bitcoin.Features.BlockStore.csproj" />
<ProjectReference Include="..\Stratis.Bitcoin.Features.SmartContracts\Stratis.Bitcoin.Features.SmartContracts.csproj" />
<ProjectReference Include="..\Stratis.Bitcoin.Features.Wallet\Stratis.Bitcoin.Features.Wallet.csproj" />
<ProjectReference Include="..\Stratis.Bitcoin\Stratis.Bitcoin.csproj" />
</ItemGroup>
Expand Down