diff --git a/Testnet/TokenWithdrawal/.gitignore b/Testnet/TokenWithdrawal/.gitignore new file mode 100644 index 00000000..1b9a752d --- /dev/null +++ b/Testnet/TokenWithdrawal/.gitignore @@ -0,0 +1,329 @@ +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. +## +## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore + +# User-specific files +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ + +# Visual Studio 2015/2017 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUNIT +*.VisualState.xml +TestResult.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET Core +project.lock.json +project.fragment.lock.json +artifacts/ + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio +*_i.c +*_p.c +*_i.h +*.ilk +*.meta +*.obj +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*.log +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# JustCode is a .NET coding add-in +.JustCode + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +orleans.codegen.cs + +# Including strong name files can present a security risk +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +#*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat +node_modules/ + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# JetBrains Rider +.idea/ +*.sln.iml + +# CodeRush +.cr/ + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ \ No newline at end of file diff --git a/Testnet/TokenWithdrawal/TokenWithdrawal.Tests/TokenWithdrawal.Tests.csproj b/Testnet/TokenWithdrawal/TokenWithdrawal.Tests/TokenWithdrawal.Tests.csproj new file mode 100644 index 00000000..589fbca6 --- /dev/null +++ b/Testnet/TokenWithdrawal/TokenWithdrawal.Tests/TokenWithdrawal.Tests.csproj @@ -0,0 +1,22 @@ + + + + netcoreapp3.1 + + false + + + + + + + + + + + + + + + + diff --git a/Testnet/TokenWithdrawal/TokenWithdrawal.Tests/TokenWithdrawalTests.cs b/Testnet/TokenWithdrawal/TokenWithdrawal.Tests/TokenWithdrawalTests.cs new file mode 100644 index 00000000..33bf8fb6 --- /dev/null +++ b/Testnet/TokenWithdrawal/TokenWithdrawal.Tests/TokenWithdrawalTests.cs @@ -0,0 +1,16 @@ +using Moq; +using Stratis.SmartContracts; +using Stratis.SmartContracts.CLR; +using Xunit; + +namespace MintableTokenTests +{ + /// + /// These tests validate the functionality that differs between the original standard token and the extended version. + /// + public class MintableTokenTests + { + // TODO + } + +} diff --git a/Testnet/TokenWithdrawal/TokenWithdrawal.sln b/Testnet/TokenWithdrawal/TokenWithdrawal.sln new file mode 100644 index 00000000..77ab0714 --- /dev/null +++ b/Testnet/TokenWithdrawal/TokenWithdrawal.sln @@ -0,0 +1,25 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 17 +VisualStudioVersion = 17.4.33403.182 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "TokenWithdrawal", "TokenWithdrawal\TokenWithdrawal.csproj", "{1B17F6BC-35B9-4597-A3D0-26DA453DFFF4}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {1B17F6BC-35B9-4597-A3D0-26DA453DFFF4}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {1B17F6BC-35B9-4597-A3D0-26DA453DFFF4}.Debug|Any CPU.Build.0 = Debug|Any CPU + {1B17F6BC-35B9-4597-A3D0-26DA453DFFF4}.Release|Any CPU.ActiveCfg = Release|Any CPU + {1B17F6BC-35B9-4597-A3D0-26DA453DFFF4}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {1E2C5ABC-4F7B-4E76-A1B5-662A56FBC1D2} + EndGlobalSection +EndGlobal diff --git a/Testnet/TokenWithdrawal/TokenWithdrawal/TokenWithdrawal.cs b/Testnet/TokenWithdrawal/TokenWithdrawal/TokenWithdrawal.cs new file mode 100644 index 00000000..63985e2c --- /dev/null +++ b/Testnet/TokenWithdrawal/TokenWithdrawal/TokenWithdrawal.cs @@ -0,0 +1,147 @@ +using Stratis.SmartContracts; + +[Deploy] +public class TokenWithdrawal : SmartContract +{ + public TokenWithdrawal(ISmartContractState smartContractState) + : base(smartContractState) + { + // Initialize your state variables if needed + } + + public enum WithdrawalStatus { Requested, Pending, Executed, Failed, Refunded } + + public uint WithdrawalSequence() + { + return this.State.GetUInt32("WithdrawalSequence"); + } + + public Withdrawal GetWithdrawal(uint seqNumber) + { + return this.State.GetStruct($"Withdrawal:{seqNumber}"); + } + + public Withdrawal GetWithdrawal(UInt128 uniqueNumber) + { + uint seqNumber = this.GetWithdrawalIndex(uniqueNumber); + return this.GetWithdrawal(seqNumber); + } + + public uint GetWithdrawalIndex(UInt128 uniqueNumber) + { + return this.State.GetUInt32($"WithdrawalIndex:{uniqueNumber}"); + } + + /// + /// Called by the minting daemons after detecting transfers to this contract. + /// + /// + /// The daemons use the metadata associated with the transfer to look up the + /// following additional transfer details: + /// Unique Number + /// Cirrus Identity + /// Fee + /// + /// + public void RegisterWithdrawal(UInt128 uniqueNumber, Address cirrusIdentity, string metadata, UInt256 amount, UInt256 fee) + { + //Assert(Message.Sender == /*Your multisig contract address*/); + var withdrawal = new Withdrawal() { UniqueNumber = uniqueNumber, CirrusIdentity = cirrusIdentity, Metadata = metadata, Amount = amount, Fee = fee }; + this.SetWithdrawal(uniqueNumber, withdrawal); + this.Log(new WithdrawalRequestedLog { UniqueNumber = uniqueNumber, CirrusIdentity = cirrusIdentity, Metadata = metadata, Amount = amount, Fee = fee }); + } + + private void ChangeStatus(UInt128 uniqueNumber, WithdrawalStatus newStatus) + { + var withdrawal = this.GetWithdrawal(uniqueNumber); + var prevStatus = withdrawal.Status; + withdrawal.Status = newStatus; + this.SetWithdrawal(uniqueNumber, withdrawal); + this.Log(new WithdrawalStatusChangedLog { UniqueNumber = uniqueNumber, PrevStatus = prevStatus, NewStatus = newStatus }); + } + + /// + /// Called by "Payment Multisig" (initially Payment Operator (Web Demo UI)). + /// + /// + public void MarkAsPending(UInt128 uniqueNumber) + { + this.Assert(this.Message.Sender == /*Your Web Demo UI address*/); + + this.ChangeStatus(uniqueNumber, WithdrawalStatus.Pending); + } + + /// + /// Called by "Minting Nodes" (via Multisig). + /// + /// + public void MarkAsExecuted(UInt128 uniqueNumber) + { + this.Assert(Message.Sender == /*Your multisig contract address*/); + + this.ChangeStatus(uniqueNumber, WithdrawalStatus.Executed); + } + + /// + /// Called by "Payment Multisig" (initially Payment Operator (Web Demo UI)) or "Minting Nodes" (via Multisig). + /// + /// + public void MarkAsFailed(UInt128 uniqueNumber) + { + this.ChangeStatus(uniqueNumber, WithdrawalStatus.Failed); + } + + private void SetWithdrawal(UInt128 uniqueNumber, Withdrawal withdrawal) + { + uint seqNumber = this.GetWithdrawalIndex(uniqueNumber); + if (seqNumber == 0) + { + seqNumber = this.GetNextWithdrawalIndex(); + this.SetWithdrawalIndex(uniqueNumber, seqNumber); + this.SetWithdrawal(seqNumber, withdrawal); + } + } + + private uint GetNextWithdrawalIndex() + { + var seqNumber = this.WithdrawalSequence(); + this.State.SetUInt32("WithdrawalSequence", seqNumber + 1); + return seqNumber; + } + + private void SetWithdrawal(uint seqNumber, Withdrawal withdrawal) + { + this.State.SetStruct($"Withdrawal:{seqNumber}", withdrawal); + } + + private void SetWithdrawalIndex(UInt128 uniqueNumber, uint seqNumber) + { + this.State.SetUInt32($"WithdrawalIndex:{uniqueNumber}", seqNumber); + } + + public struct Withdrawal + { + public UInt128 UniqueNumber; + public Address CirrusIdentity; + public string Metadata; + public UInt256 Amount; + public UInt256 Fee; + public WithdrawalStatus Status; + } + + public struct WithdrawalRequestedLog + { + public UInt128 UniqueNumber; + public UInt256 Amount; + public UInt256 Fee; + public Address CirrusIdentity; + public string Metadata; + } + + public struct WithdrawalStatusChangedLog + { + public UInt128 UniqueNumber; + public WithdrawalStatus PrevStatus; + public WithdrawalStatus NewStatus; + } +} diff --git a/Testnet/TokenWithdrawal/TokenWithdrawal/TokenWithdrawal.csproj b/Testnet/TokenWithdrawal/TokenWithdrawal/TokenWithdrawal.csproj new file mode 100644 index 00000000..fef6d583 --- /dev/null +++ b/Testnet/TokenWithdrawal/TokenWithdrawal/TokenWithdrawal.csproj @@ -0,0 +1,13 @@ + + + + net6.0 + + + + + + + + +