Supported Criteria

On this page, you can find all the criteria supported by the Armory Policy Engine. These will be used to build policy conditions.

Have a use-case not supported? Additional criteria can be created to model nearly any scenario.

checkAction

{
  "criterion": "checkAction",
  "args": ["signTransaction"]
}

args

checkResource

{
  "criterion": "checkResource",
  "args": ["vault"]
}

checkPermission

{
  "criterion": "checkPermission",
  "args": ["wallet:read"]
}

This criterion applies an AND between each argument in the array

checkPrincipalId

{
  "criterion": "checkPrincipalId",
  "args": ["bob"]
}

checkPrincipalRole

{
  "criterion": "checkPrincipalRole",
  "args": ["admin"]
}

checkPrincipalGroup

{
  "criterion": "checkPrincipalGroup",
  "args": ["developers"]
}

checkAccountId

{
  "criterion": "checkAccountId",
  "args": ["eip155:eoa:0xddcf208f219a6e6af072f2cfdc615b2c1805f98e"]
}

checkAccountAddress

{
  "criterion": "checkAccountAddress",
  "args": ["0xddcf208f219a6e6af072f2cfdc615b2c1805f98e"]
}

checkAccountType

{
  "criterion": "checkAccountType",
  "args": ["eoa"]
}

checkAccountGroup

{
  "criterion": "checkAccountGroup",
  "args": ["engineering-dev-wallet"]
}

checkAccountAssigned

{
  "criterion": "checkAccountAssigned",
  "args": null
}

checkSourceId

{
  "criterion": "checkSourceId",
  "args": ["eip155:137:0xddcf208f219a6e6af072f2cfdc615b2c1805f98e"] // CAIP-10
}

checkSourceAddress

{
  "criterion": "checkSourceAddress",
  "args": ["0xddcf208f219a6e6af072f2cfdc615b2c1805f98e"]
}

checkSourceAccountType

{
  "criterion": "checkSourceAccountType",
  "args": ["eoa"]
}

checkSourceClassification

{
  "criterion": "checkSourceClassification",
  "args": ["internal"]
}

checkDestinationId

{
  "criterion": "checkDestinationId",
  "args": ["eip155:137:0xddcf208f219a6e6af072f2cfdc615b2c1805f98e"] // CAIP-10
}

checkDestinationAddress

{
  "criterion": "checkDestinationAddress",
  "args": ["0xddcf208f219a6e6af072f2cfdc615b2c1805f98e"]
}

checkDestinationAccountType

{
  "criterion": "checkDestinationAccountType",
  "args": ["eoa"]
}

checkDestinationClassification

{
  "criterion": "checkDestinationClassification",
  "args": ["external"]
}

checkIntentType

{
  "criterion": "checkIntentType",
  "args": ["transferNative"]
}

checkIntentChainId

{
  "criterion": "checkIntentChainId",
  "args": ["137"] 
}

checkIntentAmount

Intent amount by currency is not supported yet.

{
  "criterion": "checkIntentAmount",
  "args": {
    "currency": "fiat:usd",
    "operator": "lte",
    "value": "1000000000000000000" // Wei
  }
}

checkIntentContract

{
  "criterion": "checkIntentContract",
  "args": ["eip155:137:0xddcf208f219a6e6af072f2cfdc615b2c1805f98e"] // CAIP-10
}

checkIntentSpender

{
  "criterion": "checkIntentSpender",
  "args": ["eip155:137:0xddcf208f219a6e6af072f2cfdc615b2c1805f98e"] // CAIP-10
}

checkIntentToken

{
  "criterion": "checkIntentToken",
  "args": ["eip155:137:0xddcf208f219a6e6af072f2cfdc615b2c1805f98e"] // CAIP-10
}

checkIntentHexSignature

{
  "criterion": "checkIntentHexSignature",
  "args": ["0xe8e33700"]
}

checkIntentMessage

{
  "criterion": "checkIntentMessage",
  "args": {
    "operator": "contains"
    "value": "Welcome to Opensea!"
  }
}

checkIntentPayload

{
  "criterion": "checkIntentPayload",
  "args": []
}

checkIntentAlgorithm

{
  "criterion": "checkIntentAlgorithm",
  "args": ["ES256K"]
}

checkIntentDomain

{
  "criterion": "checkIntentDomain",
  "args": {
    "version": [], // optional
    "chainId": [], // optional
    "name": [], // optional
    "verifyingContract": [] // optional
  }
}

checkErc1155TokenId

