urszeidler / uml2solidity

A uml profile and a set of acceleo code generators to model smart contracts in uml and generate solidity code.

uml2solidity

A uml profile and a set of acceleo code generators to model smart contracts in uml and generate solidity, java script and java code together with documentation. Usable with the Papyrus UML modeler for eclipse.

a plugin for eclipse:

  http://urszeidler.github.io/uml2solidity/uml2solidity-updatesite/

refer to install section of the wiki when you are not familiar with eclipse and the update mechanism.

dependencies:

• uml2 (5.0)
• papyrus (1.1.x)
• acceleo (3.5)

There are all available in the default Mars updatesite.

find out more in the docs

• wiki home
  • install
  • usage
  • create a model
  • generate code
• Solidity Code
  • packages and solidity files
  • contract constructors
  • visibilities
  • protected user code
  • an example
• profile definition
• preferences
• generated JS code
• generated java code
• basic usage

Use eclipse as your main editor with the solidity editor and compile the code in the background with the solidity builder.

Extend the generation process by adding new model to text transformations.

you can tip the coder by sending some ether : 0x25b2ce55746f54d88e9fc4d2f0f85e879c30bb05

License

The code is published under the terms of the Eclipse Public License, version 1.0.

uml2solidity's Issues

The TransferableFungible of the Standardized Contract Api model need to return a bool.

The function transfer does not take a bool (success) as in parameter it returns it. Also model need to update the profile.

Generate standalone JSON ABI file

Currently, the ABI for the Solidity contracts is included in the generated JS files

var [Classname]Contract = web3.eth.contract(ABI);

It would be great to have the ABI as a single standalone file eg. classname.json

Contribution contact point

Hi Urs, although we had a bad introduction in the past, I feel I can contribute a lot to this project. I have experience with Eclipse, Acceleo and Ethereum programming. Please contact me by email: [email protected]

de.urszeidler.eclipse.solidity.um2solidity.m2t file does not exist?

Switch the generation to a start configuration.

It would make sense to change the generation start from a project preference and the start generation button in the toolbar to a start configuration. Like the uml2java generator.

The start configuration is independent from the project pref and so it is possible to have several generation targets for one model.
It also can be easily shared.

Add get struct mapping method in the java interface.

As the api can return structs from a mapping, in the same way as return of multiple values the generator should generate a dataholder for the struct and add a method in the interface to access it.

Add solidity project nature.

The plugin de.urszeidler.eclipse.solidity.compiler.support should add a solidity project nature and an incremental builder, which give us the possibility to provide compiler pref on project scope not, like now, eclipse wide.

see http://help.eclipse.org/mars/index.jsp?topic=%2Forg.eclipse.platform.doc.isv%2Fguide%2FresAdv_builders.htm

and http://help.eclipse.org/mars/index.jsp?topic=%2Forg.eclipse.platform.doc.isv%2Fguide%2FresAdv_natures.htm

Add Stereotype KeyMapping.

A stereotype for mapping the type of the property as value and not as key.

The parameter modifier need to check if there is no parameter.

Currently the parameter modifier generates the modifier alway with '()' which is wrong when no parameter is given.

conflicting dependency

Thanks that you are doing this. I am used to Eclipse, and would just like to have solidity syntax coloring in my favorite IDE.

I am trying to install via http://urszeidler.github.io/uml2solidity/uml2solidity-updatesite/

but it results in these errors:

Cannot complete the install because of a conflicting dependency.
Software being installed: Solidity compiler Feature 1.0.3.201606152126 (de.urszeidler.eclipse.solidity.compiler.support.feature.feature.group 1.0.3.201606152126)
Software currently installed: Enide 2015 4.5.0.20150706-0926 (nodeclipse.package.enide.product 4.5.0.20150706-0926)
Only one of the following can be installed at once:
Core Resource Management 3.10.0.v20150423-0755 (org.eclipse.core.resources 3.10.0.v20150423-0755)
Core Resource Management 3.10.1.v20150725-1910 (org.eclipse.core.resources 3.10.1.v20150725-1910)
Core Resource Management 3.8.101.v20130717-0806 (org.eclipse.core.resources 3.8.101.v20130717-0806)
Core Resource Management 3.8.100.v20130521-2026 (org.eclipse.core.resources 3.8.100.v20130521-2026)
Cannot satisfy dependency:
From: Solidity compiler Feature 1.0.3.201606152126 (de.urszeidler.eclipse.solidity.compiler.support.feature.feature.group 1.0.3.201606152126)
To: org.eclipse.core.resources 3.10.1
Cannot satisfy dependency:
From: Enide 2015 4.5.0.20150706-0926 (nodeclipse.package.enide.feature.feature.group 4.5.0.20150706-0926)
To: org.eclipse.platform.feature.group [4.5.0.v20150603-2358]
Cannot satisfy dependency:
From: Enide 2015 4.5.0.20150706-0926 (nodeclipse.package.enide.product 4.5.0.20150706-0926)
To: nodeclipse.package.enide.feature.feature.group [4.5.0.20150706-0926]
Cannot satisfy dependency:
From: Eclipse Platform 4.5.0.v20150603-2358 (org.eclipse.platform.feature.group 4.5.0.v20150603-2358)
To: org.eclipse.core.resources [3.10.0.v20150423-0755]

What to do?

Thanks!

Fix the generated Junit code.

Currently the generated junit code contains a minor error.
In the createFixture() method the compiled contract can no longer get via ethereum facade.

We need to add a method in the AbstractContractTest as following:

public CompiledContract getCompiledContract() throws InterruptedException, ExecutionException {
	Map<String, CompiledContract> map = ethereum.compile(contractSource).get();
	return map.get(getContractName());
}

And use this method in createFixture().

Change the return type for a payable function to Payable in the java interface.

To be able to send ether the return type of the method need to be a org.adridadou.ethereum.values.Payable the generator should respect this.

Add a modifier property to the getter and setter.

The getter/setter stereotype can have a property to define modifiers for the generated getter and setter functions.

Add an extension point for the generators.

The extension point let you register an acceleo transformation. Optional an extension point for the start configuration.

Provide a feature for de.urszeidler.eclipse.solidity.compiler.support .

To have the de.urszeidler.eclipse.solidity.compiler.support plugin installable without the uml2solidity plugin we need to add a feature containing this plugin.