https://github.com/alexdovzhanyn/alchemyvm

WebAssembly Virtual Machine Built In Elixir
https://github.com/alexdovzhanyn/alchemyvm

alchemy interpreter vm wasm wasm-vm webassembly

Last synced: 8 days ago
JSON representation

WebAssembly Virtual Machine Built In Elixir

• Host: GitHub
• URL: https://github.com/alexdovzhanyn/alchemyvm
• Owner: alexdovzhanyn
• License: mit
• Created: 2018-12-13T00:45:08.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-04-03T19:19:53.000Z (over 5 years ago)
• Last Synced: 2024-10-14T14:17:33.853Z (25 days ago)
• Topics: alchemy, interpreter, vm, wasm, wasm-vm, webassembly
• Language: Elixir
• Homepage:
• Size: 540 KB
• Stars: 188
• Watchers: 16
• Forks: 5
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![AlchemyVM Banner](https://s3-us-west-2.amazonaws.com/elixium-assets/alchemylogo.jpg)

[![Packagist](https://img.shields.io/badge/license-MIT-blue.svg)]()

[![](https://img.shields.io/hexpm/v/wasp_vm.svg)](https://hex.pm/packages/alchemy_vm)

[![Build Status](https://travis-ci.org/ElixiumNetwork/WaspVM.svg?branch=master)](https://travis-ci.org/ElixiumNetwork/AlchemyVM)

WebAssembly Virtual Machine written in Elixir. Currently used as the Wasm VM in

the [Elixium Network](https://www.elixiumnetwork.org)

## Usage

# Standard Usage

```elixir

{:ok, ref} = AlchemyVM.start() # Start AlchemyVM

AlchemyVM.load_file(ref, "path/to/wasm/file.wasm") # Load a module

AlchemyVM.execute(ref, "some_exported_function") # Call a function

# => {:ok, total_gas_cost, :function_return_value}

```

# Options

For Gas Limit use:

``` elixir

 AlchemyVM.execute(ref, "some_exported_function", [:gas_limt, 100])

 ```

For Trace use:

```elixir

AlchemyVM.execute(ref, "some_exported_function", [:trace, true])

```

For Trace & gas limit use:

```elixir

AlchemyVM.execute(ref, "some_exported_function", [gas_limit: 100, trace: true])

```

More detailed usage instructions can be found on [HexDocs](https://hexdocs.pm/alchemy_vm/0.8.0/AlchemyVM.html#execute/4-usage).

## Installation

Add `alchemy_vm` to your list of dependencies in `mix.exs`:

```elixir

def deps do

  [

    {:alchemy_vm, "~> 0.7"}

  ]

end

```

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)

and published on [HexDocs](https://hexdocs.pm). Once published, the docs can

be found at [https://hexdocs.pm/wasp_vm](https://hexdocs.pm/alchemy_vm).