10576344308

Committed 27 Aug 2024 10:26AM UTC coverage: 77.534% (-0.5%) from 78.033%

Build # 10576344308

Build Type

Pull #958

github

Committed by

web-flow

Commit Message

Merge 66d1b3132 into a9e595af1

Pull Request Pull Request #958: chore: prepare release

Run Details

261 of 410 branches covered (63.66%)

Branch coverage included in aggregate %.

70 of 90 new or added lines in 10 files covered. (77.78%)

5 existing lines in 1 file now uncovered.

978 of 1188 relevant lines covered (82.32%)

3.49 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

20.0

/packages/sdk-starter-kit/src/BaseClient.ts

import Safe, {
  AddOwnerTxParams,
  RemoveOwnerTxParams,
  SwapOwnerTxParams
} from '@safe-global/protocol-kit'
import SafeApiKit from '@safe-global/api-kit'
import { SafeTransaction, TransactionBase } from '@safe-global/safe-core-sdk-types'

import { ChangeThresholdTxParams } from './types'

export class BaseClient {
  protocolKit: Safe
  apiKit: SafeApiKit

  constructor(protocolKit: Safe, apiKit: SafeApiKit) {
    this.protocolKit = protocolKit
    this.apiKit = apiKit
  }

  /**
   * Returns the Safe address.
   *
   * @returns {string} The Safe address
   */
  async getAddress(): Promise<string> {
    return this.protocolKit.getAddress()
  }

  /**
   * Checks if the current Safe is deployed.
   *
   * @returns {boolean} if the Safe contract is deployed
   */
  async isDeployed(): Promise<boolean> {
    return this.protocolKit.isSafeDeployed()
  }

  /**
   * Checks if a specific address is an owner of the current Safe.
   *
   * @param {string} ownerAddress - The account address
   * @returns {boolean} TRUE if the account is an owner
   */
  async isOwner(ownerAddress: string): Promise<boolean> {
    return this.protocolKit.isOwner(ownerAddress)
  }

  /**
   * Returns the list of Safe owner accounts.
   *
   * @returns The list of owners
   */
  async getOwners(): Promise<string[]> {
    return this.protocolKit.getOwners()
  }

  /**
   * Returns the Safe threshold.
   *
   * @returns {number} The Safe threshold
   */
  async getThreshold(): Promise<number> {
    return this.protocolKit.getThreshold()
  }

  /**
   * Returns the Safe nonce.
   *
   * @returns {number} The Safe nonce
   */
  async getNonce(): Promise<number> {
    return this.protocolKit.getNonce()
  }

  /**
   * Returns a list of owners who have approved a specific Safe transaction.
   *
   * @param {string} txHash - The Safe transaction hash
   * @returns {string[]} The list of owners
   */
  async getOwnersWhoApprovedTx(txHash: string): Promise<string[]> {
    return this.protocolKit.getOwnersWhoApprovedTx(txHash)
  }

  /**
   * Encodes the data for adding a new owner to the Safe.
   *
   * @param {AddOwnerTxParams} addOwnerParams - The parameters for adding a new owner
   * @returns {TransactionBase} The encoded data
   */
  async createAddOwnerTransaction(addOwnerParams: AddOwnerTxParams): Promise<TransactionBase> {
    const addOwnerTransaction = await this.protocolKit.createAddOwnerTx(addOwnerParams)

    return this.#buildTransaction(addOwnerTransaction)
  }

  /**
   * Encodes the data for removing an owner from the Safe.
   *
   * @param {RemoveOwnerTxParams} removeOwnerParams - The parameters for removing an owner
   * @returns {TransactionBase} The encoded data
   */
  async createRemoveOwnerTransaction(
    removeOwnerParams: RemoveOwnerTxParams
  ): Promise<TransactionBase> {
    const removeOwnerTransaction = await this.protocolKit.createRemoveOwnerTx(removeOwnerParams)

    return this.#buildTransaction(removeOwnerTransaction)
  }

  /**
   * Encodes the data for swapping an owner in the Safe.
   *
   * @param {SwapOwnerTxParams} swapParams - The parameters for swapping an owner
   * @returns {TransactionBase} The encoded data
   */
  async createSwapOwnerTransaction(swapParams: SwapOwnerTxParams): Promise<TransactionBase> {
    const swapOwnerTransaction = await this.protocolKit.createSwapOwnerTx(swapParams)

    return this.#buildTransaction(swapOwnerTransaction)
  }

  /**
   * Encodes the data for changing the Safe threshold.
   *
   * @param {ChangeThresholdTxParams} changeThresholdParams - The parameters for changing the Safe threshold
   * @returns {TransactionBase} The encoded data
   */
  async createChangeThresholdTransaction(
    changeThresholdParams: ChangeThresholdTxParams
  ): Promise<TransactionBase> {
    const changeThresholdTransaction = await this.protocolKit.createChangeThresholdTx(
      changeThresholdParams.threshold
    )

    return this.#buildTransaction(changeThresholdTransaction)
  }

  async #buildTransaction(safeTransaction: SafeTransaction): Promise<TransactionBase> {
    return {
      to: safeTransaction.data.to,
      value: safeTransaction.data.value,
      data: safeTransaction.data.data
    }
  }
}

