https://github.com/delegatable/delegatable-sol

Counterfactual revocable-delegation
https://github.com/delegatable/delegatable-sol

Last synced: 2 months ago
JSON representation

Counterfactual revocable-delegation

• Host: GitHub
• URL: https://github.com/delegatable/delegatable-sol
• Owner: delegatable
• Fork: true (kamescg/delegatable-sol)
• Created: 2022-08-13T00:57:20.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-12-07T12:10:00.000Z (about 1 year ago)
• Last Synced: 2024-08-03T13:04:00.250Z (6 months ago)
• Language: Solidity
• Homepage: https://delegatable.org
• Size: 5.8 MB
• Stars: 112
• Watchers: 3
• Forks: 15
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-web3-tools-and-dapps - Delegatable - This Solidity library allows you to create and sign messages outside of the blockchain. These messages grant specific powers to other individuals, but cannot be transferred to someone else. (dApps directory / Solidity Developer Tools)

README

        
![banner](https://cloudflare-ipfs.com/ipfs/QmSWGEWUCThfBW127zPeF7oqwLwzVndB5mWDbgKCPnwCvE)

# Delegatable

![Test](https://github.com/kamescg/delegatable-sol/actions/workflows/test.yml/badge.svg)

![Coverage](https://github.com/kamescg/delegatable-sol/actions/workflows/coverage.yml/badge.svg)

![TS](https://badgen.net/badge/-/TypeScript?icon=typescript&label&labelColor=blue&color=555555)

[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](http://perso.crans.org/besson/LICENSE.html)

Solidity framework for extending any contract with counterfactual revocable-delegation

## Getting Started

- [Main docs site](https://delegatable.org)

- [A high level summary of the goals of the Delegatable framework](https://mirror.xyz/0x55e2780588aa5000F464f700D2676fD0a22Ee160/pTIrlopsSUvWAbnq1qJDNKU1pGNLP8VEn1H8DSVcvXM).

- [A series of conversations about the framework on YouTube](https://www.youtube.com/watch?v=Sh1-epThZV0&list=PLJP4kXm9a01qRJaNzCU47gOzkn1eNAlFO).

- [A reference app called MobyMask](https://github.com/delegatable/MobyMask).

- [A JS library for creating & redeeming delegations](https://www.npmjs.com/package/eth-delegatable-utils).

There are three general ways to integrate Delegatable into a Solidity project

- Inherit from the [Delegatable.sol](./contracts/Delegatable.sol) contract. (Most gas up front, cheapest per tx).

- Use our [trusted relay](./docs/relay.md) to allow your contract to accept delegated messages from a global relay contract.

- If your contract uses the ERC-2535 Diamond standard, you can add [A Delegatable Facet for Diamonds](./contracts/diamond/README.md)

## Deployment

These contracts can be deployed to a network by running:

`yarn deploy `

Some of them [have been deployed already and can be reused](./deployments.md).

## Verification

These contracts can be verified on Etherscan.

`yarn verify`

## Testing

Run the unit tests locally with:

`yarn test`

## Coverage

Generate the test coverage report with:

`yarn coverage`

## Documentation

Add inline docs in the [natspec](https://docs.soliditylang.org/en/v0.8.15/natspec-format.html) format. The command `yarn docs` and `yarn docs:html` will generate the markdown and minimal html site which can be easily published.