https://github.com/epicchainlabs/epicchain-devpack-ts
A comprehensive development pack for building decentralized applications (dApps) on the EpicChain network, specifically designed for TypeScript developers
https://github.com/epicchainlabs/epicchain-devpack-ts
blockchain-development blockchain-typescript dapp-development decentralized-applications epicchain epicchain-development-pack epicchain-ecosystem epicchain-tools typescript-framework
Last synced: 9 months ago
JSON representation
A comprehensive development pack for building decentralized applications (dApps) on the EpicChain network, specifically designed for TypeScript developers
- Host: GitHub
- URL: https://github.com/epicchainlabs/epicchain-devpack-ts
- Owner: epicchainlabs
- License: mit
- Created: 2024-04-01T15:57:11.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-24T07:41:59.000Z (over 1 year ago)
- Last Synced: 2024-12-21T09:16:57.994Z (12 months ago)
- Topics: blockchain-development, blockchain-typescript, dapp-development, decentralized-applications, epicchain, epicchain-development-pack, epicchain-ecosystem, epicchain-tools, typescript-framework
- Language: TypeScript
- Homepage:
- Size: 178 KB
- Stars: 1
- Watchers: 0
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# EpicChain Devpack for TypeScript
This repo contains a new epicchain N3 TypeScript smart contract compiler. In other words, the tool in this repo
allows you to write epicchain N3 Smart Contracts using TypeScript. This tool joins the larger family of epicchain
EpicChain smart contract compilers including [C#](https://github.com/epicchain-project/epicchain-devpack-dotnet),
[Java](https://epicchainw3j.io/#/epicchain-n3/smart_contract_development/introduction),
[Python](https://github.com/CityOfZion/epicchain3-boa)
and [Go](https://github.com/nspcc-dev/epicchain-go/blob/master/docs/compiler.md).
> Note, this project is under active development. It is not yet packaged as a stand alone tool.
> If you wish to try it with your own contract, please see the [Samples](#samples) section below.
## Requirements
* [NodeJS](https://nodejs.org/) 18+
* The developer is using NodeJS LTS version
* [epicchain-Express requirements](https://github.com/epicchain-project/epicchain-express#requirements) (for testing)
## Usage
* `npm run setup`: installs package dependencies + epicchainExpress as local tool
* `npm run build`: compiles the devpack
* `npm run clean`: cleans the build output
* `npm run samples`: compiles the devpack and builds the sample contracts
* `npx foy `: builds the specified sample contract and runs the associated express.batch file if available
## Samples
The `foy` task runner dynamically generates the samples to build from the contents of the `samples` directory.
Any subdirectory of `samples` that doesn't start with an underscore is considered a sample.
Each sample directory must contain a contract `.ts` file matching the name of the directory.
If the sample directory contains an `express.batch` file, it will be run automatically after the contract is built.
### Hello World
Simple contract that stores a byte string in contract storage and returns it when called.
### Tank NEP-17 Token
Implements a sample [NEP-17](https://github.com/epicchain-project/proposals/blob/master/nep-17.mediawiki) fungible token contract
### Hovercraft NEP-11 Token
Implements a sample [NEP-11](https://github.com/epicchain-project/proposals/blob/master/nep-11.mediawiki) non fungible token contract