@flarenetwork/flare-periphery-contract-artifacts 0.1.4 → 0.1.5

package/coston/StateConnector/configs/TypeTemplate.json

@@ -1,555 +0,0 @@
-{
-  "name": "TypeTemplate",
-  "fullComment": " @custom:name TypeTemplate\n @custom:id 0x00\n @custom:supported BTC\n @author <author of the type>\n @notice <description of the type>\n @custom:verification <general verification rules>\n @custom:lut <lowestUsedTimestamp>",
-  "description": "<description of the type>",
-  "supported": [
-    "BTC"
-  ],
-  "verification": "<general verification rules>\n ",
-  "lut": "<lowestUsedTimestamp>",
-  "proof": {
-    "name": "Proof",
-    "description": "Toplevel proof",
-    "above": "",
-    "below": "",
-    "fullComment": " @notice Toplevel proof\n @param merkleProof Merkle proof corresponding to the attestation response.\n @param data Attestation response.",
-    "params": [
-      {
-        "name": "merkleProof",
-        "type": "bytes32[]",
-        "typeSimple": "bytes32[]",
-        "comment": "Merkle proof corresponding to the attestation response."
-      },
-      {
-        "name": "data",
-        "type": "struct TypeTemplate.Response",
-        "typeSimple": "Response",
-        "comment": "Attestation response."
-      }
-    ]
-  },
-  "request": {
-    "name": "Request",
-    "description": "Toplevel request",
-    "above": "",
-    "below": "",
-    "fullComment": " @notice Toplevel request\n @param attestationType ID of the attestation type.\n @param sourceId ID of the data source.\n @param messageIntegrityCode `MessageIntegrityCode` that is derived from the expected response.\n @param requestBody Data defining the request. Type (struct) and interpretation is determined by the `attestationType`.",
-    "params": [
-      {
-        "name": "attestationType",
-        "type": "bytes32",
-        "typeSimple": "bytes32",
-        "comment": "ID of the attestation type."
-      },
-      {
-        "name": "sourceId",
-        "type": "bytes32",
-        "typeSimple": "bytes32",
-        "comment": "ID of the data source."
-      },
-      {
-        "name": "messageIntegrityCode",
-        "type": "bytes32",
-        "typeSimple": "bytes32",
-        "comment": "`MessageIntegrityCode` that is derived from the expected response."
-      },
-      {
-        "name": "requestBody",
-        "type": "struct TypeTemplate.RequestBody",
-        "typeSimple": "RequestBody",
-        "comment": "Data defining the request. Type (struct) and interpretation is determined by the `attestationType`."
-      }
-    ]
-  },
-  "response": {
-    "name": "Response",
-    "description": "Toplevel response",
-    "above": "",
-    "below": "",
-    "fullComment": " @notice Toplevel response\n @param attestationType Extracted from the request.\n @param sourceId Extracted from the request.\n @param votingRound The ID of the State Connector round in which the request was considered.\n @param lowestUsedTimestamp The lowest timestamp used to generate the response.\n @param requestBody Extracted from the request.\n @param responseBody Data defining the response. The verification rules for the construction of the response body and the type are defined per specific `attestationType`.",
-    "params": [
-      {
-        "name": "attestationType",
-        "type": "bytes32",
-        "typeSimple": "bytes32",
-        "comment": "Extracted from the request."
-      },
-      {
-        "name": "sourceId",
-        "type": "bytes32",
-        "typeSimple": "bytes32",
-        "comment": "Extracted from the request."
-      },
-      {
-        "name": "votingRound",
-        "type": "uint64",
-        "typeSimple": "uint64",
-        "comment": "The ID of the State Connector round in which the request was considered."
-      },
-      {
-        "name": "lowestUsedTimestamp",
-        "type": "uint64",
-        "typeSimple": "uint64",
-        "comment": "The lowest timestamp used to generate the response."
-      },
-      {
-        "name": "requestBody",
-        "type": "struct TypeTemplate.RequestBody",
-        "typeSimple": "RequestBody",
-        "comment": "Extracted from the request."
-      },
-      {
-        "name": "responseBody",
-        "type": "struct TypeTemplate.ResponseBody",
-        "typeSimple": "ResponseBody",
-        "comment": "Data defining the response. The verification rules for the construction of the response body and the type are defined per specific `attestationType`."
-      }
-    ]
-  },
-  "requestBody": {
-    "name": "RequestBody",
-    "description": "Request body for TypeTemplate attestation type",
-    "above": "Additional explanation for 'above' slot in generated Markdown docs",
-    "below": "Additional explanation for 'below' slot in generated Markdown docs",
-    "fullComment": " @notice Request body for TypeTemplate attestation type\n @custom:above Additional explanation for 'above' slot in generated Markdown docs\n @custom:below Additional explanation for 'below' slot in generated Markdown docs\n @param bytes32Field example bytes32 field with explanation\n @param boolField example bool field field with explanation\n @param requestSubstruct1 example RequestSubstruct1 field with explanation\n @param requestSubstruct2Array example RequestSubstruct2 array field with explanation*",
-    "params": [
-      {
-        "name": "bytes32Field",
-        "type": "bytes32",
-        "typeSimple": "bytes32",
-        "comment": "example bytes32 field with explanation"
-      },
-      {
-        "name": "boolField",
-        "type": "bool",
-        "typeSimple": "bool",
-        "comment": "example bool field field with explanation"
-      },
-      {
-        "name": "requestSubstruct1",
-        "type": "struct TypeTemplate.RequestSubstruct1",
-        "typeSimple": "RequestSubstruct1",
-        "comment": "example RequestSubstruct1 field with explanation"
-      },
-      {
-        "name": "requestSubstruct2Array",
-        "type": "struct TypeTemplate.RequestSubstruct2[]",
-        "typeSimple": "RequestSubstruct2[]",
-        "comment": "example RequestSubstruct2 array field with explanation*"
-      }
-    ]
-  },
-  "responseBody": {
-    "name": "ResponseBody",
-    "description": "Response body for TypeTemplate attestation type.",
-    "above": "Additional explanation for 'above' slot in generated Markdown docs",
-    "below": "Additional explanation for 'below' slot in generated Markdown docs",
-    "fullComment": " @notice Response body for TypeTemplate attestation type.\n @custom:above Additional explanation for 'above' slot in generated Markdown docs\n @custom:below Additional explanation for 'below' slot in generated Markdown docs\n @param templateResponseField example bytes32 field with explanation\n @param responseSubstruct1Array example ResponseSubstruct1 array field with explanation*",
-    "params": [
-      {
-        "name": "templateResponseField",
-        "type": "bytes32",
-        "typeSimple": "bytes32",
-        "comment": "example bytes32 field with explanation"
-      },
-      {
-        "name": "responseSubstruct1Array",
-        "type": "struct TypeTemplate.ResponseSubstruct1[]",
-        "typeSimple": "ResponseSubstruct1[]",
-        "comment": "example ResponseSubstruct1 array field with explanation*"
-      }
-    ]
-  },
-  "requestStructs": [
-    {
-      "name": "RequestSubstruct1",
-      "description": "Additional struct first used in Request body fields",
-      "above": "Additional explanation for 'above' slot in generated Markdown docs",
-      "below": "Additional explanation for 'below' slot in generated Markdown docs",
-      "fullComment": " @notice Additional struct first used in Request body fields\n @custom:above Additional explanation for 'above' slot in generated Markdown docs\n @custom:below Additional explanation for 'below' slot in generated Markdown docs\n @param templateStructField example bytes32 field with explanation\n @param uintArrayField example uint256 array field with explanation\n @param boolArrayField example bool array field with explanation*",
-      "params": [
-        {
-          "name": "templateStructField",
-          "type": "bytes32",
-          "typeSimple": "bytes32",
-          "comment": "example bytes32 field with explanation"
-        },
-        {
-          "name": "uintArrayField",
-          "type": "uint256[]",
-          "typeSimple": "uint256[]",
-          "comment": "example uint256 array field with explanation"
-        },
-        {
-          "name": "boolArrayField",
-          "type": "bool[]",
-          "typeSimple": "bool[]",
-          "comment": "example bool array field with explanation*"
-        }
-      ]
-    },
-    {
-      "name": "RequestSubstruct2",
-      "description": "Additional struct first used in Request body fields",
-      "above": "Additional explanation for 'above' slot in generated Markdown docs",
-      "below": "Additional explanation for 'below' slot in generated Markdown docs",
-      "fullComment": " @notice Additional struct first used in Request body fields\n @custom:above Additional explanation for 'above' slot in generated Markdown docs\n @custom:below Additional explanation for 'below' slot in generated Markdown docs\n @param templateStructField example bytes32 field with explanation\n @param intArrayField example int256 array field with explanation\n @param boolArrayField example bool array field with explanation*",
-      "params": [
-        {
-          "name": "templateStructField",
-          "type": "bytes32",
-          "typeSimple": "bytes32",
-          "comment": "example bytes32 field with explanation"
-        },
-        {
-          "name": "intArrayField",
-          "type": "int256[]",
-          "typeSimple": "int256[]",
-          "comment": "example int256 array field with explanation"
-        },
-        {
-          "name": "boolArrayField",
-          "type": "bool[]",
-          "typeSimple": "bool[]",
-          "comment": "example bool array field with explanation*"
-        }
-      ]
-    }
-  ],
-  "responseStructs": [
-    {
-      "name": "ResponseSubstruct1",
-      "description": "Additional struct first used in Response body fields",
-      "above": "Additional explanation for 'above' slot in generated Markdown docs",
-      "below": "Additional explanation for 'below' slot in generated Markdown docs",
-      "fullComment": " @notice Additional struct first used in Response body fields\n @custom:above Additional explanation for 'above' slot in generated Markdown docs\n @custom:below Additional explanation for 'below' slot in generated Markdown docs\n @param templateStructField description*",
-      "params": [
-        {
-          "name": "templateStructField",
-          "type": "bytes32",
-          "typeSimple": "bytes32",
-          "comment": "description*"
-        }
-      ]
-    }
-  ],
-  "requestAbi": {
-    "components": [
-      {
-        "internalType": "bytes32",
-        "name": "attestationType",
-        "type": "bytes32"
-      },
-      {
-        "internalType": "bytes32",
-        "name": "sourceId",
-        "type": "bytes32"
-      },
-      {
-        "internalType": "bytes32",
-        "name": "messageIntegrityCode",
-        "type": "bytes32"
-      },
-      {
-        "components": [
-          {
-            "internalType": "bytes32",
-            "name": "bytes32Field",
-            "type": "bytes32"
-          },
-          {
-            "internalType": "bool",
-            "name": "boolField",
-            "type": "bool"
-          },
-          {
-            "components": [
-              {
-                "internalType": "bytes32",
-                "name": "templateStructField",
-                "type": "bytes32"
-              },
-              {
-                "internalType": "uint256[]",
-                "name": "uintArrayField",
-                "type": "uint256[]"
-              },
-              {
-                "internalType": "bool[]",
-                "name": "boolArrayField",
-                "type": "bool[]"
-              }
-            ],
-            "internalType": "struct TypeTemplate.RequestSubstruct1",
-            "name": "requestSubstruct1",
-            "type": "tuple"
-          },
-          {
-            "components": [
-              {
-                "internalType": "bytes32",
-                "name": "templateStructField",
-                "type": "bytes32"
-              },
-              {
-                "internalType": "int256[]",
-                "name": "intArrayField",
-                "type": "int256[]"
-              },
-              {
-                "internalType": "bool[]",
-                "name": "boolArrayField",
-                "type": "bool[]"
-              }
-            ],
-            "internalType": "struct TypeTemplate.RequestSubstruct2[]",
-            "name": "requestSubstruct2Array",
-            "type": "tuple[]"
-          }
-        ],
-        "internalType": "struct TypeTemplate.RequestBody",
-        "name": "requestBody",
-        "type": "tuple"
-      }
-    ],
-    "internalType": "struct TypeTemplate.Request",
-    "name": "_request",
-    "type": "tuple"
-  },
-  "responseAbi": {
-    "components": [
-      {
-        "internalType": "bytes32",
-        "name": "attestationType",
-        "type": "bytes32"
-      },
-      {
-        "internalType": "bytes32",
-        "name": "sourceId",
-        "type": "bytes32"
-      },
-      {
-        "internalType": "uint64",
-        "name": "votingRound",
-        "type": "uint64"
-      },
-      {
-        "internalType": "uint64",
-        "name": "lowestUsedTimestamp",
-        "type": "uint64"
-      },
-      {
-        "components": [
-          {
-            "internalType": "bytes32",
-            "name": "bytes32Field",
-            "type": "bytes32"
-          },
-          {
-            "internalType": "bool",
-            "name": "boolField",
-            "type": "bool"
-          },
-          {
-            "components": [
-              {
-                "internalType": "bytes32",
-                "name": "templateStructField",
-                "type": "bytes32"
-              },
-              {
-                "internalType": "uint256[]",
-                "name": "uintArrayField",
-                "type": "uint256[]"
-              },
-              {
-                "internalType": "bool[]",
-                "name": "boolArrayField",
-                "type": "bool[]"
-              }
-            ],
-            "internalType": "struct TypeTemplate.RequestSubstruct1",
-            "name": "requestSubstruct1",
-            "type": "tuple"
-          },
-          {
-            "components": [
-              {
-                "internalType": "bytes32",
-                "name": "templateStructField",
-                "type": "bytes32"
-              },
-              {
-                "internalType": "int256[]",
-                "name": "intArrayField",
-                "type": "int256[]"
-              },
-              {
-                "internalType": "bool[]",
-                "name": "boolArrayField",
-                "type": "bool[]"
-              }
-            ],
-            "internalType": "struct TypeTemplate.RequestSubstruct2[]",
-            "name": "requestSubstruct2Array",
-            "type": "tuple[]"
-          }
-        ],
-        "internalType": "struct TypeTemplate.RequestBody",
-        "name": "requestBody",
-        "type": "tuple"
-      },
-      {
-        "components": [
-          {
-            "internalType": "bytes32",
-            "name": "templateResponseField",
-            "type": "bytes32"
-          },
-          {
-            "components": [
-              {
-                "internalType": "bytes32",
-                "name": "templateStructField",
-                "type": "bytes32"
-              }
-            ],
-            "internalType": "struct TypeTemplate.ResponseSubstruct1[]",
-            "name": "responseSubstruct1Array",
-            "type": "tuple[]"
-          }
-        ],
-        "internalType": "struct TypeTemplate.ResponseBody",
-        "name": "responseBody",
-        "type": "tuple"
-      }
-    ],
-    "internalType": "struct TypeTemplate.Response",
-    "name": "_response",
-    "type": "tuple"
-  },
-  "proofAbi": {
-    "components": [
-      {
-        "internalType": "bytes32[]",
-        "name": "merkleProof",
-        "type": "bytes32[]"
-      },
-      {
-        "components": [
-          {
-            "internalType": "bytes32",
-            "name": "attestationType",
-            "type": "bytes32"
-          },
-          {
-            "internalType": "bytes32",
-            "name": "sourceId",
-            "type": "bytes32"
-          },
-          {
-            "internalType": "uint64",
-            "name": "votingRound",
-            "type": "uint64"
-          },
-          {
-            "internalType": "uint64",
-            "name": "lowestUsedTimestamp",
-            "type": "uint64"
-          },
-          {
-            "components": [
-              {
-                "internalType": "bytes32",
-                "name": "bytes32Field",
-                "type": "bytes32"
-              },
-              {
-                "internalType": "bool",
-                "name": "boolField",
-                "type": "bool"
-              },
-              {
-                "components": [
-                  {
-                    "internalType": "bytes32",
-                    "name": "templateStructField",
-                    "type": "bytes32"
-                  },
-                  {
-                    "internalType": "uint256[]",
-                    "name": "uintArrayField",
-                    "type": "uint256[]"
-                  },
-                  {
-                    "internalType": "bool[]",
-                    "name": "boolArrayField",
-                    "type": "bool[]"
-                  }
-                ],
-                "internalType": "struct TypeTemplate.RequestSubstruct1",
-                "name": "requestSubstruct1",
-                "type": "tuple"
-              },
-              {
-                "components": [
-                  {
-                    "internalType": "bytes32",
-                    "name": "templateStructField",
-                    "type": "bytes32"
-                  },
-                  {
-                    "internalType": "int256[]",
-                    "name": "intArrayField",
-                    "type": "int256[]"
-                  },
-                  {
-                    "internalType": "bool[]",
-                    "name": "boolArrayField",
-                    "type": "bool[]"
-                  }
-                ],
-                "internalType": "struct TypeTemplate.RequestSubstruct2[]",
-                "name": "requestSubstruct2Array",
-                "type": "tuple[]"
-              }
-            ],
-            "internalType": "struct TypeTemplate.RequestBody",
-            "name": "requestBody",
-            "type": "tuple"
-          },
-          {
-            "components": [
-              {
-                "internalType": "bytes32",
-                "name": "templateResponseField",
-                "type": "bytes32"
-              },
-              {
-                "components": [
-                  {
-                    "internalType": "bytes32",
-                    "name": "templateStructField",
-                    "type": "bytes32"
-                  }
-                ],
-                "internalType": "struct TypeTemplate.ResponseSubstruct1[]",
-                "name": "responseSubstruct1Array",
-                "type": "tuple[]"
-              }
-            ],
-            "internalType": "struct TypeTemplate.ResponseBody",
-            "name": "responseBody",
-            "type": "tuple"
-          }
-        ],
-        "internalType": "struct TypeTemplate.Response",
-        "name": "data",
-        "type": "tuple"
-      }
-    ],
-    "internalType": "struct TypeTemplate.Proof",
-    "name": "_proof",
-    "type": "tuple"
-  }
-}

package/dist/coston/StateConnector/libs/ts/AttestationDefinitionStore.d.ts

@@ -1,68 +0,0 @@
-import { TypeRecord } from "./config-types";
-import { ethers } from "ethers";
-import { ARBase, ARESBase } from "./interfaces";
-/**
- * Attestation definition store. Contains all the attestation type definitions
- * that are contained in the folder, from which the store was initialized.
- */
-export declare class AttestationDefinitionStore {
-    definitions: Map<string, TypeRecord>;
-    coder: ethers.AbiCoder;
-    constructor(configsPath?: string);
-    /**
-     * Initializes the store by reading the attestation type definition configs from the
-     * provided path.
-     * @param configsPath
-     */
-    private initialize;
-    /**
-     * Returns the attestation type definition for the provided attestation type id.
-     * @param attestationType
-     * @returns
-     */
-    getDefinitionForDecodedAttestationType(attestationType: string): TypeRecord | undefined;
-    getABIsForDecodedAttestationType(attestationTypeId: string): {
-        requestAbi: any;
-        responseAbi: any;
-        proofAbi: any;
-    };
-    /**
-     * Calculated usual or salted hash of the attestation response.
-     * The function throws an error if an attestation type is not supported or
-     * the response does not match the provided ABI definition.
-     * @param response
-     * @param salt
-     * @returns
-     */
-    attestationResponseHash<T extends ARESBase>(response: T, salt?: string): string;
-    /**
-     * Extracts the attestation type prefix from the provided attestation request.
-     * The prefix consists of 3 x 32 bytes: attestation type, source id and message integrity code.
-     * The rest of the bytes define ABI encoded request body.
-     * @param bytes
-     * @param decodeAttestationTypeName
-     * @returns
-     */
-    static extractPrefixFromRequest(bytes: string, decodeAttestationTypeName?: boolean): ARBase;
-    /**
-     * Encodes attestation request.
-     * The request must have the attestation type encoded into 32-byte 0x-prefixed string.
-     * @param request
-     * @returns
-     */
-    encodeRequest(request: ARBase): string;
-    /**
-     * Parses attestation request.
-     * @param bytes
-     * @returns
-     */
-    parseRequest<AR extends ARBase>(bytes: string, decodeAttestationTypeName?: boolean): AR;
-    /**
-     * Compares two attestation requests.
-     * @param request1
-     * @param request2
-     * @returns
-     */
-    equalsRequest(request1: ARBase, request2: ARBase): boolean;
-}
-//# sourceMappingURL=AttestationDefinitionStore.d.ts.map

