@safe-global/protocol-kit 0.1.1 → 1.0.1

package/README.md

@@ -1,6 +1,6 @@
-# Safe Core SDK
+# Protocol Kit
 
-[![NPM Version](https://badge.fury.io/js/%40safe-global%2Fsafe-core-sdk.svg)](https://badge.fury.io/js/%40safe-global%2Fsafe-core-sdk)
+[![NPM Version](https://badge.fury.io/js/%40safe-global%2Fprotocol-kit.svg)](https://badge.fury.io/js/%40safe-global%2Fprotocol-kit)
 [![GitHub Release](https://img.shields.io/github/release/safe-global/safe-core-sdk.svg?style=flat)](https://github.com/safe-global/safe-core-sdk/releases)
 [![GitHub](https://img.shields.io/github/license/safe-global/safe-core-sdk)](https://github.com/safe-global/safe-core-sdk/blob/main/LICENSE.md)
 
@@ -36,7 +36,7 @@ npm build
 
 ## <a name="getting-started">Getting Started</a>
 
-The following steps show how to set up the Safe Core SDK, deploy a new Safe, create a Safe transaction, generate the required signatures from owners and execute the transaction. However, using the Safe Core SDK alone will not allow for the collection of owner signatures off-chain. To do this and be able to see and confirm the pending transactions shown in the [Safe Web App](https://app.safe.global/), it is recommended that you follow this other [guide](/guides/integrating-the-safe-core-sdk.md) that covers the use of the Protocol Kit, combined with the API Kit.
+The following steps show how to set up the Protocol Kit, deploy a new Safe, create a Safe transaction, generate the required signatures from owners and execute the transaction. However, using the Protocol Kit alone will not allow for the collection of owner signatures off-chain. To do this and be able to see and confirm the pending transactions shown in the [Safe Web App](https://app.safe.global/), it is recommended that you follow this other [guide](/guides/integrating-the-safe-core-sdk.md) that covers the use of the Protocol Kit, combined with the API Kit.
 
 ### 1. Instantiate an EthAdapter
 
@@ -69,15 +69,15 @@ const safeAccountConfig: SafeAccountConfig = {
 const safeSdk: Safe = await safeFactory.deploySafe({ safeAccountConfig })
 ```
 
-The `deploySafe` method executes a transaction from the `owner1` account, deploys a new Safe and returns an instance of the Safe Core SDK connected to the new Safe. Check the `deploySafe` method in the [API Reference](#factory-api) for more details on additional configuration parameters and callbacks.
+The `deploySafe` method executes a transaction from the `owner1` account, deploys a new Safe and returns an instance of the Protocol Kit connected to the new Safe. Check the `deploySafe` method in the [API Reference](#factory-api) for more details on additional configuration parameters and callbacks.
 
 Call the `getAddress` method, for example, to check the address of the newly deployed Safe.
 
 ```js
-const newSafeAddress = safeSdk.getAddress()
+const newSafeAddress = await safeSdk.getAddress()
 ```
 
-To instantiate the Safe Core SDK from an existing Safe just pass to it an instance of the `EthAdapter` class and the Safe address.
+To instantiate the Protocol Kit from an existing Safe just pass to it an instance of the `EthAdapter` class and the Safe address.
 
 ```js
 import Safe from '@safe-global/protocol-kit'
@@ -202,7 +202,7 @@ const safeFactory = await SafeFactory.create({ ethAdapter })
 
 ### deploySafe
 
-Deploys a new Safe and returns an instance of the Safe Core SDK connected to the deployed Safe. The address of the Master Copy, Safe contract version and the contract (`GnosisSafe.sol` or `GnosisSafeL2.sol`) of the deployed Safe will depend on the initialization of the `safeFactory` instance.
+Deploys a new Safe and returns an instance of the Protocol Kit connected to the deployed Safe. The address of the Master Copy, Safe contract version and the contract (`GnosisSafe.sol` or `GnosisSafeL2.sol`) of the deployed Safe will depend on the initialization of the `safeFactory` instance.
 
 ```js
 const safeAccountConfig: SafeAccountConfig = {
@@ -219,7 +219,7 @@ const safeAccountConfig: SafeAccountConfig = {
 const safeSdk = await safeFactory.deploySafe({ safeAccountConfig })
 ```
 
-This method can optionally receive the `safeDeploymentConfig` parameter to define the `saltNonce`.
+This method can optionally receive the `saltNonce` parameter.
 
 ```js
 const safeAccountConfig: SafeAccountConfig = {
@@ -232,9 +232,10 @@ const safeAccountConfig: SafeAccountConfig = {
   payment, // Optional
   paymentReceiver // Optional
 }
-const safeDeploymentConfig: SafeDeploymentConfig = { saltNonce }
 
-const safeSdk = await safeFactory.deploySafe({ safeAccountConfig, safeDeploymentConfig })
+const saltNonce = '<YOUR_CUSTOM_VALUE>'
+
+const safeSdk = await safeFactory.deploySafe({ safeAccountConfig, saltNonce })
 ```
 
 Optionally, some properties can be passed as execution options:
@@ -265,7 +266,7 @@ const options: EthersTransactionOptions = {
 const safeSdk = await safeFactory.deploySafe({ safeAccountConfig, safeDeploymentConfig, options })
 ```
 
-It can also take an optional callback which receives the `txHash` of the Safe deployment transaction prior to returning a new instance of the Safe Core SDK:
+It can also take an optional callback which receives the `txHash` of the Safe deployment transaction prior to returning a new instance of the Protocol Kit:
 
 ```js
 const callback = (txHash: string): void => {
@@ -279,7 +280,9 @@ const safeSdk = await safeFactory.deploySafe({ safeAccountConfig, callback })
 
 ### create
 
-Returns an instance of the Safe Core SDK connected to the `safeAddress`.
+Returns an instance of the Protocol Kit connected to a Safe. The provided Safe must be a `safeAddress` or a `predictedSafe`.
+
+Initialization of a deployed Safe using the `safeAddress` property:
 
 ```js
 import Safe from '@safe-global/protocol-kit'
@@ -287,6 +290,19 @@ import Safe from '@safe-global/protocol-kit'
 const safeSdk = await Safe.create({ ethAdapter, safeAddress })
 ```
 
+Initialization of a not deployed Safe using the `predictedSafe` property. Because Safes are deployed in a deterministic way, passing a `predictedSafe` will allow to initialize the SDK with the Safe configuration and use it to some extent before it is deployed:
+
+```js
+import Safe, { PredictedSafeProps } from '@safe-global/protocol-kit'
+
+const predictedSafe: PredictedSafeProps = {
+  safeAccountConfig,
+  safeDeploymentConfig
+}
+
+const safeSdk = await Safe.create({ ethAdapter, predictedSafe })
+```
+
 - The `isL1SafeMasterCopy` flag
 
   There are two versions of the Safe contracts: [GnosisSafe.sol](https://github.com/safe-global/safe-contracts/blob/v1.3.0/contracts/GnosisSafe.sol) that does not trigger events in order to save gas and [GnosisSafeL2.sol](https://github.com/safe-global/safe-contracts/blob/v1.3.0/contracts/GnosisSafeL2.sol) that does, which is more appropriate for L2 networks.
@@ -329,10 +345,25 @@ const safeSdk = await Safe.create({ ethAdapter, safeAddress })
 
 ### connect
 
-Returns a new instance of the Safe Core SDK connected to the `safeAddress`.
+Returns a new instance of the Protocol Kit connected to a new Safe or a new Signer. The new connected signer can be passed via the `ethAdapter` property while the new connected Safe can be passed using a `safeAddress` or a `predictedSafe`.
+
+Connection of a deployed Safe using the `safeAddress` property:
+
+```js
+const safeSdk = await safeSdk.connect({ ethAdapter, safeAddress })
+```
+
+Connection of a not deployed Safe using the `predictedSafe` property. Because Safes are deployed in a deterministic way, passing a `predictedSafe` will allow to connect a Safe to the SDK with the Safe configuration:
 
 ```js
-const safeSdk2 = await safeSdk.connect({ ethAdapter, safeAddress })
+import { PredictedSafeProps } from '@safe-global/protocol-kit'
+
+const predictedSafe: PredictedSafeProps = {
+  safeAccountConfig,
+  safeDeploymentConfig
+}
+
+const safeSdk = await safeSdk.connect({ ethAdapter, predictedSafe })
 ```
 
 - The `isL1SafeMasterCopy` flag
@@ -379,7 +410,7 @@ const safeSdk2 = await safeSdk.connect({ ethAdapter, safeAddress })
 Returns the address of the current SafeProxy contract.
 
 ```js
-const safeAddress = safeSdk.getAddress()
+const safeAddress = await safeSdk.getAddress()
 ```
 
 ### getContractVersion
@@ -464,7 +495,7 @@ const isOwner = await safeSdk.isOwner(address)
 
 ### createTransaction
 
-Returns a Safe transaction ready to be signed by the owners and executed. The Safe Core SDK supports the creation of single Safe transactions but also MultiSend transactions.
+Returns a Safe transaction ready to be signed by the owners and executed. The Protocol Kit supports the creation of single Safe transactions but also MultiSend transactions.
 
 - **Single transactions**
 

package/dist/src/Safe.d.ts

@@ -1,66 +1,20 @@
 import { BigNumber } from '@ethersproject/bignumber';
-import { EthAdapter, MetaTransactionData, SafeMultisigTransactionResponse, SafeTransaction, SafeTransactionDataPartial, SafeVersion, TransactionOptions, TransactionResult } from '@safe-global/safe-core-sdk-types';
+import { EthAdapter, SafeMultisigTransactionResponse, SafeSignature, SafeTransaction, SafeVersion, TransactionOptions, TransactionResult } from '@safe-global/safe-core-sdk-types';
 import ContractManager from './managers/contractManager';
-import { ContractNetworksConfig } from './types';
-import SafeSignature from './utils/signatures/SafeSignature';
+import { AddOwnerTxParams, ConnectSafeConfig, CreateTransactionProps, RemoveOwnerTxParams, SafeConfig, SwapOwnerTxParams } from './types';
 import { SafeTransactionOptionalProps } from './utils/transactions/types';
-export interface SafeConfig {
-    /** ethAdapter - Ethereum adapter */
-    ethAdapter: EthAdapter;
-    /** safeAddress - The address of the Safe account to use */
-    safeAddress: string;
-    /** isL1SafeMasterCopy - Forces to use the GnosisSafe L1 version of the contract instead of the L2 version */
-    isL1SafeMasterCopy?: boolean;
-    /** contractNetworks - Contract network configuration */
-    contractNetworks?: ContractNetworksConfig;
-}
-export interface ConnectSafeConfig {
-    /** ethAdapter - Ethereum adapter */
-    ethAdapter?: EthAdapter;
-    /** safeAddress - The address of the Safe account to use */
-    safeAddress?: string;
-    /** isL1SafeMasterCopy - Forces to use the GnosisSafe L1 version of the contract instead of the L2 version */
-    isL1SafeMasterCopy?: boolean;
-    /** contractNetworks - Contract network configuration */
-    contractNetworks?: ContractNetworksConfig;
-}
-export interface CreateTransactionProps {
-    /** safeTransactionData - The transaction or transaction array to process */
-    safeTransactionData: SafeTransactionDataPartial | MetaTransactionData[];
-    /** options - The transaction array optional properties */
-    options?: SafeTransactionOptionalProps;
-    /** onlyCalls - Forces the execution of the transaction array with MultiSendCallOnly contract */
-    onlyCalls?: boolean;
-}
-export interface AddOwnerTxParams {
-    /** ownerAddress - The address of the new owner */
-    ownerAddress: string;
-    /** threshold - The new threshold */
-    threshold?: number;
-}
-export interface RemoveOwnerTxParams {
-    /** ownerAddress - The address of the owner that will be removed */
-    ownerAddress: string;
-    /** threshold - The new threshold */
-    threshold?: number;
-}
-export interface SwapOwnerTxParams {
-    /** oldOwnerAddress - The old owner address */
-    oldOwnerAddress: string;
-    /** newOwnerAddress - The new owner address */
-    newOwnerAddress: string;
-}
 declare class Safe {
     #private;
     /**
      * Creates an instance of the Safe Core SDK.
      * @param config - Ethers Safe configuration
      * @returns The Safe Core SDK instance
+     * @throws "The SDK must be initialized with a safeAddress or a predictedSafe"
      * @throws "SafeProxy contract is not deployed on the current network"
      * @throws "MultiSend contract is not deployed on the current network"
      * @throws "MultiSendCallOnly contract is not deployed on the current network"
      */
-    static create({ ethAdapter, safeAddress, isL1SafeMasterCopy, contractNetworks }: SafeConfig): Promise<Safe>;
+    static create(config: SafeConfig): Promise<Safe>;
     /**
      * Initializes the Safe Core SDK instance.
      * @param config - Safe configuration
@@ -73,17 +27,18 @@ declare class Safe {
     /**
      * Returns a new instance of the Safe Core SDK.
      * @param config - Connect Safe configuration
+     * @throws "A safeAddress and a predictedSafe cannot be connected at the same time"
      * @throws "SafeProxy contract is not deployed on the current network"
      * @throws "MultiSend contract is not deployed on the current network"
      * @throws "MultiSendCallOnly contract is not deployed on the current network"
      */
-    connect({ ethAdapter, safeAddress, isL1SafeMasterCopy, contractNetworks }: ConnectSafeConfig): Promise<Safe>;
+    connect(config: ConnectSafeConfig): Promise<Safe>;
     /**
      * Returns the address of the current SafeProxy contract.
      *
      * @returns The address of the SafeProxy contract
      */
-    getAddress(): string;
+    getAddress(): Promise<string>;
     /**
      * Returns the ContractManager
      *
@@ -108,6 +63,12 @@ declare class Safe {
      * @returns The address of the MultiSendCallOnly contract
      */
     getMultiSendCallOnlyAddress(): string;
+    /**
+     * Checks if the current Safe is deployed.
+     *
+     * @returns TRUE if the Safe contract is deployed
+     */
+    isSafeDeployed(): Promise<boolean>;
     /**
      * Returns the Safe Master Copy contract version.
      *