Version Packages (#581)

* Docs: fix regex syntax in SDK examples (#579) * Feat extended safe info (#580) api-kit’s getSafeInfo endpoint returns way more information than our communicator’s getInfo endpoint. This causes some dapps to use the getInfo endpoint for just the readOnly flag (when running in an iframe) and then to do api-kit getSafeInfo for the nonce and other props. By returning nearly the same information from the getInfo endpoint we make developers live easier. * Version Packages --------- Co-authored-by: katspaugh <[email protected]> Co-authored-by: Daniel Dimitrov <[email protected]> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
safe-global · Jun 12, 2024 · 746f247 · 746f247
1 parent a247237
commit 746f247
Show file tree

Hide file tree

Showing 21 changed files with 98 additions and 154 deletions.
diff --git a/packages/safe-apps-sdk/CHANGELOG.md b/packages/safe-apps-sdk/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @safe-global/safe-apps-sdk
 
+## 9.1.0
+
+### Minor Changes
+
+- a811ac6: safe.getInfo() endpoint should return extended safe information similar to api-kit's getSafeInfo endpoint
+
 ## 9.0.0
 
 ### Major Changes

diff --git a/packages/safe-apps-sdk/README.md b/packages/safe-apps-sdk/README.md
@@ -54,7 +54,7 @@ type Opts = {
 };
 
 const opts: Opts = {
-  allowedDomains: [/app.safe.global$/],
+  allowedDomains: [/^app\.safe\.global$/],
   debug: false,
 };
 

diff --git a/packages/safe-apps-sdk/dist/cjs/safe/index.d.ts b/packages/safe-apps-sdk/dist/cjs/safe/index.d.ts
@@ -1,9 +1,9 @@
-import { Communicator, SafeInfo, ChainInfo, SafeBalances, GetBalanceParams, EnvironmentInfo, AddressBookItem, EIP712TypedData } from '../types/index.js';
+import { Communicator, ChainInfo, SafeBalances, GetBalanceParams, EnvironmentInfo, AddressBookItem, EIP712TypedData, SafeInfoExtended } from '../types/index.js';
 declare class Safe {
     private readonly communicator;
     constructor(communicator: Communicator);
     getChainInfo(): Promise<ChainInfo>;
-    getInfo(): Promise<SafeInfo>;
+    getInfo(): Promise<SafeInfoExtended>;
     experimental_getBalances({ currency }?: GetBalanceParams): Promise<SafeBalances>;
     private check1271Signature;
     private check1271SignatureBytes;

diff --git a/packages/safe-apps-sdk/dist/cjs/types/sdk.d.ts b/packages/safe-apps-sdk/dist/cjs/types/sdk.d.ts
@@ -61,6 +61,14 @@ export type SafeInfo = {
     owners: string[];
     isReadOnly: boolean;
 };
+export type SafeInfoExtended = SafeInfo & {
+    nonce: number;
+    implementation: string;
+    modules: string[] | null;
+    fallbackHandler: string | null;
+    guard: string | null;
+    version: string | null;
+};
 export type EnvironmentInfo = {
     origin: string;
 };

diff --git a/packages/safe-apps-sdk/dist/cjs/types/sdk.js.map b/packages/safe-apps-sdk/dist/cjs/types/sdk.js.map
diff --git a/packages/safe-apps-sdk/dist/esm/safe/index.d.ts b/packages/safe-apps-sdk/dist/esm/safe/index.d.ts
@@ -1,9 +1,9 @@
-import { Communicator, SafeInfo, ChainInfo, SafeBalances, GetBalanceParams, EnvironmentInfo, AddressBookItem, EIP712TypedData } from '../types/index.js';
+import { Communicator, ChainInfo, SafeBalances, GetBalanceParams, EnvironmentInfo, AddressBookItem, EIP712TypedData, SafeInfoExtended } from '../types/index.js';
 declare class Safe {
     private readonly communicator;
     constructor(communicator: Communicator);
     getChainInfo(): Promise<ChainInfo>;
-    getInfo(): Promise<SafeInfo>;
+    getInfo(): Promise<SafeInfoExtended>;
     experimental_getBalances({ currency }?: GetBalanceParams): Promise<SafeBalances>;
     private check1271Signature;
     private check1271SignatureBytes;

diff --git a/packages/safe-apps-sdk/dist/esm/safe/index.js.map b/packages/safe-apps-sdk/dist/esm/safe/index.js.map
diff --git a/packages/safe-apps-sdk/dist/esm/types/sdk.d.ts b/packages/safe-apps-sdk/dist/esm/types/sdk.d.ts
@@ -61,6 +61,14 @@ export type SafeInfo = {
     owners: string[];
     isReadOnly: boolean;
 };
+export type SafeInfoExtended = SafeInfo & {
+    nonce: number;
+    implementation: string;
+    modules: string[] | null;
+    fallbackHandler: string | null;
+    guard: string | null;
+    version: string | null;
+};
 export type EnvironmentInfo = {
     origin: string;
 };

diff --git a/packages/safe-apps-sdk/dist/esm/types/sdk.js.map b/packages/safe-apps-sdk/dist/esm/types/sdk.js.map
diff --git a/packages/safe-apps-sdk/dist/types/safe/index.d.ts b/packages/safe-apps-sdk/dist/types/safe/index.d.ts
@@ -1,9 +1,9 @@
-import { Communicator, SafeInfo, ChainInfo, SafeBalances, GetBalanceParams, EnvironmentInfo, AddressBookItem, EIP712TypedData } from '../types/index.js';
+import { Communicator, ChainInfo, SafeBalances, GetBalanceParams, EnvironmentInfo, AddressBookItem, EIP712TypedData, SafeInfoExtended } from '../types/index.js';
 declare class Safe {
     private readonly communicator;
     constructor(communicator: Communicator);
     getChainInfo(): Promise<ChainInfo>;
-    getInfo(): Promise<SafeInfo>;
+    getInfo(): Promise<SafeInfoExtended>;
     experimental_getBalances({ currency }?: GetBalanceParams): Promise<SafeBalances>;
     private check1271Signature;
     private check1271SignatureBytes;

diff --git a/packages/safe-apps-sdk/dist/types/safe/index.d.ts.map b/packages/safe-apps-sdk/dist/types/safe/index.d.ts.map
diff --git a/packages/safe-apps-sdk/dist/types/types/sdk.d.ts b/packages/safe-apps-sdk/dist/types/types/sdk.d.ts
@@ -61,6 +61,14 @@ export type SafeInfo = {
     owners: string[];
     isReadOnly: boolean;
 };
+export type SafeInfoExtended = SafeInfo & {
+    nonce: number;
+    implementation: string;
+    modules: string[] | null;
+    fallbackHandler: string | null;
+    guard: string | null;
+    version: string | null;
+};
 export type EnvironmentInfo = {
     origin: string;
 };