package/dist/coston/StateConnector/libs/ts/AttestationDefinitionStore.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"AttestationDefinitionStore.d.ts","sourceRoot":"","sources":["../../../../../coston/StateConnector/libs/ts/AttestationDefinitionStore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAYhD;;;GAGG;AACH,qBAAa,0BAA0B;IACnC,WAAW,EAAG,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACtC,KAAK,EAAG,MAAM,CAAC,QAAQ,CAAC;gBAEZ,WAAW,SAAwC;IAG/D;;;;OAIG;IACH,OAAO,CAAC,UAAU;IAKlB;;;;OAIG;IACH,sCAAsC,CAAC,eAAe,EAAE,MAAM;IAI9D,gCAAgC,CAAC,iBAAiB,EAAE,MAAM;;;;;IAY1D;;;;;;;OAOG;IACH,uBAAuB,CAAC,CAAC,SAAS,QAAQ,EAAE,QAAQ,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM;IAe/E;;;;;;;OAOG;IACH,MAAM,CAAC,wBAAwB,CAAC,KAAK,EAAE,MAAM,EAAE,yBAAyB,UAAQ,GAAG,MAAM;IAsBzF;;;;;OAKG;IACH,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAoBtC;;;;OAIG;IACH,YAAY,CAAC,EAAE,SAAS,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,yBAAyB,UAAQ,GAAG,EAAE;IAqBrF;;;;;OAKG;IACH,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO;CAc7D"}