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

Uploaded Source

Built Distribution

apepay-0.1.3-py3-none-any.whl (13.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: apepay-0.1.3.tar.gz
  • Upload date:
  • Size: 12.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.11 Linux/6.2.0-26-generic

File hashes

Hashes for apepay-0.1.3.tar.gz
Algorithm Hash digest
SHA256 a546df2c5bc08e1b69c2bf9374c2a3cc7f7144bf0a8954ed6473e56b8f5c76de
MD5 0a44e2b9e8300081db6d9bfe393a7a96
BLAKE2b-256 c2311f24e598159805ff80b3b5c3a7de3d81530592f7896b9e96c4aa3dbae882

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for apepay-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2d306a143ac75a5cf76ae020112f16f76e28918c230282ae679a4908370dbc2b
MD5 dbb65ba9c265b39c8dbff8f81855465b
BLAKE2b-256 93ca67b5363ade48ad8162ef4a3b1505f84f86702aa63df07ebdc6103dd13a63

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