@markee_team/sdk 0.1.0-alpha.2 → 0.1.0-alpha.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +57 -37
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -2,12 +2,12 @@
2
2
 
3
3
  An ESM JavaScript SDK with a self-contained, Shadow DOM modal and an optional React entry point. The SDK knows the Markee API endpoint; the host only supplies its placement and, optionally, its current wallet provider. No Alchemy, Redis, Privy, or bridge-provider key belongs in the consuming app.
4
4
 
5
- This is an experimental `0.1.0-alpha.2` release for wallet-funded For Sale and For Rent flows. Hosted card checkout and incoming cross-chain funding are not included.
5
+ This is an experimental `0.1.0-alpha.4` release for wallet-funded For Sale and For Rent flows. Hosted card checkout and incoming cross-chain funding are not included.
6
6
 
7
7
  Install the alpha:
8
8
 
9
9
  ```sh
10
- npm install @markee_team/sdk@alpha
10
+ npm install @markee_team/sdk@latest
11
11
  ```
12
12
 
13
13
  Use React 18 or 19 for the optional React entry point. The plain JavaScript entry point does not require React. Both TypeScript bundler and NodeNext resolution are supported.
@@ -143,41 +143,61 @@ No API URL configuration is required. This alpha uses the Markee staging API at
143
143
 
144
144
  ## LLM implementation prompt
145
145
 
146
- Copy this prompt into your coding assistant. These are existing Base demo boards; replace the placements with your own when integrating your product.
146
+ Copy this prompt into your coding assistant. It gathers missing requirements before implementing the integration.
147
147
 
