protocol-kit v2.0

[DaniSomoza]

Protocol Kit v2.0

Changes reflecting the updates here

New packages versions

• @safe-global/[email protected]
• @safe-global/[email protected]
• @safe-global/[email protected]
• @safe-global/[email protected]
• @safe-global/[email protected]

⚠️ Breaking Changes

api-kit

• SafeApiKit instantiation

// old:
constructor({ txServiceUrl, ethAdapter }: SafeApiKitConfig)

// new:
constructor({ chainId, txServiceUrl? }: SafeApiKitConfig)

• '/api' is not added to the txServiceUrl prop
• Rename type MasterCopyResponse to SafeSingletonResponse
• Rename method getServiceMasterCopiesInfo() to getServiceSingletonsInfo()

protocol-kit

• Rename isL1SafeMasterCopy to isL1SafeSingleton

// old:
SafeFactory.create({ ethAdapter, isL1SafeMasterCopy: true })

// new:
SafeFactory.create({ ethAdapter, isL1SafeSingleton: true })

• EthersAdapter now it's only compatible with ethers v6.
• createTransaction now only accepts array of transactions

// old:
const safeTransactionData = {
  to: '',
 data: '',
 value: '',
  nonce: '',
  safeTxGas: ''
}
const safeTransaction = protocolKit.createTransaction({ safeTransactionData })

// new:
const safeTransactionData = {
  to: '',
 data: '',
 value: ''
}
const options = {
  nonce: '',
  safeTxGas: ''
}
const safeTransaction = protocolKit.createTransaction({ [safeTransactionData], options })

relay-kit

• The GelatoRelayPack constructor now includes a mandatory protocolKit parameter as we made it required for any new pack extending the RelayKitBasePack

constructor({ apiKey, protocolKit }: GelatoOptions)

• We removed the protocolKit parameter from the createTransactionWithHandlePayment(), createTransactionWithTransfer() and executeRelayTransaction() methods in the GelatoRelayPack as we now include it in the constructor

• Removed the type export interface RelayPack as we use now an abstract class

[github-actions]

Overall readability score: 70.84 (🔴 -1.15)

File	Readability
README.md	64.95 (🟢 +0.61)
v2.md	62.94 (-)
README.md	75.08 (🔴 -0.5)
Web3AuthModalPack.md	60.27 (🟢 +0)
MoneriumPack.md	72.36 (🟢 +0.13)
README.md	77.81 (🟢 +0)
README.md	72.22 (🟢 +1)
v2.md	70.21 (-)
README.md	74.32 (🟢 +2.44)
gelato.md	75.06 (🟢 +0)
v2.md	20.34 (-)
SUMMARY.md	100 (🟢 +0)

View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File	Readability	FRE	GF	ARI	CLI	DCRS
README.md	64.95	54.73	10.4	10.3	10.55	7.19
	🟢 +0.61	🟢 +0.61	🟢 +0.13	🟢 +0.2	🔴 -0.05	🟢 +0.02
v2.md	62.94	48.6	11.03	9.5	10.72	7.45
	-	-	-	-	-	-
README.md	75.08	53.07	6.89	8.7	11.57	6.1
	🔴 -0.5	🟢 +0.1	🔴 -0.13	🟢 +0	🔴 -0.05	🔴 -0.07
Web3AuthModalPack.md	60.27	47.89	9.61	11.7	13.04	6.99
	🟢 +0	🟢 +0	🟢 +0	🟢 +0	🟢 +0	🟢 +0
MoneriumPack.md	72.36	56.15	8.64	9.4	10.08	6.51
	🟢 +0.13	🟢 +0	🟢 +0.04	🟢 +0	🟢 +0	🟢 +0.02
README.md	77.81	73.98	8.24	8.2	8.98	6.97
	🟢 +0	🟢 +0	🟢 +0	🟢 +0	🟢 +0	🟢 +0
README.md	72.22	57.98	8.59	9.2	10.43	6.61
	🟢 +1	🟢 +0.71	🟢 +0.23	🟢 +0.2	🟢 +0.12	🟢 +0.01
v2.md	70.21	58.89	10.62	7.2	8.57	7.92
	-	-	-	-	-	-
README.md	74.32	49.62	7.28	9.7	11.18	5.67
	🟢 +2.44	🟢 +0.31	🟢 +0.36	🟢 +0.4	🟢 +0.64	🟢 +0.09
gelato.md	75.06	64	8.63	9	9.51	6.51
	🟢 +0	🟢 +0	🟢 +0	🟢 +0	🟢 +0	🟢 +0
v2.md	20.34	0	14.74	17.3	19	9.07
	-	-	-	-	-	-
SUMMARY.md	100	100	6	6	6	4.9
	🟢 +0	🟢 +0	🟢 +0	🟢 +0	🟢 +0	🟢 +0

Averages:

	Readability	FRE	GF	ARI	CLI	DCRS
Average	70.84	62.46	9.14	9.45	10.2	6.97
	🔴 -1.15	🔴 -1.63	🔴 -0.17	🔴 -0.1	🔴 -0.15	🔴 -0.07

View metric targets

Metric	Range	Ideal score
Flesch Reading Ease	100 (very easy read) to 0 (extremely difficult read)	60
Gunning Fog	6 (very easy read) to 17 (extremely difficult read)	8 or less
Auto. Read. Index	6 (very easy read) to 14 (extremely difficult read)	8 or less
Coleman Liau Index	6 (very easy read) to 17 (extremely difficult read)	8 or less
Dale-Chall Readability	4.9 (very easy read) to 9.9 (extremely difficult read)	6.9 or less

[tanay1337]

Two additional thoughts:

• We should probably move the migration docs under the respective reference folders of the kits.
• You'd need to reference the new pages in summary.md so that they are added by GitBook and displayed on the sidebar.