Skip to content

Contains the Solidity Smart Contracts utilised by the ASP to support Protocol integrations.

License

Notifications You must be signed in to change notification settings

0xbow-io/asp-contracts-V1.0

Repository files navigation

ASP Contracts V1.0

Caution

These Smart Contracts are pending audit & should be used with caution.

This repository contains the Solidity smart contracts utilised by the "association-set provider" ASP with go & ts packages for interacting with the contracts.

Please refer to the ASP Spec V1.0 for more context on the "association set provider" (ASP).


Current Version

1.0.0-alpha

Version History

Version Release Date Changes
1.0.0-alpha 2024-07-22 Core ASP Contracts

Planned Future Changes

  • N/A

Deprecation Notices

  • N/A

Current Deployments

Chain Contract Address
Sepolia 0xaaf9221e9c337ba5ba2c4bd6c0af8b2d2b9cd286
Gnosis 0xaaf9221e9c337ba5ba2c4bd6c0af8b2d2b9cd286
Mainnet ⚠️ Pending Deployment
Base ⚠️ Pending Deployment

1. Development:

1.1. Setup:

Ensure you have the following installed:

1.2. Testing:

  • To run the smart-contracts unit-tests:
forge test -vvvv

This will run the tests in the test directory:

  • AssociationSetProvider.test.ts
  • AssociationSet.test.ts

1.3. Contract Deployment:

## Set these environment variables in the `.env` file:

# RPC_URL="..."
# PRIVATE_KEY="..."
# ETHERSCAN_API_KEY="..."
# Chain="..."

## Load the environment variables:
source .env

## To deploy AssociationSetProvider.sol:

forge script --chain $CHAIN script/deployment.s.sol:Deploy_AssociationSetProvider --rpc-url $RPC_URL --legacy --broadcast --verify -vvv

2. Integration:

Refer to integrations for integrating the ASP with other systems / protocols.


3. How to Contribute:


4. Versioning:

4.1 Backwards Compatibility

ASP Contracts V1.0 establishes the baseline for future versions. All subsequent minor versions (1.x) will maintain backwards compatibility with V1.0.

4.2 Semantic Versioning

ASP Contracts follows Semantic Versioning 2.0.0 (https://semver.org/). Version numbers are in the format MAJOR.MINOR.PATCH, where:

  • MAJOR version increments denote incompatible API changes
  • MINOR version increments add functionality in a backwards-compatible manner
  • PATCH version increments make backwards-compatible bug fixes
  • PRE-RELEASE versions are denoted by appending a hyphen and a series of dot-separated identifiers immediately following the PATCH version

About

Contains the Solidity Smart Contracts utilised by the ASP to support Protocol integrations.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages