https://github.com/archethic-foundation/ae-contract-as
AssemblyScript SDK for the Archethic Public Blockchain Smart Contracts
https://github.com/archethic-foundation/ae-contract-as
archethic assemblysc wasm
Last synced: 16 days ago
JSON representation
AssemblyScript SDK for the Archethic Public Blockchain Smart Contracts
- Host: GitHub
- URL: https://github.com/archethic-foundation/ae-contract-as
- Owner: archethic-foundation
- License: mit
- Created: 2024-09-24T08:25:05.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2025-04-11T13:54:48.000Z (about 2 months ago)
- Last Synced: 2025-04-11T14:54:14.043Z (about 2 months ago)
- Topics: archethic, assemblysc, wasm
- Language: TypeScript
- Size: 953 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ae-contract-as
AssemblyScript SDK designed for developing smart contracts on the Archethic Public Blockchain.
## Features
- **Peace of mind**: Abstract WASM in/out complexity by providing a simple API and decorators
- **Integrated hooks**: Reserved functions (onInit, onUpgrade) to leverage blockchain hooks
- **Typed language**: Built on AssemblyScript, a TypeScript-like language
- **Build-in specification**: Integrate a manifest generation to export types and ABI
- **Tooling**: SDK provides CLI & Test framework to start in minutes smart contract development
## Getting Started
### Prerequisites
- [Node.js](https://nodejs.org/)
- npm
- Basic knowledge of TypeScript or AssemblyScript.
### Installation
Install the SDK via npm:
```bash
npm install @archethicjs/ae-contract-as
```
### Usage
1. Initialize a new AssemblyScript project:
```bash
npm create @archethicjs/create-ae-contract-as my-smart-contract
cd my-smart-contract
npm install
```
2. Build
```bash
npm run build
```
3. Test
```
npm run test
```
4. Deploy
```shell
npx aewasm build --mode release && npx aewasm deploy -s -e [ENDPOINT]
```
## Development
The main components of the project are:
- **assembly**: Core AssemblyScript SDK code (I/O management, std library, shared data structures)
- **transform**: Custom transformers for AssemblyScript compiler for decorators and manifest generation
- **bin**: Contains code for the `aewasm` CLI
## Contribution
Thank you for considering to help out with the source code. We welcome contributions from anyone and are grateful for even the smallest of improvement.
Please to follow this workflow:
1. Fork it!
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request
## Licence
AGPL