11029255652

Committed 25 Sep 2024 08:18AM CUT coverage: 77.534%. Remained the same

Build # 11029255652

Build Type

push

github

Committed by

dasanra

Commit Message

chore: set release versions

Run Details

261 of 410 branches covered (63.66%)

Branch coverage included in aggregate %.

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

62.5

/packages/sdk-starter-kit/src/extensions/messages/offChainMessages.ts

import { ListOptions, SafeMessageListResponse } from '@safe-global/api-kit'

import { SafeClient } from '@safe-global/sdk-starter-kit/SafeClient'
import { SafeMessageClient } from '@safe-global/sdk-starter-kit/extensions/messages/SafeMessageClient'
import {
  ConfirmOffChainMessageProps,
  SafeClientResult,
  SendOffChainMessageProps
} from '@safe-global/sdk-starter-kit/types'

/**
 * Extend the SafeClient with the ability to use off-chain messages
 *
 * @example
 * const safeClient = await createSafeClient({ ... })
 *
 * const safeMessagesClient = await safeClient.extend(
 *   offChainMessages()
 * )
 *
 * const { messages } = await safeMessagesClient.sendOffChainMessage({ message })
 * await safeMessagesClient.confirmOffChainMessage({ messageHash: messages?.messageHash})
 */
export function offChainMessages() {
  return (client: SafeClient) => {
    const safeMessageClient = new SafeMessageClient(client.protocolKit, client.apiKit)

    return {
      /**
       * Creates an off-chain message using the Transaction service
       *
       * @param {SendOffChainMessageProps} props The message properties
       * @returns {Promise<SafeClientResult>} A SafeClientResult. You can get the messageHash to confirmMessage() afterwards from the messages property       */
      async sendOffChainMessage(props: SendOffChainMessageProps): Promise<SafeClientResult> {
        return safeMessageClient.sendMessage(props)
      },
      /**
       * Confirms an off-chain message using the Transaction service
       *
       * @param {ConfirmOffChainMessageProps} props The confirmation properties
       * @returns {Promise<SafeClientResult>} A SafeClientResult with the result of the confirmation
       */
      async confirmOffChainMessage(props: ConfirmOffChainMessageProps): Promise<SafeClientResult> {
        return safeMessageClient.confirmMessage(props)
      },
      /**
       * Get the list of pending off-chain messages. This messages can be confirmed using the confirmMessage() method
       *
       * @param {ListOptions} options The pagination options
       * @returns {Promise<SafeMessageListResponse>} A list of pending messages
       */
      async getPendingOffChainMessages(options?: ListOptions): Promise<SafeMessageListResponse> {
        return safeMessageClient.getPendingMessages(options)
      }
    }
  }
}

1	import { ListOptions, SafeMessageListResponse } from '@safe-global/api-kit'
2
3	import { SafeClient } from '@safe-global/sdk-starter-kit/SafeClient'
4	import { SafeMessageClient } from '@safe-global/sdk-starter-kit/extensions/messages/SafeMessageClient'	1✔
5	import {
6	ConfirmOffChainMessageProps,
7	SafeClientResult,
8	SendOffChainMessageProps
9	} from '@safe-global/sdk-starter-kit/types'
10
11	/**
12	* Extend the SafeClient with the ability to use off-chain messages
13	*
14	* @example
15	* const safeClient = await createSafeClient({ ... })
16	*
17	* const safeMessagesClient = await safeClient.extend(
18	* offChainMessages()
19	* )
20	*
21	* const { messages } = await safeMessagesClient.sendOffChainMessage({ message })
22	* await safeMessagesClient.confirmOffChainMessage({ messageHash: messages?.messageHash})
23	*/
24	export function offChainMessages() {	1✔
25	return (client: SafeClient) => {	1✔
26	const safeMessageClient = new SafeMessageClient(client.protocolKit, client.apiKit)	1✔
27
28	return {	1✔
29	/**
30	* Creates an off-chain message using the Transaction service
31	*
32	* @param {SendOffChainMessageProps} props The message properties
33	* @returns {Promise<SafeClientResult>} A SafeClientResult. You can get the messageHash to confirmMessage() afterwards from the messages property */
34	async sendOffChainMessage(props: SendOffChainMessageProps): Promise<SafeClientResult> {
35	return safeMessageClient.sendMessage(props)	×
36	},
37	/**
38	* Confirms an off-chain message using the Transaction service
39	*
40	* @param {ConfirmOffChainMessageProps} props The confirmation properties
41	* @returns {Promise<SafeClientResult>} A SafeClientResult with the result of the confirmation
42	*/
43	async confirmOffChainMessage(props: ConfirmOffChainMessageProps): Promise<SafeClientResult> {
44	return safeMessageClient.confirmMessage(props)	×
45	},
46	/**
47	* Get the list of pending off-chain messages. This messages can be confirmed using the confirmMessage() method
48	*
49	* @param {ListOptions} options The pagination options
50	* @returns {Promise<SafeMessageListResponse>} A list of pending messages
51	*/
52	async getPendingOffChainMessages(options?: ListOptions): Promise<SafeMessageListResponse> {
53	return safeMessageClient.getPendingMessages(options)	×
54	}
55	}
56	}
57	}

safe-global / safe-core-sdk / 11029255652

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