@openzeppelin/defender-relay-client - npm Package Compare versions

Comparing version 1.54.4 to 1.54.5

lib/api/index.d.ts

@@ -1,8 +0,10 @@
-import { BaseApiClient, ApiVersion } from '@openzeppelin/defender-base-client';
+import { BaseApiClient, ApiVersion, AuthType } from '@openzeppelin/defender-base-client';
 import { ApiRelayerParams, IRelayer, JsonRpcResponse, ListTransactionsRequest, RelayerGetResponse, RelayerTransaction, RelayerTransactionPayload, SignedMessagePayload, SignTypedDataPayload, SignMessagePayload, CreateRelayerRequest, RelayerListResponse, UpdateRelayerRequest, RelayerApiKey, DeleteRelayerApiKeyResponse, PaginatedTransactionListResponse, RelayerStatus } from '../relayer';
 export declare const RelaySignerApiUrl: () => string;
+export declare const getAdminApiUrl: () => string;
 export declare class RelayClient extends BaseApiClient {
+    constructor(params: ApiRelayerParams);
     protected getPoolId(): string;
     protected getPoolClientId(): string;
-    protected getApiUrl(v?: ApiVersion): string;
+    protected getApiUrl(v?: ApiVersion, type?: AuthType): string;
     get(relayerId: string): Promise<RelayerGetResponse>;
@@ -22,3 +24,3 @@ list(): Promise<RelayerListResponse>;
     protected getPoolClientId(): string;
-    protected getApiUrl(_: ApiVersion): string;
+    protected getApiUrl(_: ApiVersion, type?: AuthType): string;
     getRelayer(): Promise<RelayerGetResponse>;
@@ -25,0 +27,0 @@ getRelayerStatus(): Promise<RelayerStatus>;

lib/api/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiRelayer = exports.RelayClient = exports.RelaySignerApiUrl = void 0;
+exports.ApiRelayer = exports.RelayClient = exports.getAdminApiUrl = exports.RelaySignerApiUrl = void 0;
 const defender_base_client_1 = require("@openzeppelin/defender-base-client");
 const RelaySignerApiUrl = () => process.env.DEFENDER_RELAY_SIGNER_API_URL || 'https://api.defender.openzeppelin.com/';
 exports.RelaySignerApiUrl = RelaySignerApiUrl;
+const getAdminApiUrl = () => process.env.DEFENDER_API_URL || 'https://defender-api.openzeppelin.com/';
+exports.getAdminApiUrl = getAdminApiUrl;
 class RelayClient extends defender_base_client_1.BaseApiClient {
+    constructor(params) {
+        super({
+            apiKey: params.apiKey,
+            apiSecret: params.apiSecret,
+            httpsAgent: params.httpsAgent,
+            authConfig: { useCredentialsCaching: params.useCredentialsCaching ?? false, type: 'admin' },
+        });
+    }
     getPoolId() {
@@ -14,3 +24,5 @@ return process.env.DEFENDER_RELAY_POOL_ID || 'us-west-2_94f3puJWv';
     }
-    getApiUrl(v = 'v1') {
+    getApiUrl(v = 'v1', type) {
+        if (type === 'admin')
+            return (0, exports.getAdminApiUrl)();
         if (v === 'v2') {
@@ -78,3 +90,8 @@ return process.env.DEFENDER_API_V2_URL || 'https://defender-api.openzeppelin.com/v2/';
     constructor(params) {
-        super(params);
+        super({
+            apiKey: params.apiKey,
+            apiSecret: params.apiSecret,
+            httpsAgent: params.httpsAgent,
+            authConfig: { useCredentialsCaching: params.useCredentialsCaching ?? false, type: 'relay' },
+        });
         this.jsonRpcRequestNextId = 1;
@@ -88,3 +105,5 @@ }
     }
-    getApiUrl(_) {
+    getApiUrl(_, type) {
+        if (type === 'admin')
+            return (0, exports.getAdminApiUrl)();
         return (0, exports.RelaySignerApiUrl)();
@@ -91,0 +110,0 @@ }

lib/relayer.d.ts

@@ -124,2 +124,3 @@ /// <reference types="node" />
     httpsAgent?: https.Agent;
+    useCredentialsCaching?: boolean;
 };
@@ -130,2 +131,3 @@ export type AutotaskRelayerParams = {
     httpsAgent?: https.Agent;
+    useCredentialsCaching?: boolean;
 };
@@ -132,0 +134,0 @@ export type JsonRpcResponse = {

package.json

 {
   "name": "@openzeppelin/defender-relay-client",
-  "version": "1.54.4",
+  "version": "1.54.5",
   "description": "",
@@ -34,3 +34,3 @@ "main": "./lib/index.js",
   "dependencies": {
-    "@openzeppelin/defender-base-client": "1.54.4",
+    "@openzeppelin/defender-base-client": "1.54.5",
     "amazon-cognito-identity-js": "^6.0.1",
@@ -57,3 +57,3 @@ "axios": "^1.4.0",
   },
-  "gitHead": "a7c4808dd11e708df42d110de230c264061c72c3"
+  "gitHead": "0fc43da796268b8c75d70179c7ea649b160dfd06"
 }

README.md

@@ -15,2 +15,6 @@ # Defender Relay Client & Signer
 
+# End Of Support Notice
+
+We will no longer be maintaining or supporting any additional releases for defender-client. Please migrate to defender-sdk as soon as possible to get all the benefits of defender 2.0 and more.
+
 ## Install
@@ -17,0 +21,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

409

increased by0.99%

Worsened metrics

Total package byte prevSize

129684

decreased by-34.78%

Number of package files

34

decreased by-38.18%

Lines of code

1205

decreased by-61.83%

Number of low supply chain risk alerts

8

increased by14.29%

Dependency changes

• + Added@openzeppelin/defender-base-client@1.54.5(transitive)

• - Removed@openzeppelin/defender-base-client@1.54.4(transitive)

• Updated@openzeppelin/defender-base-client@1.54.5