AElf.Tools 1.0.0-Alpha

.NET Standard 1.3 This package targets .NET Standard 1.3. The package is compatible with this framework or higher. .NET Framework 4.6 This package targets .NET Framework 4.6. The package is compatible with this framework or higher.
This is a prerelease version of AElf.Tools.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package AElf.Tools --version 1.0.0-Alpha
NuGet\Install-Package AElf.Tools -Version 1.0.0-Alpha
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="AElf.Tools" Version="1.0.0-Alpha">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add AElf.Tools --version 1.0.0-Alpha
#r "nuget: AElf.Tools, 1.0.0-Alpha"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install AElf.Tools as a Cake Addin
#addin nuget:?package=AElf.Tools&version=1.0.0-Alpha&prerelease

// Install AElf.Tools as a Cake Tool
#tool nuget:?package=AElf.Tools&version=1.0.0-Alpha&prerelease

AElf.Tools

An MsBuild tool to compile AElf contracts using protobuf and an extension tool. It's based on the gRPC tool.

Usage

Preparation

Add a local nuget source - this only needs to be done once.

nuget sources Add -Name Local -Source $env:UserProfile\LocalNuget

Pack this tool

dotnet pack

Add the local nuget package to local source

nuget add .\bin\Debug\AElf.Tools.1.0.0-dev.nupkg -Source $env:UserProfile\LocalNuget

Reference the tool in an AElf Contract project and include the protobuf sources

    <ItemGroup>
        <PackageReference Include="AElf.Tools" Version="1.0.0-dev">
          <PrivateAssets>all</PrivateAssets>
          <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
        </PackageReference>
    </ItemGroup>

    <ItemGroup>
        <Protobuf Include="Protobuf/contract/*.proto" />
        <Protobuf Include="Protobuf/message/*.proto">
            <ContractOutputOptions>nocontract</ContractOutputOptions>
        </Protobuf>
        <Protobuf Include="Protobuf/reference/*.proto">
            <ContractOutputOptions>reference</ContractOutputOptions>
            <Access>Internal</Access>
        </Protobuf>
    </ItemGroup>

Open Items and Improvements

  • Clean up gRPC stuff (e.g. gRPC supports codegen for C++ which we don't need)
  • Currently only Windows x64 binaries are included, we need to add binaries for other platforms
  • Currently proto files have to be specified in .csproj file, we can add direct detection for convention folders under Protobuf, subfolders include:
    • contract for protos which requires ContractBase to be generated
    • message for protos which only require protobuf messages to be generated
    • reference for protos which require ReferenceState to be generated
    • stub for protos which require Stubs to be generated
  • Currently this tool include aelf/options.proto and aelf/core.proto (together with google native protos), we can consider adding acs protos as well
  • Add tests
  • Publish nuget packages
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp1.0 was computed.  netcoreapp1.1 was computed.  netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard1.3 is compatible.  netstandard1.4 was computed.  netstandard1.5 was computed.  netstandard1.6 was computed.  netstandard2.0 was computed.  netstandard2.1 was computed. 
.NET Framework net46 is compatible.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
native native is compatible. 
Tizen tizen30 was computed.  tizen40 was computed.  tizen60 was computed. 
Universal Windows Platform uap was computed.  uap10.0 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.3 934 9/13/2023
1.0.2 4,003 7/26/2023
1.0.0-Alpha 603 5/15/2023