Skip to content

Commit

Permalink
Add EIP-7699: Soul Resonance Token
Browse files Browse the repository at this point in the history
  • Loading branch information
mike0x1024 committed Apr 28, 2024
1 parent 6a0a792 commit 28734d1
Showing 1 changed file with 90 additions and 0 deletions.
90 changes: 90 additions & 0 deletions EIPS/eip-7699.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
---
eip: 7699
title: Soul Resonance Token
description: this EIP defines an interface for Soul Resonance Tokens
author: Mike Smith (@mike0x1024), Abe Johnson <[email protected]>, Alvis Kaiser <[email protected]>, WurDst Tsao <[email protected]>
discussions-to: https://ethereum-magicians.org/t/1

Check failure on line 6 in EIPS/eip-7699.md

View workflow job for this annotation

GitHub Actions / EIP Walidator

preamble header `discussions-to` should point to a thread on ethereum-magicians.org

error[preamble-re-discussions-to]: preamble header `discussions-to` should point to a thread on ethereum-magicians.org --> EIPS/eip-7699.md:6:16 | 6 | discussions-to: https://ethereum-magicians.org/t/1 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ required pattern was not matched | = info: the pattern in question: `^https://ethereum-magicians.org/t/[^/]+/[0-9]+$` = help: see https://ethereum.github.io/eipw/preamble-re-discussions-to/
status: Draft
type: Standards Track
category: ERC

Check failure on line 9 in EIPS/eip-7699.md

View workflow job for this annotation

GitHub Actions / EIP Walidator

preamble header `category` has an unrecognized value

error[preamble-enum-category]: preamble header `category` has an unrecognized value --> EIPS/eip-7699.md:9:10 | 9 | category: ERC | ^^^^ must be one of: `Core`, `Networking`, `Interface` | = help: see https://ethereum.github.io/eipw/preamble-enum-category/
created: 2024-04-28
requires: 20
---

Check failure on line 13 in EIPS/eip-7699.md

View workflow job for this annotation

GitHub Actions / EIP Walidator

body is missing section(s): `Rationale`, `Security Considerations`

error[markdown-req-section]: body is missing section(s): `Rationale`, `Security Considerations` --> EIPS/eip-7699.md | | = help: must be at the second level (`## Heading`) = help: see https://ethereum.github.io/eipw/markdown-req-section/
## Abstract

This EIP proposes the following improvements to Soul Bond Tokens:
Extensibility to [ERC-20](./eip-20.md).
Token Minting and Burning while preserving non-transferability.

## Motivation

The inspiration behind this EIP stems from discussions surrounding the advantages and potential applications of Soulbound/Account Bound Tokens (SBTs). However, upon analysing the pros and cons of SBTs, it has been determined that while the non-transferable nature of SBTs, which binds them to user accounts, can serve as a notable feature akin to a badge of honour, it also impedes the fluidity and evolution of the tokens themselves. SRT, short for Soul Resonance Token, is a special token protocol. Like SBT, SRT does not support transfer methods, meaning users cannot transfer SRT assets between different accounts. What makes SRT special is that, through the Bonding Curve protocol, the mint() and burn() methods are constructed to achieve pricing and trading functions for SRT. Therefore, SRT is a type of asset that cannot be transferred but can be traded. SRT fills the gap between SBT and traditional [ERC-20](./eip-20.md) assets, possessing both the soul-binding characteristics of SBT and the tradability of traditional [ERC-20](./eip-20.md) assets.

## Characteristics

Check failure on line 24 in EIPS/eip-7699.md

View workflow job for this annotation

GitHub Actions / EIP Walidator

body has extra section(s)

error[markdown-order-section]: body has extra section(s) --> EIPS/eip-7699.md | 24 | ## Characteristics | ::: EIPS/eip-7699.md | 37 | ## Token Methods | ::: EIPS/eip-7699.md | 77 | ## Citation | ::: EIPS/eip-7699.md | 82 | ## References | = help: see https://ethereum.github.io/eipw/markdown-order-section/

The tokens are confined solely to minting and burning functionalities, precluding any transferability.
During the execution of minting and burning transactions, the system logs the cumulative reputation associated with the respective account.
On-chain events are deployed to meticulously capture and document the progression of reputation accumulation.

## Specification

Notes:
The contract is designed to be compiled with a Solidity compiler version greater than or equal to 0.8.20 but less than 0.9.0.

The smart contract realising this EIP mandate must fully incorporate all methods prescribed by [ERC-20](./eip-20.md), with the exception of transfer operations. Furthermore, exclusivity to implementing solely this EIP is required.

## Token Methods

### Internal _update Function Override

```solidity
function _update(address from, address to, uint256 value) internal virtual override {
if (from != address(0) && to != address(0)) {
revert TransferNotAllowed();
}
super._update(from, to, values);
}
```


Description: This function overrides the _update function inherited from the [ERC-20](./eip-20.md) contract. It is an internal function that is used internally by the [ERC-20](./eip-20.md) contract to update the balances of token holders during transfer operations. In this contract, it restricts transfers between non-zero addresses, reverting the transaction with the "TransferNotAllowed" error if both the sender and receiver addresses are non-zero.

### Mint

```solidity
function mint(address to, uint256 amount) public {
_mint(to, amount);
}
```

Description: This function allows the contract owner to mint new tokens and allocate them to a specified address. It increases the balance of the specified address by the given amount of tokens. This function can be used to create new tokens and distribute them as needed.

### Burn

```solidity
function burn(address from, uint256 amount) public {
_burn(from, amount);
}
```

Description: This function allows token holders to burn a specific amount of their tokens. It decreases the balance of the specified address by the given amount of tokens. Burning tokens means removing them from circulation permanently. This function provides token holders with the ability to reduce their token balances voluntarily.

## Backwards Compatibility

This proposal is only partially compatible with [ERC-20](./eip-20.md) because it makes tokens non-transferable after the first transfer.

## Citation

Please cite this document as:
Burve Labs. "Bridging the Gap: Soul Resonance Token (SRT) Non-transferable yet Tradable Asset Type based on Bonding Curve"Burve Labs. 20 Apr. 2024.

## References

**Implementations**

- [ERC-7699 Reference Implementation](https://github.com/mike0x1024/srt-template)

Check failure on line 86 in EIPS/eip-7699.md

View workflow job for this annotation

GitHub Actions / EIP Walidator

non-relative link or image

error[markdown-rel-links]: non-relative link or image --> EIPS/eip-7699.md | 86 | - [ERC-7699 Reference Implementation](https://github.com/mike0x1024/srt-template) | = help: see https://ethereum.github.io/eipw/markdown-rel-links/

## Copyright

Copyright and related rights waived via [CC0](../LICENSE.md).

0 comments on commit 28734d1

Please sign in to comment.