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.2.tar.gz (12.6 kB view details)

Uploaded Source

Built Distribution

apepay-0.1.2-py3-none-any.whl (13.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: apepay-0.1.2.tar.gz
  • Upload date:
  • Size: 12.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.0 CPython/3.10.6 Linux/6.2.0-26-generic

File hashes

Hashes for apepay-0.1.2.tar.gz
Algorithm Hash digest
SHA256 c539a9775ebfa9971a85b4dc52c72584d376236ee1f980b2bca8b0c9409e0a3c
MD5 7f32bb8b9b87a502d5702b45b16f7441
BLAKE2b-256 a65f08af7314cad244f45567faa90b1215416ef4d73214fe039f9fcbafc5b09d

See more details on using hashes here.

File details

Details for the file apepay-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: apepay-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 13.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.0 CPython/3.10.6 Linux/6.2.0-26-generic

File hashes

Hashes for apepay-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 df9c03f90dcaa605ba593fd52132167d3921e8e354ce55bc0eb8a68383df90b7
MD5 2339dd51b4d1f2b05a1f5ba635708b0c
BLAKE2b-256 74e04f4a1948b4b0156bd6da53f0055158dc269d002ad194107b1fe09a54e7a3

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