fix(API): Replace v1 with v2 endpoints

.github/scripts/generateApiReference.ts

@@ -240,6 +240,23 @@ const addMethodContext = (json: any) => ({
   }, {})
 })
 
+const checkMissingPaths = (json: any) => {
+  const missingPaths: string[] = []
+  Object.entries(json.paths).map(([path, methods]) => {
+    if (!pathsMetadata[path]) {
+      Object.entries(methods as any).filter((method: any) => !method[1].deprecated).map((method: any) => {
+        const pathAndMethod = `${path} ${method[0].toUpperCase()}`
+        missingPaths.push(pathAndMethod)
+      })
+    }
+  })
+  if (missingPaths.length > 0) {
+    console.log(`The following API endpoints are not deprecated and not documented.`)
+    console.log(`Consider adding the paths to the /components/ApiReference/paths-metadata.json file if needed.`)
+    console.log(`\n - ${missingPaths.join('\n - ')}\n`)
+  }
+}
+
 const getApiJson = async (url: string, networkName: string) => {
   const response = await fetch(url + '/schema/')
   const yaml = await response.text()
@@ -468,6 +485,10 @@ ${categories.map(category => generateCategoryContent(swagger, networkName, categ
 }
 
 const main = async () => {
+  // Check not documented and not deprecated endpoints.
+  const sepoliaJsonFile = await getApiJson(txServiceNetworks[0].txServiceUrl, txServiceNetworks[0].txServiceUrl.replace('https://safe-transaction-', '').split('.')[0])
+  checkMissingPaths(sepoliaJsonFile)
+
   txServiceNetworks.forEach(
     async (network: { chainId: string; txServiceUrl: string }) => {
       const networkName = network.txServiceUrl
@@ -518,7 +539,7 @@ export const getStaticProps = async () => {
         .filter((file: string) => file.endsWith('.ts'))
       exampleFiles.forEach((file: string) => {
         const contents = fs.readFileSync(
-          `./components/ApiReference/examples/${file}`,
+          `./components/ApiReference/examples/sepolia/${file}`,
           'utf-8'
         )
         if (

components/ApiReference/examples/arbitrum/-v2-multisig-transactions-{safe_tx_hash}--get.ts

@@ -0,0 +1,11 @@
+import SafeApiKit from '@safe-global/api-kit'
+
+const apiKit = new SafeApiKit({
+  chainId: 42161n
+})
+
+const safeTxHash = '0x897cab0528ffa8cbe10ee533e636d1a42b9e8d42f8dccb9af9006804d02d2027'
+
+const transaction = await apiKit.getTransaction(safeTxHash)
+
+console.log(transaction)

components/ApiReference/examples/arbitrum/-v2-safes-{address}-all-transactions--get.ts

@@ -0,0 +1,11 @@
+import SafeApiKit from '@safe-global/api-kit'
+
+const apiKit = new SafeApiKit({
+  chainId: 42161n
+})
+
+const transactions = await apiKit.getAllTransactions(
+  '0x5298a93734c3d979ef1f23f78ebb871879a21f22'
+)
+
+console.log(transactions)

components/ApiReference/examples/arbitrum/-v2-safes-{address}-multisig-transactions--get.ts

@@ -0,0 +1,11 @@
+import SafeApiKit from '@safe-global/api-kit'
+
+const apiKit = new SafeApiKit({
+  chainId: 42161n
+})
+
+const multisigTransactions = await apiKit.getMultisigTransactions(
+  '0x5298a93734c3d979ef1f23f78ebb871879a21f22'
+)
+
+console.log(multisigTransactions)

components/ApiReference/examples/arbitrum/-v2-safes-{address}-multisig-transactions--post.ts

@@ -0,0 +1,29 @@
+import SafeApiKit, { ProposeTransactionProps } from '@safe-global/api-kit'
+import { SafeTransactionData } from '@safe-global/types-kit'
+
+const apiKit = new SafeApiKit({
+  chainId: 42161n
+})
+
+const safeTransactionData: SafeTransactionData = {
+  to: '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045',
+  value: '50000000000000',
+  data: '0x',
+  operation: 0, // 0 = call, 1 = delegate call
+  safeTxGas: '0',
+  baseGas: '0',
+  gasPrice: '0',
+  gasToken: '0x0000000000000000000000000000000000000000',
+  refundReceiver: '0x0000000000000000000000000000000000000000',
+  nonce: '10'
+}
+
+const proposeTransactionProps: ProposeTransactionProps = {
+  safeAddress: '0x5298a93734c3d979ef1f23f78ebb871879a21f22',
+  safeTxHash: '0x897cab0528ffa8cbe10ee533e636d1a42b9e8d42f8dccb9af9006804d02d2027',
+  safeTransactionData,
+  senderAddress: '0xa6d3DEBAAB2B8093e69109f23A75501F864F74e2',
+  senderSignature: '0xec2c1cf656d997f92247ddf59f30ce718de990ec4f8d4670a37d3d3594862f0d49ad2c553daa2ff937c50d45e9ca6a815f826d29603f8c5c818cb698ddc2383a20'
+}
+
+await apiKit.proposeTransaction(proposeTransactionProps)

components/ApiReference/examples/aurora/-v2-multisig-transactions-{safe_tx_hash}--get.ts

@@ -0,0 +1,11 @@
+import SafeApiKit from '@safe-global/api-kit'
+
+const apiKit = new SafeApiKit({
+  chainId: 1313161554n
+})
+
+const safeTxHash = '0x897cab0528ffa8cbe10ee533e636d1a42b9e8d42f8dccb9af9006804d02d2027'
+
+const transaction = await apiKit.getTransaction(safeTxHash)
+
+console.log(transaction)

components/ApiReference/examples/aurora/-v2-safes-{address}-all-transactions--get.ts

@@ -0,0 +1,11 @@
+import SafeApiKit from '@safe-global/api-kit'
+
+const apiKit = new SafeApiKit({
+  chainId: 1313161554n
+})
+
+const transactions = await apiKit.getAllTransactions(
+  '0x5298a93734c3d979ef1f23f78ebb871879a21f22'
+)
+
+console.log(transactions)

components/ApiReference/examples/aurora/-v2-safes-{address}-multisig-transactions--get.ts

@@ -0,0 +1,11 @@
+import SafeApiKit from '@safe-global/api-kit'
+
+const apiKit = new SafeApiKit({
+  chainId: 1313161554n
+})
+
+const multisigTransactions = await apiKit.getMultisigTransactions(
+  '0x5298a93734c3d979ef1f23f78ebb871879a21f22'
+)
+
+console.log(multisigTransactions)

components/ApiReference/examples/aurora/-v2-safes-{address}-multisig-transactions--post.ts

@@ -0,0 +1,29 @@
+import SafeApiKit, { ProposeTransactionProps } from '@safe-global/api-kit'
+import { SafeTransactionData } from '@safe-global/types-kit'
+
+const apiKit = new SafeApiKit({
+  chainId: 1313161554n
+})
+
+const safeTransactionData: SafeTransactionData = {
+  to: '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045',
+  value: '50000000000000',
+  data: '0x',
+  operation: 0, // 0 = call, 1 = delegate call
+  safeTxGas: '0',
+  baseGas: '0',
+  gasPrice: '0',
+  gasToken: '0x0000000000000000000000000000000000000000',
+  refundReceiver: '0x0000000000000000000000000000000000000000',
+  nonce: '10'
+}
+
+const proposeTransactionProps: ProposeTransactionProps = {
+  safeAddress: '0x5298a93734c3d979ef1f23f78ebb871879a21f22',
+  safeTxHash: '0x897cab0528ffa8cbe10ee533e636d1a42b9e8d42f8dccb9af9006804d02d2027',
+  safeTransactionData,
+  senderAddress: '0xa6d3DEBAAB2B8093e69109f23A75501F864F74e2',
+  senderSignature: '0xec2c1cf656d997f92247ddf59f30ce718de990ec4f8d4670a37d3d3594862f0d49ad2c553daa2ff937c50d45e9ca6a815f826d29603f8c5c818cb698ddc2383a20'
+}
+
+await apiKit.proposeTransaction(proposeTransactionProps)

components/ApiReference/examples/avalanche/-v2-multisig-transactions-{safe_tx_hash}--get.ts

@@ -0,0 +1,11 @@
+import SafeApiKit from '@safe-global/api-kit'
+
+const apiKit = new SafeApiKit({
+  chainId: 43114n
+})
+
+const safeTxHash = '0x897cab0528ffa8cbe10ee533e636d1a42b9e8d42f8dccb9af9006804d02d2027'
+
+const transaction = await apiKit.getTransaction(safeTxHash)
+
+console.log(transaction)

components/ApiReference/examples/avalanche/-v2-safes-{address}-all-transactions--get.ts

@@ -0,0 +1,11 @@
+import SafeApiKit from '@safe-global/api-kit'
+
+const apiKit = new SafeApiKit({
+  chainId: 43114n
+})
+
+const transactions = await apiKit.getAllTransactions(
+  '0x5298a93734c3d979ef1f23f78ebb871879a21f22'
+)
+
+console.log(transactions)

components/ApiReference/examples/avalanche/-v2-safes-{address}-multisig-transactions--get.ts

@@ -0,0 +1,11 @@
+import SafeApiKit from '@safe-global/api-kit'
+
+const apiKit = new SafeApiKit({
+  chainId: 43114n
+})
+
+const multisigTransactions = await apiKit.getMultisigTransactions(
+  '0x5298a93734c3d979ef1f23f78ebb871879a21f22'
+)
+
+console.log(multisigTransactions)

components/ApiReference/examples/avalanche/-v2-safes-{address}-multisig-transactions--post.ts

@@ -0,0 +1,29 @@
+import SafeApiKit, { ProposeTransactionProps } from '@safe-global/api-kit'
+import { SafeTransactionData } from '@safe-global/types-kit'
+
+const apiKit = new SafeApiKit({
+  chainId: 43114n
+})
+
+const safeTransactionData: SafeTransactionData = {
+  to: '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045',
+  value: '50000000000000',
+  data: '0x',
+  operation: 0, // 0 = call, 1 = delegate call
+  safeTxGas: '0',
+  baseGas: '0',
+  gasPrice: '0',
+  gasToken: '0x0000000000000000000000000000000000000000',
+  refundReceiver: '0x0000000000000000000000000000000000000000',
+  nonce: '10'
+}
+
+const proposeTransactionProps: ProposeTransactionProps = {
+  safeAddress: '0x5298a93734c3d979ef1f23f78ebb871879a21f22',
+  safeTxHash: '0x897cab0528ffa8cbe10ee533e636d1a42b9e8d42f8dccb9af9006804d02d2027',
+  safeTransactionData,
+  senderAddress: '0xa6d3DEBAAB2B8093e69109f23A75501F864F74e2',
+  senderSignature: '0xec2c1cf656d997f92247ddf59f30ce718de990ec4f8d4670a37d3d3594862f0d49ad2c553daa2ff937c50d45e9ca6a815f826d29603f8c5c818cb698ddc2383a20'
+}
+
+await apiKit.proposeTransaction(proposeTransactionProps)

components/ApiReference/examples/base-sepolia/-v2-multisig-transactions-{safe_tx_hash}--get.ts

@@ -0,0 +1,11 @@
+import SafeApiKit from '@safe-global/api-kit'
+
+const apiKit = new SafeApiKit({
+  chainId: 84532n
+})
+
+const safeTxHash = '0x897cab0528ffa8cbe10ee533e636d1a42b9e8d42f8dccb9af9006804d02d2027'
+
+const transaction = await apiKit.getTransaction(safeTxHash)
+
+console.log(transaction)

components/ApiReference/examples/base-sepolia/-v2-safes-{address}-all-transactions--get.ts

@@ -0,0 +1,11 @@
+import SafeApiKit from '@safe-global/api-kit'
+
+const apiKit = new SafeApiKit({
+  chainId: 84532n
+})
+
+const transactions = await apiKit.getAllTransactions(
+  '0x5298a93734c3d979ef1f23f78ebb871879a21f22'
+)
+
+console.log(transactions)

components/ApiReference/examples/base-sepolia/-v2-safes-{address}-multisig-transactions--get.ts

@@ -0,0 +1,11 @@
+import SafeApiKit from '@safe-global/api-kit'
+
+const apiKit = new SafeApiKit({
+  chainId: 84532n
+})
+
+const multisigTransactions = await apiKit.getMultisigTransactions(
+  '0x5298a93734c3d979ef1f23f78ebb871879a21f22'
+)
+
+console.log(multisigTransactions)

components/ApiReference/examples/base-sepolia/-v2-safes-{address}-multisig-transactions--post.ts

@@ -0,0 +1,29 @@
+import SafeApiKit, { ProposeTransactionProps } from '@safe-global/api-kit'
+import { SafeTransactionData } from '@safe-global/types-kit'
+
+const apiKit = new SafeApiKit({
+  chainId: 84532n
+})
+
+const safeTransactionData: SafeTransactionData = {
+  to: '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045',
+  value: '50000000000000',
+  data: '0x',
+  operation: 0, // 0 = call, 1 = delegate call
+  safeTxGas: '0',
+  baseGas: '0',
+  gasPrice: '0',
+  gasToken: '0x0000000000000000000000000000000000000000',
+  refundReceiver: '0x0000000000000000000000000000000000000000',
+  nonce: '10'
+}
+
+const proposeTransactionProps: ProposeTransactionProps = {
+  safeAddress: '0x5298a93734c3d979ef1f23f78ebb871879a21f22',
+  safeTxHash: '0x897cab0528ffa8cbe10ee533e636d1a42b9e8d42f8dccb9af9006804d02d2027',
+  safeTransactionData,
+  senderAddress: '0xa6d3DEBAAB2B8093e69109f23A75501F864F74e2',
+  senderSignature: '0xec2c1cf656d997f92247ddf59f30ce718de990ec4f8d4670a37d3d3594862f0d49ad2c553daa2ff937c50d45e9ca6a815f826d29603f8c5c818cb698ddc2383a20'
+}
+
+await apiKit.proposeTransaction(proposeTransactionProps)

components/ApiReference/examples/base/-v2-multisig-transactions-{safe_tx_hash}--get.ts

@@ -0,0 +1,11 @@
+import SafeApiKit from '@safe-global/api-kit'
+
+const apiKit = new SafeApiKit({
+  chainId: 8453n
+})
+
+const safeTxHash = '0x897cab0528ffa8cbe10ee533e636d1a42b9e8d42f8dccb9af9006804d02d2027'
+
+const transaction = await apiKit.getTransaction(safeTxHash)
+
+console.log(transaction)

components/ApiReference/examples/base/-v2-safes-{address}-all-transactions--get.ts

@@ -0,0 +1,11 @@
+import SafeApiKit from '@safe-global/api-kit'
+
+const apiKit = new SafeApiKit({
+  chainId: 8453n
+})
+
+const transactions = await apiKit.getAllTransactions(
+  '0x5298a93734c3d979ef1f23f78ebb871879a21f22'
+)
+
+console.log(transactions)

components/ApiReference/examples/base/-v2-safes-{address}-multisig-transactions--get.ts

@@ -0,0 +1,11 @@
+import SafeApiKit from '@safe-global/api-kit'
+
+const apiKit = new SafeApiKit({
+  chainId: 8453n
+})
+
+const multisigTransactions = await apiKit.getMultisigTransactions(
+  '0x5298a93734c3d979ef1f23f78ebb871879a21f22'
+)
+
+console.log(multisigTransactions)

components/ApiReference/examples/base/-v2-safes-{address}-multisig-transactions--post.ts

@@ -0,0 +1,29 @@
+import SafeApiKit, { ProposeTransactionProps } from '@safe-global/api-kit'
+import { SafeTransactionData } from '@safe-global/types-kit'
+
+const apiKit = new SafeApiKit({
+  chainId: 8453n
+})
+
+const safeTransactionData: SafeTransactionData = {
+  to: '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045',
+  value: '50000000000000',
+  data: '0x',
+  operation: 0, // 0 = call, 1 = delegate call
+  safeTxGas: '0',
+  baseGas: '0',
+  gasPrice: '0',
+  gasToken: '0x0000000000000000000000000000000000000000',
+  refundReceiver: '0x0000000000000000000000000000000000000000',
+  nonce: '10'
+}
+
+const proposeTransactionProps: ProposeTransactionProps = {
+  safeAddress: '0x5298a93734c3d979ef1f23f78ebb871879a21f22',
+  safeTxHash: '0x897cab0528ffa8cbe10ee533e636d1a42b9e8d42f8dccb9af9006804d02d2027',
+  safeTransactionData,
+  senderAddress: '0xa6d3DEBAAB2B8093e69109f23A75501F864F74e2',
+  senderSignature: '0xec2c1cf656d997f92247ddf59f30ce718de990ec4f8d4670a37d3d3594862f0d49ad2c553daa2ff937c50d45e9ca6a815f826d29603f8c5c818cb698ddc2383a20'
+}
+
+await apiKit.proposeTransaction(proposeTransactionProps)

components/ApiReference/examples/blast/-v2-multisig-transactions-{safe_tx_hash}--get.ts

@@ -0,0 +1,11 @@
+import SafeApiKit from '@safe-global/api-kit'
+
+const apiKit = new SafeApiKit({
+  chainId: 81457n
+})
+
+const safeTxHash = '0x897cab0528ffa8cbe10ee533e636d1a42b9e8d42f8dccb9af9006804d02d2027'
+
+const transaction = await apiKit.getTransaction(safeTxHash)
+
+console.log(transaction)

components/ApiReference/examples/blast/-v2-safes-{address}-all-transactions--get.ts

@@ -0,0 +1,11 @@
+import SafeApiKit from '@safe-global/api-kit'
+
+const apiKit = new SafeApiKit({
+  chainId: 81457n
+})
+
+const transactions = await apiKit.getAllTransactions(
+  '0x5298a93734c3d979ef1f23f78ebb871879a21f22'
+)
+
+console.log(transactions)