apepay 0.3.9

Python SDK for ApePay

ApePay

A smart contract payment system built for automated service management

About

See the blog post to learn more about ApePay!

Documentation

Coming soon!

Contributing

ApePay is open source and we welcome all contributors! Check out the following to get started.

TODOs:

• Initial implementation
• Documentation
• Live testing on Sepolia
• Production deployment on Arbitrum
• Frontend management console, for managing subscriptions

Setup (Python)

First, install Ape.

Second, make sure to install the plugins:

$ ape plugins install . --upgrade

Next, prior to installing the SDK package, you need to compile the project:

$ ape compile

The SDK package relies on a soft link in [`./sdk/py/apepay/manifest.json`](./sdk/py/apepay/manifest.json)

Lastly, install the SDK package via:

$ pip install .

or for interactive installation do:

$ pip install -e .

Then you are ready to contribute!

Setup (JS)

In order to contribute to the JS packages, you need to first follow the Python Setup instructions to compile the smart contract package.

Next, you need install the node packages for development:

$ npm install

In order to work on the React component library, you need to compile the JS SDK:

$ npm run build --workspace=sdk/js

In order to work on the Demo app, you need to compile the JS SDK (like above) as well as compile the React component library:

$ npm run build --workspace=ui/lib

Then you are ready to contribute!

To run the demo app in development mode, do the following:

$ npm run dev --workspace=ui/app

To build the demo app for production, do the following:

$ npm run build --workspace=ui/app

Testing

To run tests, just use Ape:

$ ape test

To see gas usage, add the --gas flag:

$ ape test --gas

Scripts

To deploy a StreamManager (for testing purposes), run:

$ ape run deploy manager [TOKEN_ADDRESS [...]]
# Or if `ape tokens` is installed (with a valid tokenlist)
$ ape run deploy manager [TOKEN_SYMBOL [...]]

To deploy the StreamFactory (for production use), run:

$ ape run deploy factory

To deploy a Token (for testing use only), run:

$ ape run deploy token

This test token has an unauthenticated mint, please do not use in production!

To run the demo ApePay cluster daemon, first run a node like anvil:

$ anvil --block-time 1 --prune-history

Then run the example Silverback app:

$ silverback run bots.example:app

After that, it's suggested to start ape console and create a stream to watch the daemon react.

We also provide a simulation you can run instead using:

$ ape run demo

Publishing

Given the monorepo structure, it's a bit more challenging to distribute all the packages in this repo.

Contracts

TBD

Python SDK

To publish the Python package, there are 4 steps.

# 1. Install everything
$ pip install .[dev]
# 2. Compile the package manifest
$ ape compile -f
# 3. Build the Python SDK with twine
$ twine build
# 4. Publish the package
$ twine publish

JavaScript SDK and React component library

To publish the JS SDK, do the following:

# 1. Install everything
$ npm install --all-workspaces
# 2. Build SDK
$ npm run build --workspace=sdk/js
# 3. Publish SDK
$ npm publish --workspace=sdk/js

NOTE: make sure to revision the package before publishing, or it will fail.

To publish the React Component library, do the same thing as the SDK exepct use the ui/lib workspace.

Demo App and Management Console

If you need to deploy the demo app to prod from scratch, just create a new heroku project and add these buildpacks from the Heroku CLI (or directly in your Heroku dashboard)

$ heroku buildpacks:clear
$ heroku buildpacks:add heroku/python
$ heroku buildpacks:add heroku/nodejs

Then just run:

$ git push heroku main

License

ApePay is licensed Apache 2.0