@meantjs/profile 0.2.0 → 0.3.0

package/data/packs/permit2.profile.json

@@ -0,0 +1,436 @@
+{
+  "format": "candid-profile",
+  "format_version": 0,
+  "kind": "contract",
+  "name": "permit2",
+  "origin": "third_party",
+  "language": "en",
+  "description": "Uniswap's Permit2 (spec section 15.9, experimental): its AllowanceTransfer messages (PermitSingle, PermitBatch), which set allowances, and its SignatureTransfer messages (PermitTransferFrom, PermitBatchTransferFrom), which authorize one transfer. Witness messages (PermitWitnessTransferFrom) are left out: each protocol adds its own witness type (O1). Bound to the deployments ERC-7730's own Permit2 example lists, so a look-alike contract named \"Permit2\" gets none of these words. Amounts are in the token the message names: a consumer supplies that token's decimals() and symbol(), and shows its address beside the symbol.",
+  "binds": {
+    "eip712": {
+      "domain": {
+        "name": "Permit2"
+      },
+      "types": {
+        "PermitBatch": [
+          {
+            "name": "details",
+            "type": "PermitDetails[]"
+          },
+          {
+            "name": "spender",
+            "type": "address"
+          },
+          {
+            "name": "sigDeadline",
+            "type": "uint256"
+          }
+        ],
+        "PermitBatchTransferFrom": [
+          {
+            "name": "permitted",
+            "type": "TokenPermissions[]"
+          },
+          {
+            "name": "spender",
+            "type": "address"
+          },
+          {
+            "name": "nonce",
+            "type": "uint256"
+          },
+          {
+            "name": "deadline",
+            "type": "uint256"
+          }
+        ],
+        "PermitDetails": [
+          {
+            "name": "token",
+            "type": "address"
+          },
+          {
+            "name": "amount",
+            "type": "uint160"
+          },
+          {
+            "name": "expiration",
+            "type": "uint48"
+          },
+          {
+            "name": "nonce",
+            "type": "uint48"
+          }
+        ],
+        "PermitSingle": [
+          {
+            "name": "details",
+            "type": "PermitDetails"
+          },
+          {
+            "name": "spender",
+            "type": "address"
+          },
+          {
+            "name": "sigDeadline",
+            "type": "uint256"
+          }
+        ],
+        "PermitTransferFrom": [
+          {
+            "name": "permitted",
+            "type": "TokenPermissions"
+          },
+          {
+            "name": "spender",
+            "type": "address"
+          },
+          {
+            "name": "nonce",
+            "type": "uint256"
+          },
+          {
+            "name": "deadline",
+            "type": "uint256"
+          }
+        ],
+        "TokenPermissions": [
+          {
+            "name": "token",
+            "type": "address"
+          },
+          {
+            "name": "amount",
+            "type": "uint256"
+          }
+        ]
+      }
+    },
+    "deployments": [
+      {
+        "chain_id": 1,
+        "address": "0x000000000022D473030F116dDEE9F6B43aC78BA3"
+      },
+      {
+        "chain_id": 42161,
+        "address": "0x000000000022D473030F116dDEE9F6B43aC78BA3"
+      }
+    ]
+  },
+  "annotations": [
+    {
+      "at": "PermitSingle",
+      "tag": "intent",
+      "args": {
+        "title": "Permit2: allow token spending",
+        "template": "Let {spender} spend up to {details.amount}. Allowance expires: {details.expiration}. Signature expires: {sigDeadline}."
+      }
+    },
+    {
+      "at": "PermitSingle",
+      "tag": "effect",
+      "args": {
+        "kind": "approve",
+        "irreversible": false
+      }
+    },
+    {
+      "at": "PermitSingle(0).details.token",
+      "tag": "describe",
+      "args": {
+        "label": "Token"
+      }
+    },
+    {
+      "at": "PermitSingle(0).details.amount",
+      "tag": "amount",
+      "args": {
+        "token": "details.token",
+        "threshold": "1461501637330902918203684832716283019655932542975"
+      }
+    },
+    {
+      "at": "PermitSingle(0).details.amount",
+      "tag": "describe",
+      "args": {
+        "label": "Amount"
+      }
+    },
+    {
+      "at": "PermitSingle(0).details.expiration",
+      "tag": "timestamp",
+      "args": {
+        "unit": "s",
+        "epoch": "unix",
+        "threshold": "281474976710655",
+        "message": "Never",
+        "labels": {
+          "0": "Only in the block it is used"
+        }
+      }
+    },
+    {
+      "at": "PermitSingle(0).details.expiration",
+      "tag": "describe",
+      "args": {
+        "label": "Allowance expires"
+      }
+    },
+    {
+      "at": "PermitSingle(0).details.nonce",
+      "tag": "describe",
+      "args": {
+        "label": "Nonce"
+      }
+    },
+    {
+      "at": "PermitSingle(0).spender",
+      "tag": "describe",
+      "args": {
+        "label": "Spender"
+      }
+    },
+    {
+      "at": "PermitSingle(0).sigDeadline",
+      "tag": "timestamp",
+      "args": {
+        "unit": "s",
+        "epoch": "unix",
+        "threshold": "115792089237316195423570985008687907853269984665640564039457584007913129639935",
+        "message": "Never"
+      }
+    },
+    {
+      "at": "PermitSingle(0).sigDeadline",
+      "tag": "describe",
+      "args": {
+        "label": "Signature expires"
+      }
+    },
+    {
+      "at": "PermitBatch",
+      "tag": "intent",
+      "args": {
+        "title": "Permit2: allow spending of several tokens",
+        "template": "Let {spender} spend up to {details[].amount}. Allowances expire, in the same order: {details[].expiration}. Signature expires: {sigDeadline}."
+      }
+    },
+    {
+      "at": "PermitBatch",
+      "tag": "effect",
+      "args": {
+        "kind": "approve",
+        "irreversible": false
+      }
+    },
+    {
+      "at": "PermitBatch(0).details[].token",
+      "tag": "describe",
+      "args": {
+        "label": "Token"
+      }
+    },
+    {
+      "at": "PermitBatch(0).details[].amount",
+      "tag": "amount",
+      "args": {
+        "token": "details[].token",
+        "threshold": "1461501637330902918203684832716283019655932542975"
+      }
+    },
+    {
+      "at": "PermitBatch(0).details[].amount",
+      "tag": "describe",
+      "args": {
+        "label": "Amount"
+      }
+    },
+    {
+      "at": "PermitBatch(0).details[].expiration",
+      "tag": "timestamp",
+      "args": {
+        "unit": "s",
+        "epoch": "unix",
+        "threshold": "281474976710655",
+        "message": "Never",
+        "labels": {
+          "0": "Only in the block it is used"
+        }
+      }
+    },
+    {
+      "at": "PermitBatch(0).details[].expiration",
+      "tag": "describe",
+      "args": {
+        "label": "Allowance expires"
+      }
+    },
+    {
+      "at": "PermitBatch(0).details[].nonce",
+      "tag": "describe",
+      "args": {
+        "label": "Nonce"
+      }
+    },
+    {
+      "at": "PermitBatch(0).spender",
+      "tag": "describe",
+      "args": {
+        "label": "Spender"
+      }
+    },
+    {
+      "at": "PermitBatch(0).sigDeadline",
+      "tag": "timestamp",
+      "args": {
+        "unit": "s",
+        "epoch": "unix",
+        "threshold": "115792089237316195423570985008687907853269984665640564039457584007913129639935",
+        "message": "Never"
+      }
+    },
+    {
+      "at": "PermitBatch(0).sigDeadline",
+      "tag": "describe",
+      "args": {
+        "label": "Signature expires"
+      }
+    },
+    {
+      "at": "PermitTransferFrom",
+      "tag": "intent",
+      "args": {
+        "title": "Permit2: allow one transfer",
+        "template": "Let {spender} transfer up to {permitted.amount} from you, once. Signature expires: {deadline}."
+      }
+    },
+    {
+      "at": "PermitTransferFrom",
+      "tag": "effect",
+      "args": {
+        "kind": "transfer",
+        "irreversible": true
+      }
+    },
+    {
+      "at": "PermitTransferFrom(0).permitted.token",
+      "tag": "describe",
+      "args": {
+        "label": "Token"
+      }
+    },
+    {
+      "at": "PermitTransferFrom(0).permitted.amount",
+      "tag": "amount",
+      "args": {
+        "token": "permitted.token"
+      }
+    },
+    {
+      "at": "PermitTransferFrom(0).permitted.amount",
+      "tag": "describe",
+      "args": {
+        "label": "Up to"
+      }
+    },
+    {
+      "at": "PermitTransferFrom(0).spender",
+      "tag": "describe",
+      "args": {
+        "label": "Spender"
+      }
+    },
+    {
+      "at": "PermitTransferFrom(0).nonce",
+      "tag": "describe",
+      "args": {
+        "label": "Nonce"
+      }
+    },
+    {
+      "at": "PermitTransferFrom(0).deadline",
+      "tag": "timestamp",
+      "args": {
+        "unit": "s",
+        "epoch": "unix",
+        "threshold": "115792089237316195423570985008687907853269984665640564039457584007913129639935",
+        "message": "Never"
+      }
+    },
+    {
+      "at": "PermitTransferFrom(0).deadline",
+      "tag": "describe",
+      "args": {
+        "label": "Signature expires"
+      }
+    },
+    {
+      "at": "PermitBatchTransferFrom",
+      "tag": "intent",
+      "args": {
+        "title": "Permit2: allow one transfer of several tokens",
+        "template": "Let {spender} transfer up to {permitted[].amount} from you, once. Signature expires: {deadline}."
+      }
+    },
+    {
+      "at": "PermitBatchTransferFrom",
+      "tag": "effect",
+      "args": {
+        "kind": "transfer",
+        "irreversible": true
+      }
+    },
+    {
+      "at": "PermitBatchTransferFrom(0).permitted[].token",
+      "tag": "describe",
+      "args": {
+        "label": "Token"
+      }
+    },
+    {
+      "at": "PermitBatchTransferFrom(0).permitted[].amount",
+      "tag": "amount",
+      "args": {
+        "token": "permitted[].token"
+      }
+    },
+    {
+      "at": "PermitBatchTransferFrom(0).permitted[].amount",
+      "tag": "describe",
+      "args": {
+        "label": "Up to"
+      }
+    },
+    {
+      "at": "PermitBatchTransferFrom(0).spender",
+      "tag": "describe",
+      "args": {
+        "label": "Spender"
+      }
+    },
+    {
+      "at": "PermitBatchTransferFrom(0).nonce",
+      "tag": "describe",
+      "args": {
+        "label": "Nonce"
+      }
+    },
+    {
+      "at": "PermitBatchTransferFrom(0).deadline",
+      "tag": "timestamp",
+      "args": {
+        "unit": "s",
+        "epoch": "unix",
+        "threshold": "115792089237316195423570985008687907853269984665640564039457584007913129639935",
+        "message": "Never"
+      }
+    },
+    {
+      "at": "PermitBatchTransferFrom(0).deadline",
+      "tag": "describe",
+      "args": {
+        "label": "Signature expires"
+      }
+    }
+  ]
+}

