Implement RequesterAuthorizerWithErc721 authorizers (#1670)

* Implement RequesterAuthorizerWithErc721 authorizers * Fix authorizers empty arrays behavior Previously requesterEndpointAuthorizers being empty would result in all requests being authorized, independent of whether the other authorizer arrays were nonempty * Add INFO log for all authorizer arrays being empty --------- Co-authored-by: Emanuel Tesar <[email protected]>
api3dao · Mar 17, 2023 · 1b486bb · 1b486bb
1 parent e1746a1
commit 1b486bb
Show file tree

Hide file tree

Showing 63 changed files with 1,654 additions and 152 deletions.
diff --git a/.changeset/tiny-pumpkins-cross.md b/.changeset/tiny-pumpkins-cross.md
@@ -0,0 +1,7 @@
+---
+'@api3/airnode-node': minor
+'@api3/airnode-protocol': minor
+'@api3/airnode-validator': minor
+---
+
+Implement RequesterAuthorizerWithErc721 authorizers
diff --git a/.prettierignore b/.prettierignore
@@ -38,4 +38,4 @@ config.json
 
 # !!! Temporary until the proper formatting is sorted out !!!
 # https://github.com/api3dao/airnode/issues/1660
-packages/airnode-protocol/contracts
+packages/airnode-protocol/contracts
diff --git a/.swp b/.swp
diff --git a/packages/airnode-deployer/config/config.example.json b/packages/airnode-deployer/config/config.example.json
@@ -4,7 +4,9 @@
       "maxConcurrency": 100,
       "authorizers": {
         "requesterEndpointAuthorizers": [],
-        "crossChainRequesterAuthorizers": []
+        "crossChainRequesterAuthorizers": [],
+        "requesterAuthorizersWithErc721": [],
+        "crossChainRequesterAuthorizersWithErc721": []
       },
       "authorizations": {
         "requesterEndpointAuthorizations": {}

diff --git a/packages/airnode-deployer/test/fixtures/config.aws.valid.json b/packages/airnode-deployer/test/fixtures/config.aws.valid.json
@@ -4,7 +4,9 @@
       "maxConcurrency": 100,
       "authorizers": {
         "requesterEndpointAuthorizers": [],
-        "crossChainRequesterAuthorizers": []
+        "crossChainRequesterAuthorizers": [],
+        "requesterAuthorizersWithErc721": [],
+        "crossChainRequesterAuthorizersWithErc721": []
       },
       "authorizations": {
         "requesterEndpointAuthorizations": {}

diff --git a/packages/airnode-examples/integrations/authenticated-coinmarketcap/config.example.json b/packages/airnode-examples/integrations/authenticated-coinmarketcap/config.example.json
@@ -4,7 +4,9 @@
       "maxConcurrency": 100,
       "authorizers": {
         "requesterEndpointAuthorizers": [],
-        "crossChainRequesterAuthorizers": []
+        "crossChainRequesterAuthorizers": [],
+        "requesterAuthorizersWithErc721": [],
+        "crossChainRequesterAuthorizersWithErc721": []
       },
       "authorizations": {
         "requesterEndpointAuthorizations": {}

diff --git a/packages/airnode-examples/integrations/authenticated-coinmarketcap/create-config.ts b/packages/airnode-examples/integrations/authenticated-coinmarketcap/create-config.ts
@@ -14,6 +14,8 @@ const createConfig = async (generateExampleFile: boolean): Promise<Config> => ({
       authorizers: {
         requesterEndpointAuthorizers: [],
         crossChainRequesterAuthorizers: [],
+        requesterAuthorizersWithErc721: [],
+        crossChainRequesterAuthorizersWithErc721: [],
       },
       authorizations: {
         requesterEndpointAuthorizations: {},

diff --git a/packages/airnode-examples/integrations/coingecko-cross-chain-authorizer/config.example.json b/packages/airnode-examples/integrations/coingecko-cross-chain-authorizer/config.example.json
@@ -16,7 +16,9 @@
               "url": "${CROSS_CHAIN_PROVIDER_URL}"
             }
           }
-        ]
+        ],
+        "requesterAuthorizersWithErc721": [],
+        "crossChainRequesterAuthorizersWithErc721": []
       },
       "authorizations": {
         "requesterEndpointAuthorizations": {}

diff --git a/packages/airnode-examples/integrations/coingecko-cross-chain-authorizer/create-config.ts b/packages/airnode-examples/integrations/coingecko-cross-chain-authorizer/create-config.ts
@@ -27,6 +27,8 @@ const createConfig = async (generateExampleFile: boolean): Promise<Config> => ({
             },
           },
         ],
+        requesterAuthorizersWithErc721: [],
+        crossChainRequesterAuthorizersWithErc721: [],
       },
       authorizations: {
         requesterEndpointAuthorizations: {},

diff --git a/packages/airnode-examples/integrations/coingecko-http-gateways/config.example.json b/packages/airnode-examples/integrations/coingecko-http-gateways/config.example.json
@@ -4,7 +4,9 @@
       "maxConcurrency": 100,
       "authorizers": {
         "requesterEndpointAuthorizers": [],
-        "crossChainRequesterAuthorizers": []
+        "crossChainRequesterAuthorizers": [],
+        "requesterAuthorizersWithErc721": [],
+        "crossChainRequesterAuthorizersWithErc721": []
       },
       "authorizations": {
         "requesterEndpointAuthorizations": {}

diff --git a/packages/airnode-examples/integrations/coingecko-http-gateways/create-config.ts b/packages/airnode-examples/integrations/coingecko-http-gateways/create-config.ts
@@ -14,6 +14,8 @@ const createConfig = async (generateExampleFile: boolean): Promise<Config> => ({
       authorizers: {
         requesterEndpointAuthorizers: [],
         crossChainRequesterAuthorizers: [],
+        requesterAuthorizersWithErc721: [],
+        crossChainRequesterAuthorizersWithErc721: [],
       },
       authorizations: {
         requesterEndpointAuthorizations: {},

diff --git a/packages/airnode-examples/integrations/coingecko-post-processing/config.example.json b/packages/airnode-examples/integrations/coingecko-post-processing/config.example.json
@@ -4,7 +4,9 @@
       "maxConcurrency": 100,
       "authorizers": {
         "requesterEndpointAuthorizers": [],
-        "crossChainRequesterAuthorizers": []
+        "crossChainRequesterAuthorizers": [],
+        "requesterAuthorizersWithErc721": [],
+        "crossChainRequesterAuthorizersWithErc721": []
       },
       "authorizations": {
         "requesterEndpointAuthorizations": {}

diff --git a/packages/airnode-examples/integrations/coingecko-post-processing/create-config.ts b/packages/airnode-examples/integrations/coingecko-post-processing/create-config.ts
@@ -14,6 +14,8 @@ const createConfig = async (generateExampleFile: boolean): Promise<Config> => ({
       authorizers: {
         requesterEndpointAuthorizers: [],
         crossChainRequesterAuthorizers: [],
+        requesterAuthorizersWithErc721: [],
+        crossChainRequesterAuthorizersWithErc721: [],
       },
       authorizations: {
         requesterEndpointAuthorizations: {},

diff --git a/packages/airnode-examples/integrations/coingecko-pre-processing/config.example.json b/packages/airnode-examples/integrations/coingecko-pre-processing/config.example.json
@@ -4,7 +4,9 @@
       "maxConcurrency": 100,
       "authorizers": {
         "requesterEndpointAuthorizers": [],
-        "crossChainRequesterAuthorizers": []
+        "crossChainRequesterAuthorizers": [],
+        "requesterAuthorizersWithErc721": [],
+        "crossChainRequesterAuthorizersWithErc721": []
       },
       "authorizations": {
         "requesterEndpointAuthorizations": {}

diff --git a/packages/airnode-examples/integrations/coingecko-pre-processing/create-config.ts b/packages/airnode-examples/integrations/coingecko-pre-processing/create-config.ts
@@ -14,6 +14,8 @@ const createConfig = async (generateExampleFile: boolean): Promise<Config> => ({
       authorizers: {
         requesterEndpointAuthorizers: [],
         crossChainRequesterAuthorizers: [],
+        requesterAuthorizersWithErc721: [],
+        crossChainRequesterAuthorizersWithErc721: [],
       },
       authorizations: {
         requesterEndpointAuthorizations: {},

diff --git a/packages/airnode-examples/integrations/coingecko-template/config.example.json b/packages/airnode-examples/integrations/coingecko-template/config.example.json
@@ -4,7 +4,9 @@
       "maxConcurrency": 100,
       "authorizers": {
         "requesterEndpointAuthorizers": [],
-        "crossChainRequesterAuthorizers": []
+        "crossChainRequesterAuthorizers": [],
+        "requesterAuthorizersWithErc721": [],
+        "crossChainRequesterAuthorizersWithErc721": []
       },
       "authorizations": {
         "requesterEndpointAuthorizations": {}

diff --git a/packages/airnode-examples/integrations/coingecko-template/create-config.ts b/packages/airnode-examples/integrations/coingecko-template/create-config.ts
@@ -15,6 +15,8 @@ const createConfig = async (generateExampleFile: boolean): Promise<Config> => ({
       authorizers: {
         requesterEndpointAuthorizers: [],
         crossChainRequesterAuthorizers: [],
+        requesterAuthorizersWithErc721: [],
+        crossChainRequesterAuthorizersWithErc721: [],
       },
       authorizations: {
         requesterEndpointAuthorizations: {},

diff --git a/packages/airnode-examples/integrations/coingecko/config.example.json b/packages/airnode-examples/integrations/coingecko/config.example.json
@@ -4,7 +4,9 @@
       "maxConcurrency": 100,
       "authorizers": {
         "requesterEndpointAuthorizers": [],
-        "crossChainRequesterAuthorizers": []
+        "crossChainRequesterAuthorizers": [],
+        "requesterAuthorizersWithErc721": [],
+        "crossChainRequesterAuthorizersWithErc721": []
       },
       "authorizations": {
         "requesterEndpointAuthorizations": {}

diff --git a/packages/airnode-examples/integrations/coingecko/create-config.ts b/packages/airnode-examples/integrations/coingecko/create-config.ts
@@ -14,6 +14,8 @@ const createConfig = async (generateExampleFile: boolean): Promise<Config> => ({
       authorizers: {
         requesterEndpointAuthorizers: [],
         crossChainRequesterAuthorizers: [],
+        requesterAuthorizersWithErc721: [],
+        crossChainRequesterAuthorizersWithErc721: [],
       },
       authorizations: {
         requesterEndpointAuthorizations: {},

diff --git a/packages/airnode-examples/integrations/failing-example/config.example.json b/packages/airnode-examples/integrations/failing-example/config.example.json
@@ -4,7 +4,9 @@
       "maxConcurrency": 100,
       "authorizers": {
         "requesterEndpointAuthorizers": [],
-        "crossChainRequesterAuthorizers": []
+        "crossChainRequesterAuthorizers": [],
+        "requesterAuthorizersWithErc721": [],
+        "crossChainRequesterAuthorizersWithErc721": []
       },
       "authorizations": {
         "requesterEndpointAuthorizations": {}

diff --git a/packages/airnode-examples/integrations/failing-example/create-config.ts b/packages/airnode-examples/integrations/failing-example/create-config.ts
@@ -14,6 +14,8 @@ const createConfig = async (generateExampleFile: boolean): Promise<Config> => ({
       authorizers: {
         requesterEndpointAuthorizers: [],
         crossChainRequesterAuthorizers: [],
+        requesterAuthorizersWithErc721: [],
+        crossChainRequesterAuthorizersWithErc721: [],
       },
       authorizations: {
         requesterEndpointAuthorizations: {},

diff --git a/packages/airnode-examples/integrations/relay-security-schemes/config.example.json b/packages/airnode-examples/integrations/relay-security-schemes/config.example.json
@@ -4,7 +4,9 @@
       "maxConcurrency": 100,
       "authorizers": {
         "requesterEndpointAuthorizers": [],
-        "crossChainRequesterAuthorizers": []
+        "crossChainRequesterAuthorizers": [],
+        "requesterAuthorizersWithErc721": [],
+        "crossChainRequesterAuthorizersWithErc721": []
       },
       "authorizations": {
         "requesterEndpointAuthorizations": {}

diff --git a/packages/airnode-examples/integrations/relay-security-schemes/create-config.ts b/packages/airnode-examples/integrations/relay-security-schemes/create-config.ts
@@ -14,6 +14,8 @@ const createConfig = async (generateExampleFile: boolean): Promise<Config> => ({
       authorizers: {
         requesterEndpointAuthorizers: [],
         crossChainRequesterAuthorizers: [],
+        requesterAuthorizersWithErc721: [],
+        crossChainRequesterAuthorizersWithErc721: [],
       },
       authorizations: {
         requesterEndpointAuthorizations: {},

diff --git a/packages/airnode-examples/integrations/weather-multi-value/config.example.json b/packages/airnode-examples/integrations/weather-multi-value/config.example.json
@@ -4,7 +4,9 @@
       "maxConcurrency": 100,
       "authorizers": {
         "requesterEndpointAuthorizers": [],
-        "crossChainRequesterAuthorizers": []
+        "crossChainRequesterAuthorizers": [],
+        "requesterAuthorizersWithErc721": [],
+        "crossChainRequesterAuthorizersWithErc721": []
       },
       "authorizations": {
         "requesterEndpointAuthorizations": {}

diff --git a/packages/airnode-examples/integrations/weather-multi-value/create-config.ts b/packages/airnode-examples/integrations/weather-multi-value/create-config.ts
@@ -14,6 +14,8 @@ const createConfig = async (generateExampleFile: boolean): Promise<Config> => ({
       authorizers: {
         requesterEndpointAuthorizers: [],
         crossChainRequesterAuthorizers: [],
+        requesterAuthorizersWithErc721: [],
+        crossChainRequesterAuthorizersWithErc721: [],
       },
       authorizations: {
         requesterEndpointAuthorizations: {},

diff --git a/packages/airnode-node/config/config.example.json b/packages/airnode-node/config/config.example.json
@@ -4,7 +4,9 @@
       "maxConcurrency": 100,
       "authorizers": {
         "requesterEndpointAuthorizers": [],
-        "crossChainRequesterAuthorizers": []
+        "crossChainRequesterAuthorizers": [],
+        "requesterAuthorizersWithErc721": [],
+        "crossChainRequesterAuthorizersWithErc721": []
       },
       "authorizations": {
         "requesterEndpointAuthorizations": {}

diff --git a/packages/airnode-node/src/coordinator/calls/chain-limits.test.ts b/packages/airnode-node/src/coordinator/calls/chain-limits.test.ts
@@ -10,6 +10,8 @@ const createChainConfig = (overrides: Partial<ChainConfig>): ChainConfig => {
     authorizers: {
       requesterEndpointAuthorizers: [],
       crossChainRequesterAuthorizers: [],
+      requesterAuthorizersWithErc721: [],
+      crossChainRequesterAuthorizersWithErc721: [],
     },
     authorizations: {
       requesterEndpointAuthorizations: {},

diff --git a/packages/airnode-node/src/evm/authorization/authorization-application.test.ts b/packages/airnode-node/src/evm/authorization/authorization-application.test.ts
@@ -33,7 +33,12 @@ describe('mergeAuthorizations', () => {
     const apiCall = fixtures.requests.buildApiCall({ id: '0xapiCallId' });
     const authorizationByRequestId = { '0xapiCallId': true };
     const [logs, res] = authorization.mergeAuthorizations([apiCall], authorizationByRequestId);
-    expect(logs).toEqual([]);
+    expect(logs).toEqual([
+      {
+        level: 'DEBUG',
+        message: 'Requester:requesterAddress is authorized to access Endpoint ID:endpointId for Request ID:0xapiCallId',
+      },
+    ]);
     expect(res).toEqual([apiCall]);
   });
 

diff --git a/packages/airnode-node/src/evm/authorization/authorization-application.ts b/packages/airnode-node/src/evm/authorization/authorization-application.ts
@@ -30,7 +30,11 @@ function applyAuthorization(
       }
 
       if (authorized) {
-        return { ...acc, requests: [...acc.requests, apiCall] };
+        const log = logger.pend(
+          'DEBUG',
+          `Requester:${apiCall.requesterAddress} is authorized to access Endpoint ID:${apiCall.endpointId} for Request ID:${apiCall.id}`
+        );
+        return { ...acc, logs: [...acc.logs, log], requests: [...acc.requests, apiCall] };
       }
 
       // If the request is unauthorized, update drop the request