Feature/escrow_payments

.github/workflows/ci.yml

@@ -125,23 +125,25 @@ jobs:
               DOCKERHUB_PASSWORD: ${{ secrets.DOCKERHUB_PASSWORD }}
       - name: Run Barge
         working-directory: ${{ github.workspace }}/barge
+        env:
+          CONTRACTS_VERSION: escrow
         run: |
-          bash -x start_ocean.sh --no-aquarius --no-provider --no-dashboard --with-c2d --with-typesense 2>&1 > start_ocean.log &
+          bash -x start_ocean.sh --no-aquarius --no-provider --no-dashboard --with-typesense 2>&1 > start_ocean.log &
       - run: npm ci
       - run: npm run build
       - run: docker image ls
       - name: Delete default runner images
         run: |
           rm -rf /usr/share/swift/
-      - name: Wait for contracts deployment and C2D cluster to be ready
+      - name: Wait for contracts deployment
         working-directory: ${{ github.workspace }}/barge
         run: |
           for i in $(seq 1 250); do
-            sleep 10
-            [ -f "$HOME/.ocean/ocean-contracts/artifacts/ready" -a -f "$HOME/.ocean/ocean-c2d/ready" ] && break
+            sleep 5
+            [ -f "$HOME/.ocean/ocean-contracts/artifacts/ready" ] && break
             done
       - name: docker logs
-        run: docker logs ocean-ocean-contracts-1 && docker logs ocean-kindcluster-1 && docker logs ocean-computetodata-1 && docker logs ocean-typesense-1
+        run: docker logs ocean-ocean-contracts-1 && docker logs ocean-typesense-1
         if: ${{ failure() }}
       - name: integration tests
         run: npm run test:integration:cover
@@ -210,8 +212,9 @@ jobs:
       - name: Run Barge
         working-directory: ${{ github.workspace }}/barge
         run: |
-          bash -x start_ocean.sh --no-aquarius --no-provider --no-dashboard --with-c2d --with-typesense 2>&1 > start_ocean.log &
-
+          bash -x start_ocean.sh --no-aquarius --no-provider --no-dashboard --with-typesense 2>&1 > start_ocean.log &
+        env:
+          CONTRACTS_VERSION: escrow
       - run: npm ci
       - run: npm run build
       - run: docker image ls
@@ -224,7 +227,7 @@ jobs:
         run: |
           for i in $(seq 1 250); do
             sleep 10
-            [ -f "$HOME/.ocean/ocean-contracts/artifacts/ready" -a -f "$HOME/.ocean/ocean-c2d/ready" ] && break
+            [ -f "$HOME/.ocean/ocean-contracts/artifacts/ready" ] && break
           done
 
       - name: docker logs

docs/env.md

