aepp-sophia-examples

AEproject

AEproject is the testing framework for Sophia Smart Contract development and allows developers to easily run a local dev environment & test their Smart Contracts.

The structure of this repository follows the default structure that AEproject provides if you initialize a new project.

Note

This repository doesn't provide any deployment scripts as it is only intended to showcase Sophia Smart Contracts & how to test those.
All Sophia examples are provided with corresponding tests written in JavaScript which can be found under ./test.

Standards (Aeternity Expansions) & Implementations

The Aeternity Expansions (AEX) are standards on aeternity proposed by the community. If you have a good idea or face common requirements you can also submit a new AEX proposal for which a reference implementation can be developed.

Smart Contract Examples

Disclaimer

The provided Sophia examples are only tested to the extend represented. None of the code was security audited by aeternity or is provided to be used in production, without thorough checks.

Library Usage

The LibraryUsage.aes contract shows how to include default and custom libraries in a Smart Contract. The example currently includes following custom libraries:

Delegation signatures

It is possible to delegate the right to perform certain AENS or Oracle related actions to a contract. Check out the following examples and corresponding tests to see how you can use it:

AensDelegation.aes
- Delegation signatures for AENS functions can e.g. be used to create an AENS marketplace
OracleDelegation.aes

Oracles

ExchangeOracles

ExchangeOracle.aes registers an oracle and allows to respond to oracle queries.
ExchangeMarket.aes showcases how to query prices from an oracle and how to get the answers of an oracle.

SmartDataProvider

SmartDataProviderBackendInterface.aes defines entrypoints of the SmartDataProviderBackend
SmartDataProviderBackend.aes the actual implementation of the interface that registers an oracle and processes responses
SmartDataProviderClient.aes the client that uses the interfaces to call the entrypoints of the backend implementation

There also exists another repository ae-oracle-pricefeed which includes a complete example that runs a server for the oracle which automatically extends the TTL of the oracle and responds to queries.

An even more complex example which aggregates answers of multiple oracles is included in tipping-oracle-service. The contracts in this repository are being used by https://superhero.com.

Smart Shop

This is a good example to see how to deal with contract interfaces to call remote contracts. All contracts can be found under contracts/SmartShop.

Workflow

The Seller deploys the SellerContract by passing the buyer public address and item price as arguments.
The Transport Courier deploys the TransportContract passing location as an argument.
The Buyer passes SellerContract address and TransportContract address as arguments when deploying BuyerContract.
The Buyer deposits the needed amount by calling deposit_to_seller_contract(), which takes the price of the item as Call.value.
The Seller now sends the item, which will be redirected to Transport Courier. The function is send_item(). It checks if Buyer has deposited the price of the item to the SellerContract.
Buyer can track the status of the item:
- check_courier_status() - returns current delivery status
- check_courier_location() - returns current location status
Once the item is delivered, the Transport Courier calls delivered_item(city : string) function, with current location.
To finalize the order, Buyer calls received_item() function, with SellerContract address.
The amount of tokens, payed by Buyer, will be sent to seller's account.

Others (no specific explanation provided/required)

Problems / Questions

If you face a problem or have other questions please pick one of the following places:

We are happy to help!

aeternity / aepp-sophia-examples Goto Github PK