package/data/profile-v0.schema.json

@@ -150,6 +150,10 @@
         "abi": {
           "$ref": "#/$defs/evm_abi",
           "description": "An EVM pack (spec section 15, experimental): the functions it applies to. The pack applies to a contract that has each of them, with the same selector, outputs and kind of call."
+        },
+        "eip712": {
+          "$ref": "#/$defs/eip712",
+          "description": "An EVM pack's EIP-712 messages (spec section 15.9), beside its binds.abi."
         }
       },
       "oneOf": [
@@ -169,7 +173,12 @@
             "abi": true
           }
         }
-      ]
+      ],
+      "dependentRequired": {
+        "eip712": [
+          "abi"
+        ]
+      }
     },
     "canister_binds": {
       "type": "object",
@@ -194,10 +203,7 @@
     },
     "contract_binds": {
       "type": "object",
-      "description": "An EVM contract (spec section 15, experimental): its ABI, and where it is deployed.",
-      "required": [
-        "abi"
-      ],
+      "description": "An EVM contract (spec section 15, experimental): its ABI, the EIP-712 messages it verifies (section 15.9), and where it is deployed.",
       "additionalProperties": false,
       "properties": {
         "abi": {
@@ -225,8 +231,29 @@
               }
             }
           }
+        },
+        "eip712": {
+          "$ref": "#/$defs/eip712"
         }
