chore: rename sdk-common-utils to sdk-common-utilities (#16)

* chore: rename sdk-common-utils to sdk-common-utilities
* chore: add changeset
* docs: update readMe

.changeset/nice-melons-cross.md

@@ -0,0 +1,5 @@
+---
+"@paperxyz/embedded-wallet-service-sdk": patch
+---
+
+chore: update internal dependency

README.md

@@ -26,9 +26,10 @@ The topics we'll be covering:
 ### Installation
 
 - `git clone` the repository
+- `git submodule update --init --recursive` to clone `paper-web` (to be confirmed)
+- Go through `paper-web` ReadMe to complete the set-up
 - Run `yarn` at the top level of the repository
 - Initialize the packages with `yarn build --filter=./packages/*`
-- Go through `paper-web` ReadMe to complete the set-up
 
 ### To start developing
 
@@ -61,9 +62,9 @@ This monorepo currently includes the following packages and applications:
 
 - `apps/paper-web`: Main web app, linked to our private repo via git submodules
 - `examples/embedded-wallet-service-sdk-demo-app`: Demo app using Paper's embedded wallet service SDK
-- `packages/@paperxyz/embedded-wallet-service-sdk`: Client facing embedded wallet service SDK
-- `packages/@paperxyz/sdk-common-utils`: Shared React utilities
-- `packages/@paperxyz/tsconfig`: Shared `tsconfig.json`s used throughout the monorepo
+- `packages/@paperxyz/embedded-wallet-service-sdk` (published): Client facing embedded wallet service SDK
+- `packages/@paperxyz/sdk-common-utilities`(published): Shared SDK utilities. Mostly typing and common functions.
+- `packages/@paperxyz/tsconfig`: Shared `tsconfig.json` used throughout the monorepo
 - `packages/eslint-config-paperxyz`: ESLint preset
 
 ## Making Changes
@@ -95,7 +96,7 @@ If you're simply making changes to the example repository, you should see someth
 
 ![regular release preview](https://user-images.githubusercontent.com/44563205/227390338-4ad76489-0d95-4c62-b4c0-d895836fbe0a.png)
 
-If you are making changes to the packages itself and things need to be updated, you'll need to create a `changeset`.
+If you are making changes to the folders in `/packages` itself and it's published (see the [repository layout](#repository-layout) section), you'll need to create a `changeset` in order to have it published to NPM.
 
 We use [Changesets](https://github.com/changesets/changesets) to manage versions, create changelogs, and publish to npm.
 

packages/embedded-wallet-service-sdk/package.json

@@ -44,7 +44,7 @@
     "@ethersproject/bytes": "^5.7.0",
     "@ethersproject/properties": "^5.7.0",
     "@ethersproject/providers": "^5.7.2",
-    "@paperxyz/sdk-common-utils": "*"
+    "@paperxyz/sdk-common-utilities": "*"
   },
   "publishConfig": {
     "access": "public"

packages/embedded-wallet-service-sdk/src/interfaces/EmbeddedWallets/EmbeddedWallets.ts

@@ -1,7 +1,7 @@
 import type {
   Chain,
   CustomizationOptionsType,
-} from "@paperxyz/sdk-common-utils";
+} from "@paperxyz/sdk-common-utilities";
 import type { EmbeddedWallet } from "../../lib/EmbeddedWallets/EmbeddedWallet";
 import type { EmbeddedWalletIframeCommunicator } from "../../utils/iFrameCommunication/EmbeddedWalletIframeCommunicator";
 

packages/embedded-wallet-service-sdk/src/interfaces/EmbeddedWallets/WalletHoldings.ts

@@ -1,4 +1,4 @@
-import type { Chain } from "@paperxyz/sdk-common-utils";
+import type { Chain } from "@paperxyz/sdk-common-utilities";
 
 export type WalletHoldingInputType = {
   chain: Chain;

packages/embedded-wallet-service-sdk/src/lib/EmbeddedWallets/EmbeddedWallet.ts

@@ -1,7 +1,7 @@
 import type { Networkish } from "@ethersproject/providers";
 import { getDefaultProvider } from "@ethersproject/providers";
-import type { Chain } from "@paperxyz/sdk-common-utils";
-import { ChainToPublicRpc } from "@paperxyz/sdk-common-utils";
+import type { Chain } from "@paperxyz/sdk-common-utilities";
+import { ChainToPublicRpc } from "@paperxyz/sdk-common-utilities";
 import type {
   ClientIdWithQuerierAndChainType,
   GetUserWalletStatusFnReturnType,

packages/embedded-wallet-service-sdk/src/lib/EmbeddedWallets/GaslessTransactionMaker.ts

@@ -1,4 +1,4 @@
-import type { Chain } from "@paperxyz/sdk-common-utils";
+import type { Chain } from "@paperxyz/sdk-common-utilities";
 import type { ClientIdWithQuerierAndChainType } from "../../interfaces/EmbeddedWallets/EmbeddedWallets";
 import type {
   CallContractReturnType,

packages/embedded-wallet-service-sdk/src/lib/EmbeddedWallets/WalletHoldings.ts

@@ -1,4 +1,4 @@
-import type { Chain } from "@paperxyz/sdk-common-utils";
+import type { Chain } from "@paperxyz/sdk-common-utilities";
 import type { ClientIdWithQuerierAndChainType } from "../../interfaces/EmbeddedWallets/EmbeddedWallets";
 import type {
   WalletHoldingInputType,

packages/embedded-wallet-service-sdk/src/utils/iFrameCommunication/EmbeddedWalletIframeCommunicator.ts

@@ -1,5 +1,5 @@
-import type { CustomizationOptionsType } from "@paperxyz/sdk-common-utils";
-import { getPaperOriginUrl } from "@paperxyz/sdk-common-utils";
+import type { CustomizationOptionsType } from "@paperxyz/sdk-common-utilities";
+import { getPaperOriginUrl } from "@paperxyz/sdk-common-utilities";
 import { EMBEDDED_WALLET_PATH } from "../../constants/settings";
 import { LocalStorage } from "../Storage/LocalStorage";
 import { IframeCommunicator } from "./IframeCommunicator";

packages/embedded-wallet-service-sdk/src/utils/iFrameCommunication/IframeCommunicator.ts

@@ -1,5 +1,5 @@
-import type { MessageType, StyleObject } from "@paperxyz/sdk-common-utils";
-import { getPaperOriginUrl } from "@paperxyz/sdk-common-utils";
+import type { MessageType, StyleObject } from "@paperxyz/sdk-common-utilities";
+import { getPaperOriginUrl } from "@paperxyz/sdk-common-utilities";
 import { EMBEDDED_WALLET_PATH } from "../../constants/settings";
 
 type IFrameCommunicatorProps = {

packages/sdk-common-utils/package.json → packages/sdk-common-utilities/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@paperxyz/sdk-common-utils",
+  "name": "@paperxyz/sdk-common-utilities",
   "description": "Internal utilities for Paper's internal SDK",
   "version": "0.0.0",
   "license": "Apache-2.0",