Skip to main content

Python SDK for ApePay

Project description

ApePay

Ape Framework

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

First, install Ape

Second, make sure to install the plugins:

$ ape plugins install . --upgrade

Lastly, since this is an SDK package, install the SDK:

$ poetry install

Then you are ready to contribute!

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 run the demo ApePay cluster daemon, first run a node like anvil:

$ anvil --derivation-path "m/44'/60'/0'/" --block-time 1 --prune-history

NOTE: the --derivation-path flag makes ape's test accounts match anvil's

Then run the daemon:

$ silverback run scripts.daemon:app --network ::foundry --account TEST::0

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

License

ApePay is licensed Apache 2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apepay-0.1.1.tar.gz (12.6 kB view details)

Uploaded Source

File details

Details for the file apepay-0.1.1.tar.gz.

File metadata

  • Download URL: apepay-0.1.1.tar.gz
  • Upload date:
  • Size: 12.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.11

File hashes

Hashes for apepay-0.1.1.tar.gz
Algorithm Hash digest
SHA256 481f564a0ec5ed2a5150a20ddd49b8855d5f7fdea7dad6175a5697a89ff787b6
MD5 93def5abba87cb8469da9a38b4bee539
BLAKE2b-256 b63ab6def4004257e1c9ed653e12f722e8a43a6d769b3d103e23d59c6c958f34

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page