-      }
+      },
+      "anyOf": [
+        {
+          "required": [
+            "abi"
+          ],
+          "properties": {
+            "abi": true
+          }
+        },
+        {
+          "required": [
+            "eip712"
+          ],
+          "properties": {
+            "eip712": true
+          }
+        }
+      ]
     },
     "evm_abi": {
       "type": "array",
@@ -259,6 +286,61 @@
         ]
       }
     },
+    "eip712": {
+      "type": "object",
+      "description": "EIP-712 typed messages (spec section 15.9, experimental): the struct types, in the JSON shape of an eth_signTypedData request without EIP712Domain, and the domain's name and version. A type whose name the profile tags with intent is a message; chainId and verifyingContract come from binds.deployments.",
+      "required": [
+        "types"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "domain": {
+          "type": "object",
+          "minProperties": 1,
+          "additionalProperties": false,
+          "description": "Each value must equal the request's domain value of the same name (ERC-7730 context.eip712.domain).",
+          "properties": {
+            "name": {
+              "type": "string",
+              "minLength": 1
+            },
+            "version": {
+              "type": "string",
+              "minLength": 1
+            }
+          }
+        },
+        "types": {
+          "type": "object",
+          "minProperties": 1,
+          "propertyNames": {
+            "pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
+          },
+          "additionalProperties": {
+            "type": "array",
+            "minItems": 1,
+            "items": {
+              "type": "object",
+              "required": [
+                "name",
+                "type"
+              ],
+              "additionalProperties": false,
+              "properties": {
+                "name": {
+                  "type": "string",
+                  "pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
+                },
+                "type": {
+                  "type": "string",
+                  "pattern": "^[A-Za-z_][A-Za-z0-9_]*(\\[([1-9][0-9]*)?\\])*$"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "value_address": {
       "type": "string",
       "description": "METHOD(i)path | METHOD->(i)path | type:DECL path. Paths: .label, .#id, [] (vec element). opt is transparent.",
@@ -746,9 +828,6 @@
     },
     "args_amount": {
       "type": "object",
-      "required": [
-        "decimals"
-      ],
       "additionalProperties": false,
       "properties": {
         "decimals": {
@@ -775,6 +854,10 @@
             }
           ]
         },
+        "token": {
+          "$ref": "#/$defs/relpath",
+          "description": "An EVM amount in a token another field names (spec section 15.9): the relative path to that address, in the same array element as the amount. Its decimals and symbol are the token's, which the consumer supplies; decimals and symbol are then left out."
+        },
         "threshold": {
           "type": "string",
           "pattern": "^(0|[1-9][0-9]{0,77})$",
@@ -791,6 +874,32 @@
         "message": [
           "threshold"
         ]
+      },
+      "anyOf": [
+        {
+          "required": [
+            "decimals"
+          ],
+          "properties": {
+            "decimals": true
+          }
+        },
+        {
+          "required": [
+            "token"
+          ],
+          "properties": {
+            "token": true
+          }
+        }
+      ],
+      "dependentSchemas": {
+        "token": {
+          "properties": {
+            "decimals": false,
+            "symbol": false
+          }
+        }
       }
     },
     "args_timestamp": {
@@ -805,7 +914,40 @@
         },
         "epoch": {
           "const": "unix"
+        },
+        "threshold": {
+          "type": "string",
+          "pattern": "^(0|[1-9][0-9]{0,77})$",
+          "description": "Display only: a value at or above this (in the tagged unit, a decimal string) displays as `message`, for example \"Never\" for a deadline of uint256 max (spec section 15.9)."
+        },
+        "message": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 32,
+          "description": "What a value at or above `threshold` displays as."
+        },
+        "labels": {
+          "type": "object",
+          "minProperties": 1,
+          "maxProperties": 16,
+          "propertyNames": {
+            "pattern": "^(0|[1-9][0-9]{0,77})$"
+          },
+          "additionalProperties": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 32
+          },
+          "description": "Display only: words for exact values (in the tagged unit), for example { \"0\": \"Only in the block it is used\" } (spec section 15.9)."
         }
+      },
+      "dependentRequired": {
+        "message": [
+          "threshold"
+        ],
+        "threshold": [
+          "message"
+        ]
       }
     },
     "args_duration": {