Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ascontract/subscript
Wasm smart contract sdk written in AssemblyScript
https://github.com/ascontract/subscript
Last synced: 3 months ago
JSON representation
Wasm smart contract sdk written in AssemblyScript
- Host: GitHub
- URL: https://github.com/ascontract/subscript
- Owner: ascontract
- License: apache-2.0
- Created: 2020-12-19T14:09:25.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-05-29T07:11:37.000Z (over 3 years ago)
- Last Synced: 2024-08-04T06:01:20.364Z (6 months ago)
- Language: TypeScript
- Homepage: https://github.com/ascontract/subscript
- Size: 83 KB
- Stars: 22
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-assemblyscript - ascontract/subscript - Subscript blockchain SDK (Packages)
README
# subscript lang to write wasm based smart contract
[](https://opensource.org/licenses/Apache-2.0)
subscript is a smart contract language written in AssemblyScript for wasm based chain.
We will provide essential substrate api and builtin tools to support contract development.
subscript is built on top of AssemblyScript and follow all AssemblyScript syntax.
subscript is more like a development kit with some builtin module and tools.
As assemblyscript is easy to interact with TypeScript and JavaScript, subscript is much more friendly for DApp developers.
## How subscript Works
* Substrate's Framework for Runtime Aggregation of Modularised Entities (FRAME) contains the `contracts` pallet,
which implements an API for typical functions smart contracts need (storage, querying information about account, …).
* The `contracts` pallet requires smart contracts to be uploaded to the blockchain as a Wasm blob.
* subscript is a smart contract language which targets the [API](https://github.com/paritytech/substrate/blob/master/frame/contracts/src/wasm/runtime.rs) exposed by `contracts`. subscript smart contracts are compiled to Wasm.
## Collection of the subscript library
[subscript/core](./core) includes contract library with essential core compoments implemented.
Developers can use the `subscript/core` to interact with the host environment. It privide basic basic types,
storage acceess and contract interface. for more detail, see the [subscript/core doc](./core/README.md).
the [example](./examples) directory provide some examples to demonstrate how to use the subscript library.
The [Flipper contract](./examples/flipper) imports low-level api to interact with the contract node and
The [ERC20 contract](./examples/erc20) demonstrate more complex feature.
## Get started with subscript library
This repository requires yarn and yarn workspaces.
The following command show how to setup the dev environment.
1. Install all dependencies
```
yarn install
```
2. To compile contract examples to wasm, change to example dir and run:
```
yarn build
```
3. To run tests in the subscript/core:
```
cd ./core
yarn test
```
## License
`subscript` is distributed under the terms of the Apache License (Version 2.0).
See [LICENSE-APACHE](LICENSE) for details.