feat: Deferred and Marketplace methods to always guarantee to buy the…

… next token
EKOKE-DAO · Dec 5, 2024 · 8ee16f2 · 8ee16f2
1 parent 807ebff
commit 8ee16f2
Show file tree

Hide file tree

Showing 10 changed files with 976 additions and 184 deletions.
diff --git a/docs/contracts/Deferred.md b/docs/contracts/Deferred.md
@@ -55,4 +55,11 @@ The tokens are eventually phyisically minted when they are first bought. So when
 
 It's important to know that **Deferred ERC721 can't be transferred by the token owner**, but only by the [Marketplace](./Marketplace.md). The marketplace is always allowed to transfer tokens, while the user is never allowed to. It's neither allowed to call `approve` on the contract.
 
+The Marketplace calls the `transferToken` which will transfer the next `token` for the provided contract id for the buyer to get. This means that:
+
+1. If the buyer is the contract buyer, this will get the next token id owned by the first third-party investor, or if none the contract seller.
+2. If the buyer is a third-party investor, this will get the next token id owned by the contract seller.
+
+Others methods like `transferFrom` or `safeTransferFrom` are disabled
+
 This is of course done to prevent users from selling the tokens breaking their intrisic price, defined at the contract creation. The **token price will never change**.
diff --git a/docs/contracts/Marketplace.md b/docs/contracts/Marketplace.md
@@ -20,16 +20,18 @@ If the Buyer of the contract buys the token, he will pay the token price plus th
 
 ## Buy process
 
-The Marketplace contract provides two functions useful to buy a process, the `buyToken` method and the `tokenPriceForCaller` view method.
+The Marketplace contract provides two functions useful to buy a process, the `buyNextToken` method and the `tokenPriceForCaller` view method.
+
+`buyNextToken` will always buy the next token available to be bought for the contract.
 
 ```solidity
 function tokenPriceForCaller(
-    uint256 _tokenId
+    uint256 _contractId
 ) external view returns (uint256) {}
 ```
 
 ```solidity
-function buyToken(uint256 _tokenId) external {}
+function buyNextToken(uint256 _contractId) external {}
 ```
 
 So the buy process is divided in two parts.

diff --git a/ethereum/app/src/js/web3/contracts/Deferred.ts b/ethereum/app/src/js/web3/contracts/Deferred.ts
@@ -365,6 +365,44 @@ export const ABI = [
     stateMutability: 'nonpayable',
     type: 'function',
   },