@@ -28,6 +28,10 @@ Environmental variables are also tracked in `ENVIRONMENT_VARIABLES` within `src/
 - `MAX_CHECKSUM_LENGTH`: Define the maximum length for a file if checksum is required (Mb). Example: `10`
 - `IS_BOOTSTRAP`: Is this node to be used as bootstrap node or not. Default is `false`.
 
+## Payments
+
+- `ESCROW_CLAIM_TIMEOUT`: Amount of time reserved to claim a escrow payment, in seconds. Defaults to `600`. Example: `600`
+
 ## Logs
 
 - `LOG_LEVEL`: Define the default log level. Example: `debug`

package.json

@@ -72,7 +72,7 @@
     "@libp2p/upnp-nat": "^1.2.1",
     "@libp2p/websockets": "^8.1.1",
     "@multiformats/multiaddr": "^10.2.0",
-    "@oceanprotocol/contracts": "^2.2.0",
+    "@oceanprotocol/contracts": "^2.3.0-next.1",
     "@rdfjs/dataset": "^2.0.1",
     "@rdfjs/types": "^1.1.0",
     "@types/lodash.clonedeep": "^4.5.7",

src/@types/C2D/C2D.ts

@@ -24,7 +24,7 @@ export type ComputeResourceType = 'cpu' | 'ram' | 'disk' | any
 
 export interface ComputeResourcesPricingInfo {
   id: ComputeResourceType
-  price: number // price per unit
+  price: number // price per unit per minute
 }
 
 export interface ComputeResource {
@@ -41,6 +41,10 @@ export interface ComputeResourceRequest {
   amount: number
 }
 
+export interface ComputeResourceRequestWithPrice extends ComputeResourceRequest {
+  price?: number // price per unit per minute
+}
+
 export interface ComputeEnvFees {
   feeToken: string
   prices: ComputeResourcesPricingInfo[]
@@ -120,8 +124,7 @@ export interface ComputeJob {
   results: ComputeResult[]
   inputDID?: string[]
   algoDID?: string
-  agreementId?: string
-  expireTimestamp: number
+  maxJobDuration: number
   environment?: string
 }
 
@@ -160,6 +163,12 @@ export interface AlgoChecksums {
   container: string
 }
 
+export interface DBComputeJobPayment {
+  chainId: number
+  token: string
+  lockTx: string
+  claimTx: string
+}
 // this is the internal structure
 export interface DBComputeJob extends ComputeJob {
   clusterHash: string
@@ -173,8 +182,11 @@ export interface DBComputeJob extends ComputeJob {
   isRunning: boolean
   isStarted: boolean
   containerImage: string
-  resources: ComputeResourceRequest[]
   isFree: boolean
+  algoStartTimestamp: string
+  algoStopTimestamp: string
+  resources: ComputeResourceRequestWithPrice[]
+  payment?: DBComputeJobPayment
 }
 
 // make sure we keep them both in sync

src/@types/Escrow.ts

@@ -0,0 +1,17 @@
+export interface EscrowAuthorization {
+  address: string
+  maxLockedAmount: BigInt
+  currentLockedAmount: BigInt
+  maxLockSeconds: BigInt
+  maxLockCounts: BigInt
+  currentLocks: BigInt
+}
+
+export interface EscrowLock {
+  jobId: BigInt
+  payer: string
+  payee: string
+  amount: BigInt
+  expiry: BigInt
+  token: string
+}

src/@types/Fees.ts

@@ -28,7 +28,6 @@ export interface ProviderFeeData {
 
 export interface ProviderFeeValidation {
   isValid: boolean // true if valid provider fee for download
-  isComputeValid: boolean // true is valid for compute
   message: any
   validUntil: number
 }
@@ -57,7 +56,16 @@ export interface ProviderComputeInitialize {
   providerFee?: ProviderFees
 }
 
+export interface ProviderComputeInitializePayment {
+  escrowAddress: string
+  payee: string
+  chainId: number
+  minLockSeconds: number
+  token: string
+  amount: string
+}
 export interface ProviderComputeInitializeResults {
   algorithm?: ProviderComputeInitialize
   datasets?: ProviderComputeInitialize[]
+  payment: ProviderComputeInitializePayment
 }

src/@types/OceanNode.ts

@@ -79,6 +79,7 @@ export interface OceanNodeConfig {
   httpPort: number
   feeStrategy: FeeStrategy
   supportedNetworks?: RPCS
+  claimDurationTimeout: number
   indexingNetworks?: RPCS
   c2dClusters: C2DClusterInfo[]
   c2dNodeUri: string

src/@types/commands.ts

@@ -151,29 +151,21 @@ export interface ComputeGetEnvironmentsCommand extends Command {
   chainId?: number
 }
 
-export interface ComputeDetails {
-  env: string // with hash
-  validUntil: number
+export interface ComputePayment {
+  chainId: number
+  token: string
+  maxJobDuration: number // in seconds
+  resources?: ComputeResourceRequest[]
 }
 export interface ComputeInitializeCommand extends Command {
   datasets: [ComputeAsset]
   algorithm: ComputeAlgorithm
-  compute: ComputeDetails
+  environment: string
+  payment: ComputePayment
   consumerAddress: string
   signature?: string
 }
 
-export interface ComputeStartCommand extends Command {
-  consumerAddress: string
-  signature: string
-  nonce: string
-  environment: string
-  algorithm: ComputeAlgorithm
-  datasets?: ComputeAsset[]
-  output?: ComputeOutput
-  resources?: ComputeResourceRequest[]
-  chainId?: number // network used by payment
-}
 export interface FreeComputeStartCommand extends Command {
   consumerAddress: string
   signature: string
@@ -184,6 +176,9 @@ export interface FreeComputeStartCommand extends Command {
   output?: ComputeOutput
   resources?: ComputeResourceRequest[]
 }
+export interface PaidComputeStartCommand extends FreeComputeStartCommand {
+  payment: ComputePayment
+}
 
 export interface ComputeStopCommand extends Command {
   consumerAddress: string