🔄 synced file(s) with circlefin/w3s-ios-sample-app-wallets-internal (#3)

README.md

@@ -1,15 +1,37 @@
-# w3s-ios-sample-app-wallets
+# Web3 Wallet Address Generator
 
-This is a sample project for iOS beginners to integrate with CircleProgrammableWalletSDK
+Welcome to the Web3 Wallet Address Generator repository! This sample iOS app provides developers with foundation for creating web3 wallet addresses after a user has completed a social sign-in through Apple or Google. 
 
-- Bookmark
-  - [Requirements](#requirements)
-  - [Installation](#installation)
-  - [Run the project](#run-the-project)
----
+### Overview
+
+The Web3 Wallet Address Generator demonstrates the integration of social sign-in functionality with web3 wallet address generation in an iOS app. It leverages the authentication capabilities provided by Google and Apple, enabling users to seamlessly login to the app using their Apple or Google accounts. Upon successful authentication, the app generates a web3 wallet address for the user, which can be used to securely store and manage digital assets or currencies such as USDC on the blockchain. 
+
+### Key Features
+* Deploy, embed, and manage wallet transactions in your app with REST API
+* Advanced security through Multi-Party Computation(MPC) technology, ensuring enhanced protection of user assets and reducing single points of failure
+* Flexible custody models allowing developers to choose between user-controlled wallets or developer-controlled wallets based on the needs
+* Currently supports Ethereum, Polygon, and Avalanche, with other chains coming soon
+
+## Get Support
+
+If you have questions, comments, or need help with code, we're here to help:
+
+* on [Discord](https://discord.com/invite/buildoncircle)
+* on Twitter at [@BuildOnCircle](https://twitter.com/BuildOnCircle)
+
+Check out our [developer docs](https://developers.circle.com/w3s/docs).
 
 ## Requirements
 
+### Circle Developer Account
+Sign up for the Circle Developer account here:https://console.circle.com/signup.
+
+Within the Circle Developer account, you can create and update API Keys, subscribe for activity notifications, view your API logs and more! Anyone can sign up for a Circle Developer account within minutes. All you need is your name, email and password!
+
+### Test Server
+Setup a developer server in order to simulate the initialization and creation of wallets by cloning our [repo](https://github.com/circle-ccooper/circle-programmable-wallet-test-server) and following provided instructions.
+<img src="readme_images/sdk_architecture.png" width="800"/>
+
 ### Xcode
 Install Apple’s Xcode development software: [Xcode in the Apple App Store](https://apps.apple.com/tw/app/xcode/id497799835?mt=12).
 
@@ -31,17 +53,15 @@ $ brew
 5. Open the `.xcworkspace` file in Xcode
 <img src="readme_images/screenshot_2.png" width="400"/>
 
+## Add your Google Sign-In client ID, reversed client ID, and API key
+<img src="readme_images/plist.png">
+
 ## Run the project
 
 1. Select a simulator as run target
 2. press `Run` button (Command + R)
-![image](readme_images/screenshot_3.png)
+![image](readme_images/home.png)
 
 3. Set your `AppID` in the simulator
-<img src="readme_images/screenshot_1.png" width="350"/>
-
-4. (Optional) Setup configs programmatically
-
-    ![image](readme_images/screenshot_4.png)
-    - Set the `appId` in the `ContentView.swift`
-    - Set the `endPoint` in the `ContentView.swift`
+<img src="readme_images/app_id.png" width="1000"/>
+# circle-programmable-wallets-iOS-sample-app

w3s-ios-sample-app-wallets/w3s-ios-sample-app-wallets/Assets.xcassets/circle-logo-licorice.imageset/Contents.json

@@ -0,0 +1,21 @@
+{
+  "images" : [
+    {
+      "filename" : "circle-logo-licorice.png",
+      "idiom" : "universal",
+      "scale" : "1x"
+    },
+    {
+      "idiom" : "universal",
+      "scale" : "2x"
+    },
+    {
+      "idiom" : "universal",
+      "scale" : "3x"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

w3s-ios-sample-app-wallets/w3s-ios-sample-app-wallets/Assets.xcassets/circle-logo-ondark.imageset/Contents.json

@@ -0,0 +1,21 @@
+{
+  "images" : [
+    {
+      "filename" : "circle-logo-ondark.png",
+      "idiom" : "universal",
+      "scale" : "1x"
+    },
+    {
+      "idiom" : "universal",
+      "scale" : "2x"
+    },
+    {
+      "idiom" : "universal",
+      "scale" : "3x"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

w3s-ios-sample-app-wallets/w3s-ios-sample-app-wallets/Assets.xcassets/circle-logo-white.imageset/Contents.json

@@ -0,0 +1,21 @@
+{
+  "images" : [
+    {
+      "filename" : "circle-logo-white.png",
+      "idiom" : "universal",
+      "scale" : "1x"
+    },
+    {
+      "idiom" : "universal",
+      "scale" : "2x"
+    },
+    {
+      "idiom" : "universal",
+      "scale" : "3x"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

w3s-ios-sample-app-wallets/w3s-ios-sample-app-wallets/Assets.xcassets/circle-logo.imageset/Contents.json

@@ -0,0 +1,21 @@
+{
+  "images" : [
+    {
+      "filename" : "circle-logo.png",
+      "idiom" : "universal",
+      "scale" : "1x"
+    },
+    {
+      "idiom" : "universal",
+      "scale" : "2x"
+    },
+    {
+      "idiom" : "universal",
+      "scale" : "3x"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

w3s-ios-sample-app-wallets/w3s-ios-sample-app-wallets/Assets.xcassets/icon-AVAX.imageset/Contents.json

@@ -0,0 +1,21 @@
+{
+  "images" : [
+    {
+      "filename" : "icon-AVAX.png",
+      "idiom" : "universal",
+      "scale" : "1x"
+    },
+    {
+      "idiom" : "universal",
+      "scale" : "2x"
+    },
+    {
+      "idiom" : "universal",
+      "scale" : "3x"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

w3s-ios-sample-app-wallets/w3s-ios-sample-app-wallets/Assets.xcassets/icon-MATIC.imageset/Contents.json

@@ -0,0 +1,21 @@
+{
+  "images" : [
+    {
+      "filename" : "icon-MATIC.png",
+      "idiom" : "universal",
+      "scale" : "1x"
+    },
+    {
+      "idiom" : "universal",
+      "scale" : "2x"
+    },
+    {
+      "idiom" : "universal",
+      "scale" : "3x"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

w3s-ios-sample-app-wallets/w3s-ios-sample-app-wallets/Assets.xcassets/icon-USDCoin.imageset/Contents.json

@@ -0,0 +1,21 @@
+{
+  "images" : [
+    {
+      "filename" : "icon-USDCoin.png",
+      "idiom" : "universal",
+      "scale" : "1x"
+    },
+    {
+      "idiom" : "universal",
+      "scale" : "2x"
+    },
+    {
+      "idiom" : "universal",
+      "scale" : "3x"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

w3s-ios-sample-app-wallets/w3s-ios-sample-app-wallets/Assets.xcassets/logo-USDCoin-ondark.imageset/Contents.json

@@ -0,0 +1,21 @@
+{
+  "images" : [
+    {
+      "filename" : "logo-USDCoin-ondark.png",
+      "idiom" : "universal",
+      "scale" : "1x"
+    },
+    {
+      "idiom" : "universal",
+      "scale" : "2x"
+    },
+    {
+      "idiom" : "universal",
+      "scale" : "3x"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

w3s-ios-sample-app-wallets/w3s-ios-sample-app-wallets/Assets.xcassets/logo-USDCoin.imageset/Contents.json

@@ -0,0 +1,21 @@
+{
+  "images" : [
+    {
+      "filename" : "logo-USDCoin.png",
+      "idiom" : "universal",
+      "scale" : "1x"
+    },
+    {
+      "idiom" : "universal",
+      "scale" : "2x"
+    },
+    {
+      "idiom" : "universal",
+      "scale" : "3x"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}