Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: Review examples #62

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/workflows/build-examples.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ jobs:
cd "projects/${{ matrix.project }}"
yarn install
yarn build
yarn test

build-foundry-example:
name: Build Foundry Examples
Expand Down
16 changes: 16 additions & 0 deletions projects/gda-advertisement-auction/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Welcome to the Advertisement Auction

### A basic example to get you started with the Superfluid's Distributions (General Distribution Agreement)

To get started with the updated version:

1. Navigate to the `foundry-tests`folder
* `cd projects/gda-advertisement-auction/foundry-tests`
2. Create a .env file or simple export the environment variable RPC URL necessary for the Polygon Mumbai fork:
* `export MUMBAI_RPC_URL=https://rpc-mumbai.maticvigil.com`
Make sure to use a un RPC URL that is functional. Check [Chainlist](https://chainlist.org/chain/80001) for more URLs.
3. Install dependencies with specific commands:
* `forge install superfluid-protocol-monorepo=https://github.com/superfluid-finance/protocol-monorepo@dev --no-commit`
* `forge install https://github.com/OpenZeppelin/[email protected] --no-commit`
4. Compile the contracts with `forge build`.
5. Run the test suite with `forge test`.
Original file line number Diff line number Diff line change
@@ -1,15 +1,11 @@
// SPDX-License-Identifier: AGPLv3
pragma solidity ^0.8.0;

import {
ISuperToken, ISuperfluid
} from "@superfluid-finance/ethereum-contracts/contracts/interfaces/superfluid/ISuperToken.sol";
import {
IConstantFlowAgreementV1
} from "@superfluid-finance/ethereum-contracts/contracts/interfaces/agreements/IConstantFlowAgreementV1.sol";
import {ISuperToken} from "@superfluid-finance/ethereum-contracts/contracts/interfaces/superfluid/ISuperToken.sol";
import {ISuperfluid} from "@superfluid-finance/ethereum-contracts/contracts/interfaces/superfluid/ISuperfluid.sol";
import {IConstantFlowAgreementV1} from "@superfluid-finance/ethereum-contracts/contracts/interfaces/agreements/IConstantFlowAgreementV1.sol";

interface IVestingScheduler {

error TimeWindowInvalid();
error AccountInvalid();
error ZeroAddress();
Expand Down Expand Up @@ -109,7 +105,7 @@ interface IVestingScheduler {
address receiver,
uint32 endDate,
bytes memory ctx
) external returns(bytes memory newCtx);
) external returns (bytes memory newCtx);

/**
* @dev Event emitted on deletion of a vesting schedule
Expand Down Expand Up @@ -180,7 +176,7 @@ interface IVestingScheduler {
ISuperToken superToken,
address sender,
address receiver
) external returns(bool success);
) external returns (bool success);

/**
* @dev Emitted when the end of a scheduled vesting is executed
Expand Down Expand Up @@ -211,7 +207,7 @@ interface IVestingScheduler {
ISuperToken superToken,
address sender,
address receiver
) external returns(bool success);
) external returns (bool success);

/**
* @dev Gets data currently stored for a vesting schedule
Expand All @@ -224,4 +220,4 @@ interface IVestingScheduler {
address sender,
address receiver
) external view returns (VestingSchedule memory);
}
}
Loading
Loading