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.

Sign up for GitHub

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

Jump to bottom

refactor: change disclaimer when the nft is non-transferable #821

Merged
merged 1 commit into from
Feb 11, 2024
Merged

refactor: change disclaimer when the nft is non-transferable #821

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 13 additions & 5 deletions src/SablierV2NFTDescriptor.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,10 @@ contract SablierV2NFTDescriptor is ISablierV2NFTDescriptor {
generateDescription({
streamingModel: vars.streamingModel,
assetSymbol: vars.assetSymbol,
streamId: streamId.toString(),
sablierAddress: vars.sablierAddress,
assetAddress: vars.asset.toHexString()
assetAddress: vars.asset.toHexString(),
streamId: streamId.toString(),
isTransferable: vars.sablier.isTransferable(streamId)
}),
'","external_url":"https://sablier.com","name":"',
generateName({ streamingModel: vars.streamingModel, streamId: streamId.toString() }),
Expand Down Expand Up @@ -250,14 +251,21 @@ contract SablierV2NFTDescriptor is ISablierV2NFTDescriptor {
function generateDescription(
string memory streamingModel,
string memory assetSymbol,
string memory streamId,
string memory sablierAddress,
string memory assetAddress
string memory assetAddress,
string memory streamId,
bool isTransferable
)
internal
pure
returns (string memory)
{
// Depending on the transferability of the NFT, declare the relevant information.
string memory info = isTransferable
?
unicode"⚠️ WARNING: Transferring the NFT makes the new owner the recipient of the stream. The funds are not automatically withdrawn for the previous recipient."
: unicode"❕INFO: This NFT is non-transferable. It cannot be sold or transferred to another account.";

return string.concat(
"This NFT represents a payment stream in a Sablier V2 ",
streamingModel,
Expand All @@ -274,7 +282,7 @@ contract SablierV2NFTDescriptor is ISablierV2NFTDescriptor {
" Address: ",
assetAddress,
"\\n\\n",
unicode"⚠️ WARNING: Transferring the NFT makes the new owner the recipient of the stream. The funds are not automatically withdrawn for the previous recipient."
info
);
}

Expand Down
7 changes: 4 additions & 3 deletions test/mocks/NFTDescriptorMock.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,15 +54,16 @@ contract NFTDescriptorMock is SablierV2NFTDescriptor {
function generateDescription_(
string memory streamingModel,
string memory assetSymbol,
string memory streamId,
string memory sablierAddress,
string memory assetAddress
string memory assetAddress,
string memory streamId,
bool isTransferable
)
external
pure
returns (string memory)
{
return generateDescription(streamingModel, assetSymbol, streamId, sablierAddress, assetAddress);
return generateDescription(streamingModel, assetSymbol, sablierAddress, assetAddress, streamId, isTransferable);
}

function generateName_(
Expand Down
46 changes: 40 additions & 6 deletions test/unit/concrete/nft-descriptor/generateDescription.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,13 @@ pragma solidity >=0.8.22 <0.9.0;
import { NFTDescriptor_Unit_Concrete_Test } from "./NFTDescriptor.t.sol";

contract GenerateDescription_Unit_Concrete_Test is NFTDescriptor_Unit_Concrete_Test {
string internal constant DISCLAIMER =
string internal constant INFO_NON_TRANSFERABLE =
andreivladbrg marked this conversation as resolved.
Show resolved Hide resolved
unicode"❕INFO: This NFT is non-transferable. It cannot be sold or transferred to another account.";
string internal constant INFO_TRANSFERABLE =
unicode"⚠️ WARNING: Transferring the NFT makes the new owner the recipient of the stream. The funds are not automatically withdrawn for the previous recipient.";

function test_GenerateDescription_Empty() external {
string memory actualDescription = nftDescriptorMock.generateDescription_("", "", "", "", "");
string memory actualDescription = nftDescriptorMock.generateDescription_("", "", "", "", "", true);
string memory expectedDescription = string.concat(
"This NFT represents a payment stream in a Sablier V2 ",
" contract. The owner of this NFT can withdraw the streamed assets, which are denominated in ",
Expand All @@ -20,18 +22,50 @@ contract GenerateDescription_Unit_Concrete_Test is NFTDescriptor_Unit_Concrete_T
"\\n- ",
" Address: ",
"\\n\\n",
DISCLAIMER
INFO_TRANSFERABLE
);
assertEq(actualDescription, expectedDescription, "metadata description");
}

function test_GenerateDescription() external {
function test_GenerateDescription_NonTransferable() external {
string memory actualDescription = nftDescriptorMock.generateDescription_(
"Lockup Linear",
dai.symbol(),
"0x78B190C1E493752f85E02b00a0C98851A5638A30",
"0xFEbD67A34821d1607a57DD31aae5f246D7dE2ca2",
"42",
false
);
string memory expectedDescription = string.concat(
"This NFT represents a payment stream in a Sablier V2 ",
"Lockup Linear",
" contract. The owner of this NFT can withdraw the streamed assets, which are denominated in ",
dai.symbol(),
".\\n\\n",
"- Stream ID: ",
"42",
"\\n- ",
"Lockup Linear",
" Address: ",
"0x78B190C1E493752f85E02b00a0C98851A5638A30",
"0xFEbD67A34821d1607a57DD31aae5f246D7dE2ca2"
"\\n- ",
"DAI",
" Address: ",
"0xFEbD67A34821d1607a57DD31aae5f246D7dE2ca2",
"\\n\\n",
INFO_NON_TRANSFERABLE
);
assertEq(actualDescription, expectedDescription, "metadata description");
}

function test_GenerateDescription() external {
string memory actualDescription = nftDescriptorMock.generateDescription_(
"Lockup Linear",
dai.symbol(),
"0x78B190C1E493752f85E02b00a0C98851A5638A30",
"0xFEbD67A34821d1607a57DD31aae5f246D7dE2ca2",
"42",
true
);
string memory expectedDescription = string.concat(
"This NFT represents a payment stream in a Sablier V2 ",
Expand All @@ -50,7 +84,7 @@ contract GenerateDescription_Unit_Concrete_Test is NFTDescriptor_Unit_Concrete_T
" Address: ",
"0xFEbD67A34821d1607a57DD31aae5f246D7dE2ca2",
"\\n\\n",
DISCLAIMER
INFO_TRANSFERABLE
);
assertEq(actualDescription, expectedDescription, "metadata description");
}
Expand Down
Loading