update readme and change pkg name

skip-mev · Jul 1, 2024 · 6e4bdfe · 6e4bdfe
1 parent d309094
commit 6e4bdfe
Show file tree

Hide file tree

Showing 5 changed files with 54 additions and 154 deletions.
diff --git a/README.md b/README.md
@@ -1,118 +1,18 @@
-# Skip Go Widget
+# skip-go
 
-The `@skip-go/widget` package is an npm package providing a React component for a full swap interface using the [Skip API](https://skip.money/).
+## Project Structure
 
-## Installation
-
-To install the package, run the following command:
-
-```bash
-npm install @skip-go/widget
-```
-
-## Quick Start Guide
-
-### 1. Wrap Your App with `SwapWidgetProvider`
-
-First, wrap your application or the relevant page with the `SwapWidgetProvider` component:
-
-```tsx
-import { SwapWidgetProvider } from '@skip-go/widget';
-
-function App() {
-  return (
-    <SwapWidgetProvider>
-      <YourApp />
-    </SwapWidgetProvider>
-  );
-}
-```
-
-### 2. Use the `SwapWidget` Component
-
-Next, import the css and use the `SwapWidget` component to render the swap interface:
-
-```tsx
-import { SwapWidget } from '@skip-go/widget';
-import '@skip-go/widget/style.css';
-
-const SwapPage = () => {
-  return (
-    <div
-      style={{
-        width: '450px',
-        height: '820px',
-      }}
-    >
-      <SwapWidget
-        colors={{
-          primary: '#FF4FFF',
-        }}
-      />
-    </div>
-  );
-};
-```
-
-## Component Props
-
-### SwapWidget
-
-The `SwapWidget` component accepts the following props:
-
-```tsx
-interface SwapWidgetProps {
-  colors?: {
-    primary?: string; // Custom primary color for the widget. Defaults to `#FF486E`.
-  };
-  defaultRoute?: {
-    // Default route for the widget.
-    amountIn?: number;
-    amountOut?: number;
-    srcChainID?: string;
-    srcAssetDenom?: string;
-    destChainID?: string;
-    destAssetDenom?: string;
-  };
-  routeConfig?: {
-    experimentalFeatures?: ['hyperlane'];
-    allowMultiTx?: boolean;
-    allowUnsafe?: boolean;
-    bridges?: ('IBC' | 'AXELAR' | 'CCTP' | 'HYPERLANE')[];
-    swapVenues?: {
-      name: string;
-      chainID: string;
-    }[];
-  };
-  className?: string;
-  style?: React.CSSProperties;
-  settings?: {
-    customGasAmount?: number; // custom gas amount for validation defaults to 200_000
-    slippage?: number; //percentage of slippage 0-100. defaults to 3
-  };
-  onlyTestnet?: boolean; // Only show testnet chains
-}
+```sh
+├── examples
+│   └── nextjs
+├── packages
+│   ├── core
+│   └── widget
 ```
 