1	import Safe, {
2	AddOwnerTxParams,
3	RemoveOwnerTxParams,
4	SwapOwnerTxParams
5	} from '@safe-global/protocol-kit'
6	import SafeApiKit from '@safe-global/api-kit'
7	import { SafeTransaction, TransactionBase } from '@safe-global/safe-core-sdk-types'
8
9	import { ChangeThresholdTxParams } from './types'
10
11	export class BaseClient {	4✔
12	protocolKit: Safe
13	apiKit: SafeApiKit
14
15	constructor(protocolKit: Safe, apiKit: SafeApiKit) {
16	this.protocolKit = protocolKit	12✔
17	this.apiKit = apiKit	12✔
18	}
19
20	/**
21	* Returns the Safe address.
22	*
23	* @returns {string} The Safe address
24	*/
25	async getAddress(): Promise<string> {
NEW 26	return this.protocolKit.getAddress()	×
27	}
28
29	/**
30	* Checks if the current Safe is deployed.
31	*
32	* @returns {boolean} if the Safe contract is deployed
33	*/
34	async isDeployed(): Promise<boolean> {
NEW 35	return this.protocolKit.isSafeDeployed()	×
36	}
37
38	/**
39	* Checks if a specific address is an owner of the current Safe.
40	*
41	* @param {string} ownerAddress - The account address
42	* @returns {boolean} TRUE if the account is an owner
43	*/
44	async isOwner(ownerAddress: string): Promise<boolean> {
NEW 45	return this.protocolKit.isOwner(ownerAddress)	×
46	}
47
48	/**
49	* Returns the list of Safe owner accounts.
50	*
51	* @returns The list of owners
52	*/
53	async getOwners(): Promise<string[]> {
NEW 54	return this.protocolKit.getOwners()	×
55	}
56
57	/**
58	* Returns the Safe threshold.
59	*
60	* @returns {number} The Safe threshold
61	*/
62	async getThreshold(): Promise<number> {
NEW 63	return this.protocolKit.getThreshold()	×
64	}
65
66	/**
67	* Returns the Safe nonce.
68	*
69	* @returns {number} The Safe nonce
70	*/
71	async getNonce(): Promise<number> {
NEW 72	return this.protocolKit.getNonce()	×
73	}
74
75	/**
76	* Returns a list of owners who have approved a specific Safe transaction.
77	*
78	* @param {string} txHash - The Safe transaction hash
79	* @returns {string[]} The list of owners
80	*/
81	async getOwnersWhoApprovedTx(txHash: string): Promise<string[]> {
NEW 82	return this.protocolKit.getOwnersWhoApprovedTx(txHash)	×
83	}
84
85	/**
86	* Encodes the data for adding a new owner to the Safe.
87	*
88	* @param {AddOwnerTxParams} addOwnerParams - The parameters for adding a new owner
89	* @returns {TransactionBase} The encoded data
90	*/
91	async createAddOwnerTransaction(addOwnerParams: AddOwnerTxParams): Promise<TransactionBase> {
NEW 92	const addOwnerTransaction = await this.protocolKit.createAddOwnerTx(addOwnerParams)	×
93
NEW 94	return this.#buildTransaction(addOwnerTransaction)	×
95	}
96
97	/**
98	* Encodes the data for removing an owner from the Safe.
99	*
100	* @param {RemoveOwnerTxParams} removeOwnerParams - The parameters for removing an owner
101	* @returns {TransactionBase} The encoded data
102	*/
103	async createRemoveOwnerTransaction(
104	removeOwnerParams: RemoveOwnerTxParams
105	): Promise<TransactionBase> {
NEW 106	const removeOwnerTransaction = await this.protocolKit.createRemoveOwnerTx(removeOwnerParams)	×
107
NEW 108	return this.#buildTransaction(removeOwnerTransaction)	×
109	}
110
111	/**
112	* Encodes the data for swapping an owner in the Safe.
113	*
114	* @param {SwapOwnerTxParams} swapParams - The parameters for swapping an owner
115	* @returns {TransactionBase} The encoded data
116	*/
117	async createSwapOwnerTransaction(swapParams: SwapOwnerTxParams): Promise<TransactionBase> {
NEW 118	const swapOwnerTransaction = await this.protocolKit.createSwapOwnerTx(swapParams)	×
119
NEW 120	return this.#buildTransaction(swapOwnerTransaction)	×
121	}
122
123	/**
124	* Encodes the data for changing the Safe threshold.
125	*
126	* @param {ChangeThresholdTxParams} changeThresholdParams - The parameters for changing the Safe threshold
127	* @returns {TransactionBase} The encoded data
128	*/
129	async createChangeThresholdTransaction(
130	changeThresholdParams: ChangeThresholdTxParams
131	): Promise<TransactionBase> {
NEW 132	const changeThresholdTransaction = await this.protocolKit.createChangeThresholdTx(	×
133	changeThresholdParams.threshold
134	)
135
NEW 136	return this.#buildTransaction(changeThresholdTransaction)	×
137	}
138
139	async #buildTransaction(safeTransaction: SafeTransaction): Promise<TransactionBase> {	4✔
NEW 140	return {	×
141	to: safeTransaction.data.to,
142	value: safeTransaction.data.value,
143	data: safeTransaction.data.data
144	}
145	}
146	}

safe-global / safe-core-sdk / 10576344308

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous