Skip to content

Latest commit

 

History

History
97 lines (62 loc) · 4.96 KB

README.md

File metadata and controls

97 lines (62 loc) · 4.96 KB
Raw

Abstract App Module Template

The Abstract App Module Template is a starting point for developing composable smart-contracts, or "apps", that enable features or transform Abstract Accounts into standalone products. An app is instantiated for each Account individually and is migratable. Apps are allowed to perform actions on the Account and may also want to integrate with other Apps and Adapters installed on the Account. To learn more about Abstract Accounts, please see the abstract accounts documentation. To read more about apps, please see the app module documentation.

Getting Started

Requirements

Learn more about the requirements for developing Abstract apps in the getting started documentation.

Setup

To get started, clone this repository and run the following command:

chmod +x ./template-setup.sh
./template-setup.sh

The setup script will add our Github CI repo to the repo.

Using the Justfile

This repository comes with a justfile, which is a handy task runner that helps with building, testing, and deploying your Abstract app module.

Installing Tools

To fully make use of the justfile, you need to install a few tools first. You can do this by simply running just install-tools. See tools used the template for more information.

Available Tasks

Here are some of the tasks available in the justfile:

  • install-tools: Install all the tools needed to run the tasks.
  • build: Build everything with all features.
  • test: Run all tests.
  • watch-test: Watch the codebase and run tests on changes.
  • fmt: Format the codebase (including .toml).
  • lint: Lint-check the codebase.
  • lintfix: Fix linting errors automatically.
  • watch: Watch the codebase and run cargo check on changes.
  • check: Check the codebase for issues.
  • deploy: Deploy the App to a network.
  • wasm: Optimize the contract.
  • schema: Generate the json schemas for the contract
  • ts-codegen: Generate the typescript client code for the contract
  • ts-publish: Publish the typescript client code to npm
  • publish-schemas: Publish the schemas by creating a PR on the Abstract schemas repository.

You can see the full list of tasks available by running just --list.

Deploying

Before attempting to deploy your app you need to add your mnemonic to the .env file. Don't use a mnemonic that has mainnet funds for this.

You can now use just deploy to run the examples/deploy.rs script. The script will deploy the app to the juno testnet. You can change the network by changing the network variable in the script.

Generating Typescript Client Code

Before proceeding you need to install the required dependencies for the typescript client code generation.

cd typescript
npm install

To generate the typescript client code for the contract you can run just ts-codegen. This will generate the code in the typescript/src directory. You can then import the generated code in your frontend application.

To publish the Typescript sdk, first change the name and version in the typescript/package.json file. Then run just ts-publish. This will publish the sdk to npm.

Publishing Module Schemas

To publish your module schemas, we provide the publish-schemas command, which creates a pull request on the Abstract schemas repository.

just publish-schemas <namespace> <name> <version>
  • namespace: Your module's namespace
  • name: Your module's name
  • version: Your module's version. Note that if you only include the minor version (e.g., 0.1), you don't have to reupload the schemas for every patch version.

The command will automatically clone the Abstract Schemas repository, create a new branch with the given namespace, name, and version, and copy the schemas and metadata from your module to the appropriate directory.

For this command to work properly, please make sure that your metadata.json file is located at the root of your module's directory. This file is necessary for the Abstract Frontend to correctly interpret and display information about your module.

Example:

just publish-schemas my-namespace my-module 0.1

In the example above, my-namespace is the namespace, my-module is the module's name, and 0.1 is the minor version. If you create a patch for your module (e.g., 0.1.1), you don't need to run publish-schemas again unless the schemas have changed.

Contributing

We welcome contributions to the Abstract App Module Template! To contribute, fork this repository and submit a pull request with your changes. If you have any questions or issues, please open an issue in the repository and we will be happy to assist you.