search

ar-io / arns-service

Koa microservice that leverages Warp to support the ArNS Portal and ar.io observers.
https://api.arns.app
GNU Affero General Public License v3.0
19 stars 4 forks source link

feat(sortKey): allow `sortKey` or `blockHeight` to be provided via qu… #76

Closed dtfiedler closed 7 months ago

dtfiedler commented 7 months ago

…ery param

This allows us to evaluate a contract state up to a specified sortKey or blockHeight.

Block Height example:

curl http://localhost:3000/v1/contract/bLAgYxAdX2Ry-nt6aH2ixgvJXbpsEYm28NgJgyqfs-U/interactions?blockHeight=1307087
{
    "contractTxId": "bLAgYxAdX2Ry-nt6aH2ixgvJXbpsEYm28NgJgyqfs-U",
    "interactions": [
        {
            "height": 1307087,
            "timestamp": 1700594511,
            "input": {
                "function": "buyRecord",
                "name": "developer",
                "contractTxId": "atomic",
                "type": "lease",
                "years": 2,
                "auction": false
            },
            "owner": "J-x6qHeWPYuzbi2pt0HtPw5KxitNwRU2I3hdUWJ9DAo",
            "sortKey": "000001307087,0000000000000,6c094a6ae0b62b50afc204dc91c2d8663ffe61904097c09efde8cc0ca1df4e78",
            "valid": false,
            "error": "Caller balance not high enough to purchase this name for 1837.5 token(s)!",
            "id": "IHvhOecLEtgVaOFfKJW9Ig4GQzfxnPnLuzuYawNaCm0"
        },
        {
            "height": 1307087,
            "timestamp": 1700594511,
            "input": {
                "function": "buyRecord",
                "name": "deepanshu",
                "contractTxId": "atomic",
                "type": "lease",
                "years": 2,
                "auction": false
            },
            "owner": "J-x6qHeWPYuzbi2pt0HtPw5KxitNwRU2I3hdUWJ9DAo",
            "sortKey": "000001307087,0000000000000,42845e0d850895e791f498c13cb7850405d9c3a7f631af7f0ca2cef28348a8ea",
            "valid": true,
            "id": "tLUDNRR82EXEZYqCDsAdnibdWtNWFzfZ2Rhdcp0W7S8"
        }
        ...
    ],
    "sortKey": "000001307087,0000000000000,6c094a6ae0b62b50afc204dc91c2d8663ffe61904097c09efde8cc0ca1df4e78",
    "evaluationOptions": { "maxInteractionEvaluationTimeSeconds": 3600 }
}

Sort Key example:

curl http://localhost:3000/v1/contract/bLAgYxAdX2Ry-nt6aH2ixgvJXbpsEYm28NgJgyqfs-U?sortKey=000001307087,0000000000000,0cbe0824cdf7ba421c49d08ebf6cd0957d0396da8ebe78107a37baa31ed5bbe4

Result:

{
  "contractTxId": "bLAgYxAdX2Ry-nt6aH2ixgvJXbpsEYm28NgJgyqfs-U",
  "state": {
    "auctions": {
      "alacazam": {
        "contractTxId": "PP2uMO_Ig7bGCYswrhDWfaPR27qKl0GikgVJyRTS0Qs",
        "endHeight": 1317112,
        "floorPrice": 3000,
        "initiator": "7waR8v4STuwPnTck1zFVkQqJh5K9q9Zik4Y5-5dV7nk",
        "settings": {
          "auctionDuration": 10080,
          "exponentialDecayRate": 0.000002,
          "floorPriceMultiplier": 1,
          "scalingExponent": 190,
          "startPriceMultiplier": 50
        },
        "startHeight": 1307032,
        "startPrice": 150000,
        "type": "permabuy"
      },
      // other auctions
    },
    "balances": {
      "-4xgjroXENKYhTWqrBo57HQwvDL51mMvSxJy6Y2Z_sA": 5000,
      "-7vXsQZQDk8TMDlpiSLy3CnLi5PDPlAaN2DaynORpck": 5000,
      "-9JU3W8g9nOAB1OrJQ8FxkaWCpv5slBET2HppTItbmk": 5000,
      "-9ip1RdBZ64owkHXgY7dvRddgm39K_0uikAJX05YkHw": 5000,
      "-C5AiYcMmrOFHrnQwhJg1Xtzhz23T0zNB0ACge1otHs": 89.0187421874997,
      // other balances
    },
    // other state data
    "ticker": "tIO"
  },
  "sortKey": "000001307087,0000000000000,6c094a6ae0b62b50afc204dc91c2d8663ffe61904097c09efde8cc0ca1df4e78",
  "evaluationOptions": { "maxInteractionEvaluationTimeSeconds": 3600 }
}