{
  "criterion": "checkErc1155TokenId",
  "args": ["eip155:137/erc1155:0x08a08d0504d4f3363a5b7fda1f5fff1c7bca8ad4/12345"]
}

checkErc1155Transfers

{
  "criterion": "checkErc1155Transfers",
  "args": [{
     "tokenId": "eip155:137/erc1155:0x08a08d0504d4f3363a5b7fda1f5fff1c7bca8ad4/12345", 
     "operator": "lte", 
     "value": "2"
  }]
}

checkPermitDeadline

{
  "criterion": "checkPermitDeadline",
  "args": {
    "operator": "lte",
    "value": ""
  }
}

checkGasFeeAmount

Gas fee by currency is not supported yet.

{
  "criterion": "checkGasFeeAmount",
  "args": {
    "currency": "fiat:usd",
    "operator": "lte",
    "value": "1000000000000000000" // Wei
  }
}

checkNonceExists

{
  "criterion": "checkNonceExists",
  "args": null
}

checkNonceNotExists

{
  "criterion": "checkNonceNotExists",
  "args": null
}

checkApprovals

// Require approvals of 3 admins and count the principal signature (if he is an admin)

{
  "criterion": "checkApprovals",
  "args": [
    {
      "approvalCount": 3,
      "countPrincipal": true,
      "approvalEntityType": "Narval::UserRole"
      "entityIds": ["admin"]
    }
  ]
}

checkSpendingLimit

Only Native Transfers and ERC20 Transfers are supported. So this criterion can only be combined with checkIntentType({"transferNative"}) OR checkIntentType({"transferErc20"})

Spending limit by currency is not supported yet.

{
  "criterion": "checkSpendingLimit",
  "args": {
    "limit": "1000000000000000000", // Wei
    "operator": "lte",
    "currency": "fiat:usd",
    "timeWindow": {
      "type": "fixed", // "rolling", "fixed"
      "period": "1d", // "1d", "1m", "1y"
      "value": 86400, // in seconds
      "startDate": 1702418817 // timestamp in ms
      "endDate": 1722418817 // timestamp in ms
    },
    "filters": {
      "perPrincipal": true,
      "tokens": [],
      "users": [],
      "resources": [],
      "destinations": [],
      "chains": [],
      "userGroups": [],
      "accountGroups": []
    }
  }
}

Each timeWindow property is optional.

fixed time windows take a period, and rolling time windows take a value

Each filters property is optional

checkRateLimit

Only Native Transfers and Erc20 Transfers are supported. So this criterion can only be combined with checkIntentType({"transferNative"}) OR checkIntentType({"transferERC20"})

{
  "criterion": "checkRateLimit",
  "args": {
    "limit": "1000000000000000000", // Wei
    "timeWindow": {
      "type": "fixed", // "rolling", "fixed"
      "period": "1d", // "1d", "1m", "1y"
      "startDate": 1702418817 // timestamp in ms
      "endDate": 1722418817 // timestamp in ms
    },
    "filters": {
      "perPrincipal": true,
      "tokens": [],
      "users": [],
      "resources": [],
      "destinations": [],
      "chains": [],
      "userGroups": [],
      "accountGroups": []
    }
  }
}

{
  "criterion": "checkRateLimit",
  "args": {
    "limit": "1000000000000000000", // Wei
    "timeWindow": {
      "type": "rolling", // "rolling", "fixed"
      "value": 86400 // In seconds
      "startDate": 1702418817 // timestamp in ms
      "endDate": 1722418817 // timestamp in ms
    },
    "filters": {
      "perPrincipal": true,
      "tokens": [],
      "users": [],
      "resources": [],
      "destinations": [],
      "chains": [],
      "userGroups": [],
      "accountGroups": []
    }
  }
}

User Operation

checkEntryPointId

{
  "criterion": "checkEntryPointId",
  "args": ["eip155:137:0xddcf208f219a6e6af072f2cfdc615b2c1805f98e"] // CAIP-10
}

checkEntryPointAddress

{
  "criterion": "checkEntryPointAddress",
  "args": ["0xddcf208f219a6e6af072f2cfdc615b2c1805f98e"]
}

checkEntryPointAccountType

{
  "criterion": "checkEntryPointAccountType",
  "args": ["eoa"]
}

checkEntryPointClassification

{
  "criterion": "checkEntryPointClassification",
  "args": ["internal"]
}

checkUserOperationIntents

{
  "criterion": "checkUserOperationIntents",
  "args": []
}

PreviousRecipes NextEntities

Last updated 29 days ago