flmel / evaluator-integration-checks Goto Github PK

Add documentation
each of the integration check - expectations, input/output and how to run
add main readme.md

A total classic error is that people will receive money, make a XCC, the XCC will fail, and they will forget to return the funds to the user.

I honestly saw this happening a bunch of times, specially in the NFT context, were people will receive money, ask to mint an NFT, the mint will fail, and now the user does not have neither the money nor the NFT.

We need to test this:

• The contract receives money
• They call a method that fails
• The money needs to be returned to the user
• But!! I want something on the state to change... so they need to handle the call, and not just panic.

We ask the user to create a contract that takes attachedDeposit and bridges it to another fixed contract (e.g. validator.test) while keeping track of the total user's deposits.

In code:

deposit(number){
  xcc to stake the money in "validator.test"
  callback(deposit_attached)
}

callback_handler(deposit_attached){
  if error
    return money
  }else{
    this.deposit[user] += amount_staked
  }
}

deposit_for(account){
  this.deposit[user]
}

We need to make sure using batch calls that the user is NOT making this:

deposit(number){
  this.deposit[user] += amount_staked
  xcc to stake the money in "validator.test"
  callback(deposit_attached)
}

callback_handler(deposit_attached){
  if error
    this.deposit[user] -= amount_staked
    return money
  }
}

deposit_for(account){
  this.deposit[user]
}

Test that the people understand how to:

• Handle deposits
• Transfer NEAR out of the contract

Evaluating nested collections is also a great way to remember people that:

They need to use different sufixes for their collections
They can combine native collections with SDK collections

We can take the test from complex_input, and simply ask the user now to also store it in the contract.

So they need to both:

• Take the input and return the transformation of it (i.e. exactly the complex_input test.
• They also need to store it, so we can call another method after, and retrieve the same result as complex_input.