Merge branch 'main' of github.com:OpenZeppelin/openzeppelin-relayer-sdk into PLAT-6439-fix-npm-release

Author: collins-w

.github/workflows/cla.yml

@@ -26,38 +26,38 @@ jobs:
         with:
           egress-policy: audit
 
-      # - name: Checkout Private Repo for Allowlist
-      #   uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 #v4.2.2
-      #   with:
-      #     repository: OpenZeppelin/cla-sigs
-      #     token: ${{ steps.gh-app-token.outputs.token }}
-      #     sparse-checkout: |
-      #       allowlist.txt
-      #     sparse-checkout-cone-mode: false
+      - name: Checkout Private Repo for Allowlist
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 #v4.2.2
+        with:
+          repository: OpenZeppelin/cla-sigs
+          token: ${{ secrets.CLA_SIGS_ACCESS_PAT }}
+          sparse-checkout: |
+            allowlist.txt
+          sparse-checkout-cone-mode: false
 
       # - name: Read Allowlist File
       #   id: read_allowlist
       #   run: |
       #     ALLOWLIST=$(cat allowlist.txt)
       #     echo "allowlist=$ALLOWLIST" >> $GITHUB_OUTPUT
 
-      # - name: "CLA Assistant"
-      #   if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I confirm that I have read and hereby agree to the OpenZeppelin Contributor License Agreement') || github.event_name == 'pull_request_target'
-      #   uses: contributor-assistant/github-action@ca4a40a7d1004f18d9960b404b97e5f30a505a08 #v2.6.1
-      #   env:
-      #     GITHUB_TOKEN: ${{ steps.gh-app-token.outputs.token }}
-      #     PERSONAL_ACCESS_TOKEN: ${{ steps.gh-app-token.outputs.token }}
-      #   with:
-      #     path-to-signatures: 'signatures/${{ github.event.repository.name }}/v1_cla.json'
-      #     path-to-document: 'https://github.com/OpenZeppelin/cla-assistant/blob/main/openzeppelin_2025_cla.md'
-      #     branch: 'main'
-      #     allowlist: ${{ steps.read_allowlist.outputs.allowlist }}
-      #     remote-organization-name: 'OpenZeppelin'
-      #     remote-repository-name: 'cla-sigs'
-      #     custom-notsigned-prcomment: >
-      #       Thank you for your contribution to OpenZeppelin Relayer SDK.
-      #       Before being able to integrate those changes, we would like you to
-      #       sign our [Contributor License Agreement](https://github.com/OpenZeppelin/cla-assistant/blob/main/openzeppelin_2025_cla.md).
+      - name: "CLA Assistant"
+        if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I confirm that I have read and hereby agree to the OpenZeppelin Contributor License Agreement') || github.event_name == 'pull_request_target'
+        uses: contributor-assistant/github-action@ca4a40a7d1004f18d9960b404b97e5f30a505a08 #v2.6.1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PERSONAL_ACCESS_TOKEN: ${{ secrets.CLA_SIGS_ACCESS_PAT }}
+        with:
+          path-to-signatures: 'signatures/${{ github.event.repository.name }}/v1_cla.json'
+          path-to-document: 'https://github.com/OpenZeppelin/cla-assistant/blob/main/openzeppelin_2025_cla.md'
+          branch: 'main'
+          allowlist: ${{ steps.read_allowlist.outputs.allowlist }}
+          remote-organization-name: 'OpenZeppelin'
+          remote-repository-name: 'cla-sigs'
+          custom-notsigned-prcomment: >
+            Thank you for your contribution to OpenZeppelin Relayer SDK.
+            Before being able to integrate those changes, we would like you to
+            sign our [Contributor License Agreement](https://github.com/OpenZeppelin/cla-assistant/blob/main/openzeppelin_2025_cla.md).
 
       #       You can sign the CLA by just posting a Pull Request Comment with the sentence below. Thanks.
       #     custom-pr-sign-comment: 'I confirm that I have read and hereby agree to the OpenZeppelin Contributor License Agreement'

README.md

@@ -49,7 +49,7 @@ import { Configuration, RelayersApi } from '@openzeppelin/relayer-sdk';
 
 const config = new Configuration({
   basePath: 'https://your-path.com',
-  accessToken: 'Bearer example-123456',
+  accessToken: '',
 });
 
 const relayersApi = new RelayersApi(config);

SECURITY.md

@@ -0,0 +1,32 @@
+# Security Policy
+
+Security vulnerabilities should be [disclosed](#reporting-a-vulnerability) to the [project maintainers](./CODEOWNERS), or alternatively by email to security@openzeppelin.com.
+
+## Supported Versions
+
+The following versions are currently supported and receive security updates. Alpha, Beta and Release candidates will not receive security updates.
+
+Security patches will be released for the latest minor of a given major release. For example, if an issue is found in versions >=1.13.0 and the latest is 1.14.0, the patch will be released only in version 1.14.1.
+
+Only critical severity bug fixes will be backported to past major releases.
+
+| Version   | Supported          |
+| --------- | ------------------ |
+| >= 0.1.x  | :white_check_mark: |
+| <= 0.0.9  | :x:                |
+
+## Reporting a Vulnerability
+
+We're extremely grateful for security researchers and users that report vulnerabilities to us.
+All reports are thoroughly investigated by the project's security team.
+
+Vulnerabilities are reported privately via GitHub's [Security Advisories](https://docs.github.com/en/code-security/security-advisories) feature.
+Please use the following link to submit your vulnerability: [Report a vulnerability](https://github.com/openzeppelin/openzeppelin-relayer-sdk/security/advisories/new)
+
+Please see
+[Privately reporting a security vulnerability](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability#privately-reporting-a-security-vulnerability)
+for more information on how to submit a vulnerability using GitHub's interface.
+
+## Legal
+
+OpenZeppelin Relayer SDK is made available under the GNU AGPL 3.0 License, which disclaims all warranties in relation to the project and which limits the liability of those that contribute and maintain the project, including OpenZeppelin. Your use of the project is also governed by the terms found at www.openzeppelin.com/tos (the "Terms"). As set out in the Terms, you are solely responsible for any use of OpenZeppelin Relayer SDK and you assume all risks associated with any such use. This Security Policy in no way evidences or represents an on-going duty by any contributor, including OpenZeppelin, to correct any flaws or alert you to all or any of the potential risks of utilizing the project.

examples/evm/getTransactionById.ts

@@ -18,14 +18,14 @@ import { Configuration, RelayersApi } from '../../src';
 // example dev config
 const config = new Configuration({
   basePath: 'http://localhost:8080',
-  accessToken: 'Bearer example-123456',
+  accessToken: '', // replace with your actual api key
 });
 
 const relayersApi = new RelayersApi(config);
 
+// replace with your actual ids
 const relayer_id = 'sepolia-example';
-
-const transaction_id = '305ff83d-6653-465f-8fa3-e8a46271fb83';
+const transaction_id = '7283c042-86e8-4831-9439-90da9e28a0f1';
 
 relayersApi
   .getTransactionById(relayer_id, transaction_id)

examples/evm/getTransactionByNonce.ts

@@ -18,11 +18,12 @@ import { Configuration, RelayersApi } from '../../src';
 // example dev config
 const config = new Configuration({
   basePath: 'http://localhost:8080',
-  accessToken: 'Bearer example-123456',
+  accessToken: '', // replace with your actual api key
 });
 
 const relayersApi = new RelayersApi(config);
 
+// replace with your actual ids
 const relayer_id = 'sepolia-example';
 
 const nonce = 44;

examples/evm/listTransactions.ts

@@ -18,11 +18,12 @@ import { Configuration, RelayersApi } from '../../src';
 // example dev config
 const config = new Configuration({
   basePath: 'http://localhost:8080',
-  accessToken: 'Bearer example-123456',
+  accessToken: '', // replace with your actual api key
 });
 
 const relayersApi = new RelayersApi(config);
 
+// replace with your actual ids
 const relayer_id = 'sepolia-example';
 
 relayersApi

examples/evm/sendTransactionEIP1559.ts

@@ -18,11 +18,12 @@ import { Configuration, RelayersApi } from '../../src';
 // example dev config
 const config = new Configuration({
   basePath: 'http://localhost:8080',
-  accessToken: 'Bearer example-123456',
+  accessToken: '', // replace with your actual api key
 });
 
 const relayersApi = new RelayersApi(config);
 
+// replace with your actual ids
 const relayer_id = 'sepolia-example';
 
 relayersApi

examples/evm/sendTransactionLegacy.ts

@@ -18,11 +18,12 @@ import { Configuration, RelayersApi } from '../../src';
 // example dev config
 const config = new Configuration({
   basePath: 'http://localhost:8080',
-  accessToken: 'Bearer example-123456',
+  accessToken: '', // replace with your actual api key
 });
 
 const relayersApi = new RelayersApi(config);
 
+// replace with your actual ids
 const relayer_id = 'sepolia-example';
 
 relayersApi

examples/evm/sendTransactionSpeed.ts

@@ -18,11 +18,12 @@ import { Configuration, RelayersApi, Speed } from '../../src';
 // example dev config
 const config = new Configuration({
   basePath: 'http://localhost:8080',
-  accessToken: 'Bearer example-123456',
+  accessToken: '', // replace with your actual api key
 });
 
 const relayersApi = new RelayersApi(config);
 
+// replace with your actual id
 const relayer_id = 'sepolia-example';
 
 relayersApi

examples/get-relayer-balance/index.ts

@@ -18,11 +18,12 @@ import { Configuration, RelayersApi } from '../../src';
 // example dev config
 const config = new Configuration({
   basePath: 'http://localhost:8080',
-  accessToken: 'Bearer example-123456',
+  accessToken: '', // replace with your actual api key
 });
 
 const relayersApi = new RelayersApi(config);
 
+// replace with your actual ids
 const relayer_id = 'solana-example';
 
 relayersApi