-### SwapWidgetProvider
-
-The `SwapWidgetProvider` component accepts the following prop:
-
-- `toasterProps` (Optional): Props for the toaster component. Refer to [ToasterProps](https://react-hot-toast.com/docs/toast-options) for more details. Defaults to `{ position: 'top-right' }`.
-- `endpointOptions` (Optional): Endpoint options to override endpoints. Defaults to Skip proxied endpoints. Please reach out to us first if you want to be whitelisted.
-
-  ```ts
-  endpointOptions?: {
-      // Endpoint options to override endpoints. Defaults to Skip proxied endpoints. Please reach out to us first if you want to be whitelisted.
-      endpoints?: Record<string, EndpointOptions>;
-      getRpcEndpointForChain?: (chainID: string) => Promise<string>;
-      getRestEndpointForChain?: (chainID: string) => Promise<string>;
-    };
-  ```
-
-- `apiURL` (Optional): Custom API URL to override Skip API endpoint. Defaults to Skip proxied endpoints. Please reach out to us first if you want to be whitelisted.
-
-By following these steps, you can easily integrate the Skip Go Widget into your React application and customize it to meet your specific needs.
+- `core` (@skip-go/core): The core package of the project. Contains the core logic, api fetch and types, helper functions, signing, etc.
+- `widget` (@skip-go/widget): React library that contains the swap widget components.
+- `examples`: The example app of the project
 
 ## Dev Setup
 

diff --git a/package.json b/package.json
@@ -13,14 +13,14 @@
     "dev": "yarn run dev:widget & yarn run dev:nextjs & yarn run dev:core",
     "dev:widget": "yarn workspace @skip-go/widget run dev",
     "dev:nextjs": "yarn workspace nextjs run dev",
-    "dev:core": "yarn workspace @skip-router/core run watch",
+    "dev:core": "yarn workspace @skip-go/core run watch",
     "build": "yarn run build:core && yarn run chains && yarn run build:widget && yarn run build:nextjs",
     "build:widget": "yarn workspace @skip-go/widget run build",
     "build:nextjs": "yarn workspace nextjs build",
-    "build:core": "yarn run codegen && yarn workspace @skip-router/core build",
-    "codegen": "yarn workspace @skip-router/core codegen",
+    "build:core": "yarn run codegen && yarn workspace @skip-go/core build",
+    "codegen": "yarn workspace @skip-go/core codegen",
     "chains": "yarn workspace @skip-go/widget run chains:generate",
-    "test": "yarn workspace @skip-router/core run test",
+    "test": "yarn workspace @skip-go/core run test",
     "submodule": "yarn run submodule:init && yarn run submodule:update",
     "submodule:init": "git submodule init",
     "submodule:update": "git submodule update"

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,7 +1,7 @@
 {
-  "name": "@skip-router/core",
+  "name": "@skip-go/core",
   "description": "JavaScript SDK for Skip API",
-  "version": "5.1.1",
+  "version": "0.0.1",
   "repository": "https://github.com/skip-mev/skip-router-sdk",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

diff --git a/packages/widget/package.json b/packages/widget/package.json
@@ -80,7 +80,7 @@
     "@radix-ui/react-scroll-area": "^1.0.5",
     "@radix-ui/react-switch": "^1.0.3",
     "@radix-ui/react-tooltip": "^1.0.7",
-    "@skip-router/core": "workspace:packages/core",
+    "@skip-go/core": "workspace:packages/core",
     "@solana/spl-token": "^0.4.6",
     "@solana/wallet-adapter-react": "^0.15.35",
     "@solana/wallet-adapter-wallets": "^0.19.32",

diff --git a/yarn.lock b/yarn.lock
@@ -7816,6 +7816,41 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@skip-go/core@workspace:packages/core":
+  version: 0.0.0-use.local
+  resolution: "@skip-go/core@workspace:packages/core"
+  dependencies:
+    "@cosmjs/amino": 0.32.4
+    "@cosmjs/cosmwasm-stargate": 0.32.4
+    "@cosmjs/encoding": 0.32.4
+    "@cosmjs/faucet": 0.32.3
+    "@cosmjs/faucet-client": 0.32.3
+    "@cosmjs/math": 0.32.4
+    "@cosmjs/proto-signing": 0.32.4
+    "@cosmjs/stargate": 0.32.4
+    "@cosmjs/tendermint-rpc": 0.32.4
+    "@cosmology/telescope": 1.8.3
+    "@initia/initia-registry": 0.1.9
+    "@injectivelabs/core-proto-ts": 0.0.21
+    "@injectivelabs/sdk-ts": 1.14.5
+    "@keplr-wallet/unit": ^0.12.67
+    "@protobufs/gogoproto": 0.0.10
+    "@protobufs/google": 0.0.10
+    "@solana/wallet-adapter-base": ^0.9.23
+    "@solana/web3.js": ^1.91.1
+    axios: 1.x
+    cosmjs-types: 0.8.0
+    keccak256: 1.x
+    kujira.js: 0.9.x
+    minimatch: ^9.0.3
+    proxy-from-env: ^1.1.0
+    viem: 2.x
+    vitest: ^1.2.2
+  peerDependencies:
+    chain-registry: ^1.33.11
+  languageName: unknown
+  linkType: soft
+
 "@skip-go/widget@workspace:packages/widget":
   version: 0.0.0-use.local
   resolution: "@skip-go/widget@workspace:packages/widget"
@@ -7839,7 +7874,7 @@ __metadata:
     "@radix-ui/react-scroll-area": ^1.0.5
     "@radix-ui/react-switch": ^1.0.3
     "@radix-ui/react-tooltip": ^1.0.7
-    "@skip-router/core": "workspace:packages/core"
+    "@skip-go/core": "workspace:packages/core"
     "@solana/spl-token": ^0.4.6
     "@solana/wallet-adapter-react": ^0.15.35
     "@solana/wallet-adapter-wallets": ^0.19.32
@@ -7871,41 +7906,6 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@skip-router/core@workspace:packages/core":
-  version: 0.0.0-use.local
-  resolution: "@skip-router/core@workspace:packages/core"
-  dependencies:
-    "@cosmjs/amino": 0.32.4
-    "@cosmjs/cosmwasm-stargate": 0.32.4
-    "@cosmjs/encoding": 0.32.4
-    "@cosmjs/faucet": 0.32.3
-    "@cosmjs/faucet-client": 0.32.3
-    "@cosmjs/math": 0.32.4
-    "@cosmjs/proto-signing": 0.32.4
-    "@cosmjs/stargate": 0.32.4
-    "@cosmjs/tendermint-rpc": 0.32.4
-    "@cosmology/telescope": 1.8.3
-    "@initia/initia-registry": 0.1.9
-    "@injectivelabs/core-proto-ts": 0.0.21
-    "@injectivelabs/sdk-ts": 1.14.5
-    "@keplr-wallet/unit": ^0.12.67
-    "@protobufs/gogoproto": 0.0.10
-    "@protobufs/google": 0.0.10
-    "@solana/wallet-adapter-base": ^0.9.23
-    "@solana/web3.js": ^1.91.1
-    axios: 1.x
-    cosmjs-types: 0.8.0
-    keccak256: 1.x
-    kujira.js: 0.9.x
-    minimatch: ^9.0.3
-    proxy-from-env: ^1.1.0
-    viem: 2.x
-    vitest: ^1.2.2
-  peerDependencies:
-    chain-registry: ^1.33.11
-  languageName: unknown
-  linkType: soft
-
 "@socket.io/component-emitter@npm:~3.1.0":
   version: 3.1.2
   resolution: "@socket.io/component-emitter@npm:3.1.2"