Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gfusee/mx-sdk-as
AssemblyScript smart contract library designed for MultiversX's VM.
https://github.com/gfusee/mx-sdk-as
Last synced: 4 months ago
JSON representation
AssemblyScript smart contract library designed for MultiversX's VM.
- Host: GitHub
- URL: https://github.com/gfusee/mx-sdk-as
- Owner: gfusee
- License: gpl-3.0
- Created: 2022-11-17T10:14:47.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-03-12T15:21:20.000Z (11 months ago)
- Last Synced: 2024-05-20T03:15:47.880Z (9 months ago)
- Language: TypeScript
- Homepage:
- Size: 415 KB
- Stars: 26
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-multiversx-dev-resources - AssemblyScript framework for MultiversX VM - AssemblyScript smart contract library designed for Elrond's VM. (MultiversX community / SDKs and dev tools)
README
# MultiversX WASM AssemblyScript (Proof of concept)
A proof of concept to make MultiversX smart contracts in AssemblyScript.
## ⚠️ Warning ⚠️
THIS IS ONLY EXPERIMENTAL, DO NOT USE IT IN PRODUCTION !
The aim of this repo is to make a proof of concept and ONLY a proof of concept. The code is neither clean nor safe nor optimized !
## Getting started
### Tutorials
Two smart contracts tutorials are available here : https://fusee.gitbook.io/mx-sdk-as/.
They will give a good idea about what you can build with this framework.
### AssemblyScript
AssemblyScript is nearly the same as Typescript, but there is still some differences, please check https://www.assemblyscript.org/ to have more informations.
### Contract development
#### Build the empty contract
If you only want to try writing smart contracts with this framework do the following steps :
- Clone the following repo : https://github.com/gfusee/mx-sdk-as-empty
- In order to compile the contract you should run the command `npm run build`
And you're done ! The contract is compiled into the `build` folder.
Feel free to check examples contracts inside the `contracts/examples` folder, these are reproduction of `mx-sdk-rs` examples contracts.
#### Test the contract via scenario
If you have a standard installation of mxpy, the `run-scenarios` executable should be located in the `~/multiversx-sdk/vmtools` folder. Here are the steps to execute scenarios :
- Compile the contract (steps above)
- Find your `run-scenario` executable path inside your custom installation of mxpy installation
- Inside the root folder of the project, run the ` scenarios` command
## Documentation
There is currently no documentation, feel free to check examples inside the `contract/examples` folder.
If after that you have any question, feel free to DM me !
## What's not (properly) working
### Structs/classes & enums
Structs and enums are workings but with some limitations.
In order to create a classes which is compatible with the framework you should annotate it with either `@struct` or `@enumType` :
```
@struct
export class Human {
name: ManagedBuffer
age: ManagedU64
wallet: ManagedAddress
}
```
or
```
@enumType
export enum Animal {
Cat,
Dog,
Spider
}
```
You should be aware of the four following limitations :
- Constructor should have no parameter. It is planned in the future to allow constructors with params, for now, you can use statics methods as a workaround.
- They should have only managed properties types (those exported from this framework)
- Enums are converted into classes at compilation. So `switch` statements may not work as expected, please use `if` instead.
- They are allocated on the heap. More explanations below.
### Async calls
MultiversX team will soon change the asynchronous contracts calls system, hence I will not implement the current system.
This leads to several limitations like no call to ESDT proxy (issuing tokens, managing roles)
This feature will be my ultimate priority when MultiversX team will implement the new async calls system.
### Statics and generics
There is a limitation related to Typescript, we cannot define static methods on interfaces so we cannot call them on generic parameters.
A good workaround is to instantiate dummy objects to have access to those methods.
This may lead to useless VM calls, I'm hunting these useless calls to remove them.
### Closures
AssemblyScript has a SEVERE limitation about closures. Inside a closure we cannot use a variable declared outside, for example this code works :
```
myBiguints.forEach(biguint => {
if (biguint == BigUint.zero()) {
throw new Error("BigUint should be greater than 0 !")
}
})
```
But the following code does not work :
```
const sum = BigUint.zero()
myBiguints.forEach(biguint => {
sum += biguint //does NOT compile because sum is declared outside the closure
})
```
This issue is known by the AssemblyScript and should be fixed in the future : https://github.com/AssemblyScript/assemblyscript/issues/798
### Heap allocations
The biggest limitation of AssemblyScript I'm facing is that classes does not act as C structs, they are always allocated on the heap and this lead to big issues.
I used a heavy workaround for some classes (ManagedBuffer, BigUint, ...) but not for all classes because this take a lot of time to refactor all.
This issue is known by the AssemblyScript team : https://github.com/AssemblyScript/assemblyscript/issues/2254