148
148
  ```text
149
- Integrate @markee_team/sdk@0.1.0-alpha.2 into this app. Inspect the app first and
150
- follow its existing framework, styling, and wallet patterns.
151
-
152
- - Install @markee_team/sdk@0.1.0-alpha.2. The SDK knows its API endpoint. Do not
153
- request an API URL, build an API proxy, or add RPC/database/provider keys.
154
- - For React 18/19, import MarkeeModal from @markee_team/sdk/react in a client
155
- component and supply open, onClose, and placement. For other apps, import
156
- createMarkee from @markee_team/sdk, call createMarkee(), then open({ placement }).
157
- Close the instance on teardown. Reuse the built-in modal UI.
158
- - Add buttons for these existing demo placements:
159
- For Sale: { kind: 'board', chainId: 8453,
160
- address: '0x2768BC6e90266248BD8bCF5401C36D8049CdF671' }
161
- For Rent: { kind: 'board', chainId: 8453,
162
- address: '0x82cbe3BdFC4e01940D186Ac5EA151355647DE0d3' }
163
- - Wallet integration is optional. Reuse the app's selected EIP-1193 provider via
164
- wallet.getProvider(): Promise<provider | null> and optional
165
- wallet.connect(): Promise<provider>. For ConnectKit/wagmi, use the active
166
- connector's provider, resolve connect after selection, and reject cancellation.
167
- Do not create a second wallet context or silently select another injected wallet.
168
- If there is no existing wallet integration, omit wallet for SDK wallet discovery.
169
- - Match the app using theme: mode ('light', 'dark', 'system'), fontFamily, radius,
170
- and semantic colors such as primary and primaryText. Preserve the built-in
171
- layout and its isolated Shadow DOM styles.
172
- - Optionally handle onEvent and show success only for a confirmed event. Let the
173
- SDK handle payment review, chain switching, submission, and verification.
174
- Do not advertise card checkout or incoming bridging: this alpha lacks those
175
- features. The demo boards use real Base funds.
176
- - Run typecheck/build and verify both modals load without API configuration,
177
- open/close correctly, and match the theme. Verify host wallet reuse if available.
178
- Do not sign or submit transactions during automated verification. Report changed
179
- files, checks, and remaining limitations.
180
-
181
- This alpha automatically uses Markee's temporary staging backend. Read the installed
182
- package README for exact types and configuration details.
149
+ Integrate @markee_team/sdk@latest into this app. Inspect the codebase first and
150
+ follow its existing framework, styling, and wallet patterns. Read the installed
151
+ package README and types for current capabilities.
152
+
153
+ Before implementing, ask me to create my leaderboard on Markee at
154
+ https://www.markee.xyz/create-a-markee, then provide its resulting Markee page link.
155
+ If I already have a leaderboard, ask for that link instead; do not create a duplicate.
156
+ Example link format:
157
+ https://www.markee.xyz/markee/0x6ceBC87DE40519Fa52fc40a1d49f16FF968bb439
158
+ Never silently substitute a demo board. Wait for my link before wiring the placement.
159
+
160
+ Extract the board address from the /markee/<address> path. Validate the Markee URL
161
+ and the address (0x followed by 40 hexadecimal characters). Markee website boards
162
+ currently use Base, chain ID 8453. Verify the board through the SDK snapshot API;
163
+ if verification fails, explain the error and ask for a corrected link.
164
+
165
+ Do not ask me to choose For Sale or For Rent in the host app. That choice is made
166
+ when creating the leaderboard on Markee. The API returns strategy and the SDK
167
+ adapts the modal automatically. Do not add a strategy prop, toggle, or hardcoded mode.
168
+
169
+ Ask only the remaining unanswered requirements in one concise group:
170
+ - Where should Markee appear, what opens the modal, and what should the button say?
171
+ - Should it reuse the app's existing wallet or use SDK wallet discovery? Inspect
172
+ existing connectors first; do not add a second wallet context or install a new
173
+ connector without agreement.
174
+ - Should the modal match the app theme or use specific colors, font, radius, and
175
+ light/dark/system mode?
176
+ - What should happen after a confirmed transaction: notification, refresh,
177
+ navigation, or callback? Are there additional mobile/accessibility requirements?
178
+
179
+ Then implement the agreed scope:
180
+ 1. Install @markee_team/sdk@latest. No API URL or Markee API key is required.
181
+ Do not create an API proxy or add RPC/database credentials.
182
+ 2. Use placement = { kind: 'board', chainId: 8453, address: extractedAddress }.
183
+ Use new MarkeeClient().snapshot(placement) to verify the board and read strategy,
184
+ name, minimum, and other metadata. The modal performs its own snapshot loading;
185
+ do not recreate that loading or strategy logic in the host app.
186
+ 3. For React, use MarkeeModal from @markee_team/sdk/react in a client component
187
+ with open, onClose, and placement. Otherwise use createMarkee() from
188
+ @markee_team/sdk, then open({ placement }); close it on teardown.
189
+ 4. If a host wallet exists, pass its selected EIP-1193 provider through the wallet
190
+ adapter. For ConnectKit/wagmi use the active connector. Resolve connect after
191
+ selection, reject cancellation, and do not silently switch wallet providers.
192
+ Otherwise omit wallet and use SDK wallet discovery.
193
+ 5. Apply theme options while preserving the built-in modal layout. Handle onEvent
194
+ if needed; show success only for a confirmed event. Let the SDK manage review,
195
+ network switching, submission, and verification.
196
+ 6. Verify build/types, loading of the supplied board, automatic strategy selection,
197
+ open/close behavior, theme, and wallet reuse. Do not sign or send transactions
198
+ during automated verification. Report changed files, checks, and limitations.
199
+
200
+ Check the installed release's limitations before promising features. This release
201
+ uses Markee's staging backend and supports wallet-funded flows; card checkout and
202
+ incoming bridging are not yet available. Transactions use real funds.
183
203
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@markee_team/sdk",
3
- "version": "0.1.0-alpha.2",
3
+ "version": "0.1.0-alpha.4",
4
4
  "description": "Self-contained Markee modal and API client, with an optional React adapter.",
5
5
  "type": "module",
6
6
  "sideEffects": false,