+  {
+    inputs: [
+      {
+        internalType: 'uint256',
+        name: '_contractId',
+        type: 'uint256',
+      },
+    ],
+    name: 'contractCompleted',
+    outputs: [
+      {
+        internalType: 'bool',
+        name: 'completed',
+        type: 'bool',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [
+      {
+        internalType: 'uint256',
+        name: '_contractId',
+        type: 'uint256',
+      },
+    ],
+    name: 'contractProgress',
+    outputs: [
+      {
+        internalType: 'uint256',
+        name: '_progress',
+        type: 'uint256',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
   {
     inputs: [
       {
@@ -459,6 +497,89 @@ export const ABI = [
     stateMutability: 'view',
     type: 'function',
   },
+  {
+    inputs: [
+      {
+        internalType: 'uint256',
+        name: '_contractId',
+        type: 'uint256',
+      },
+    ],
+    name: 'getContract',
+    outputs: [
+      {
+        components: [
+          {
+            internalType: 'string',
+            name: 'metadataUri',
+            type: 'string',
+          },
+          {
+            components: [
+              {
+                internalType: 'address',
+                name: 'seller',
+                type: 'address',
+              },
+              {
+                internalType: 'uint256',
+                name: 'tokenFromId',
+                type: 'uint256',
+              },
+              {
+                internalType: 'uint256',
+                name: 'tokenToId',
+                type: 'uint256',
+              },
+            ],
+            internalType: 'struct Deferred.Seller[]',
+            name: 'sellers',
+            type: 'tuple[]',
+          },
+          {
+            internalType: 'address[]',
+            name: 'buyers',
+            type: 'address[]',
+          },
+          {
+            internalType: 'uint256',
+            name: 'ekokeReward',
+            type: 'uint256',
+          },
+          {
+            internalType: 'uint256',
+            name: 'tokenPriceUsd',
+            type: 'uint256',
+          },
+          {
+            internalType: 'uint256',
+            name: 'tokenFromId',
+            type: 'uint256',
+          },
+          {
+            internalType: 'uint256',
+            name: 'tokenToId',
+            type: 'uint256',
+          },
+          {
+            internalType: 'bool',
+            name: 'closed',
+            type: 'bool',
+          },
+          {
+            internalType: 'bool',
+            name: 'created',
+            type: 'bool',
+          },
+        ],
+        internalType: 'struct Deferred.SellContract',
+        name: '_sellContract',
+        type: 'tuple',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
   {
     inputs: [
       {
@@ -509,6 +630,49 @@ export const ABI = [
     stateMutability: 'view',
     type: 'function',
   },
+  {
+    inputs: [
+      {
+        internalType: 'uint256',
+        name: '_contractId',
+        type: 'uint256',
+      },
+    ],
+    name: 'nextTokenIdToBuy',
+    outputs: [
+      {
+        internalType: 'uint256',
+        name: '_nextTokenId',
+        type: 'uint256',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
+  {
+    inputs: [
+      {
+        internalType: 'uint256',
+        name: '_contractId',
+        type: 'uint256',
+      },
+      {
+        internalType: 'address',
+        name: '_caller',
+        type: 'address',
+      },
+    ],
+    name: 'nextTokenIdToBuyFor',
+    outputs: [
+      {
+        internalType: 'uint256',
+        name: '',
+        type: 'uint256',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
   {
     inputs: [],
     name: 'owner',
@@ -588,28 +752,28 @@ export const ABI = [
     inputs: [
       {
         internalType: 'address',
-        name: 'from',
+        name: '',
         type: 'address',
       },
       {
         internalType: 'address',
-        name: 'to',
+        name: '',
         type: 'address',
       },
       {
         internalType: 'uint256',
-        name: 'tokenId',
+        name: '',
         type: 'uint256',
       },
       {
         internalType: 'bytes',
-        name: 'data',
+        name: '',
         type: 'bytes',
       },
     ],
     name: 'safeTransferFrom',
     outputs: [],
-    stateMutability: 'nonpayable',
+    stateMutability: 'pure',
     type: 'function',
   },
   {
@@ -787,23 +951,23 @@ export const ABI = [
     inputs: [
       {
         internalType: 'address',
-        name: 'from',
+        name: '',
         type: 'address',
       },
       {
         internalType: 'address',
-        name: 'to',
+        name: '',
         type: 'address',
       },
       {
         internalType: 'uint256',
-        name: 'tokenId',
+        name: '',
         type: 'uint256',
       },
     ],
     name: 'transferFrom',
     outputs: [],
-    stateMutability: 'nonpayable',
+    stateMutability: 'pure',
     type: 'function',
   },
   {
@@ -819,6 +983,35 @@ export const ABI = [
     stateMutability: 'nonpayable',
     type: 'function',
   },
+  {
+    inputs: [
+      {
+        internalType: 'uint256',
+        name: '_contractId',
+        type: 'uint256',
+      },
+      {
+        internalType: 'address',
+        name: 'from',
+        type: 'address',
+      },
+      {
+        internalType: 'address',
+        name: 'to',
+        type: 'address',
+      },
+    ],
+    name: 'transferToken',
+    outputs: [
+      {
+        internalType: 'uint256',
+        name: '_tokenId',
+        type: 'uint256',
+      },
+    ],
+    stateMutability: 'nonpayable',
+    type: 'function',
+  },
 ];
 
 interface ContractAddress {

diff --git a/ethereum/app/src/js/web3/contracts/Marketplace.ts b/ethereum/app/src/js/web3/contracts/Marketplace.ts
@@ -83,6 +83,12 @@ export const ABI = [
         name: 'seller',
         type: 'address',
       },
+      {
+        indexed: false,
+        internalType: 'uint256',
+        name: 'contractId',
+        type: 'uint256',
+      },
       {
         indexed: false,
         internalType: 'uint256',
@@ -135,12 +141,18 @@ export const ABI = [
     inputs: [
       {
         internalType: 'uint256',
-        name: '_tokenId',
+        name: '_contractId',
+        type: 'uint256',
+      },
+    ],
+    name: 'buyNextToken',
+    outputs: [
+      {
+        internalType: 'uint256',
+        name: 'tokenId',
         type: 'uint256',
       },
     ],
-    name: 'buyToken',
-    outputs: [],
     stateMutability: 'nonpayable',
     type: 'function',
   },
@@ -177,6 +189,25 @@ export const ABI = [
     stateMutability: 'nonpayable',
     type: 'function',
   },
+  {
+    inputs: [
+      {
+        internalType: 'uint256',
+        name: '_contractId',
+        type: 'uint256',
+      },
+    ],
+    name: 'tokenPriceForCaller',
+    outputs: [
+      {
+        internalType: 'uint256',
+        name: '',
+        type: 'uint256',
+      },
+    ],
+    stateMutability: 'view',
+    type: 'function',
+  },
   {
     inputs: [
       {