@zkp2p/sdk 0.14.2 → 0.14.4

package/README.md

@@ -35,10 +35,10 @@ and chargeback-risk surface. The workspace version lives in `package.json`.
 
 ## Optional Venmo Gmail connection
 
-For partner cash-out integrations, prefer stable `@zkp2p/cash@0.6.1` and its
+For partner cash-out integrations, prefer stable `@zkp2p/cash@0.6.2` and its
 [prepare/open/status flow](https://docs.peer.xyz/developer/peer-cash/guide#optional-venmo-receipt-linking).
 It selects the matching environment and keeps linking separate from cash-out.
-The direct SDK helpers below require `@zkp2p/sdk@0.14.2`.
+The direct SDK helpers below require `@zkp2p/sdk@0.14.2` or later.
 
 Open Peer's **Link your Venmo** popup for an already-registered account.
 The host passes the selected account hash; the user selects Connect Gmail,
@@ -75,6 +75,45 @@ hosts and custom window handling with account-status polling at least ten second
 apart. Deploy the hosted page before using the SDK helper. See the
 [flow specification](https://github.com/zkp2p/zkp2p-clients/blob/main/docs/venmo-gmail-connect.md).
 
+### Native app return
+
+SDK `0.14.3` adds optional `returnUrl` to the URL builder. Partners
+supply their callback directly; no callback registration with Peer or deployment
+setting is required. Deploy the hosted-page update before enabling this flow.
+
+```ts
+import { getVenmoGmailConnectUrl } from '@zkp2p/sdk';
+import * as WebBrowser from 'expo-web-browser';
+
+// Use a callback scheme registered in your app binary.
+const returnUrl = 'partner-app://venmo-linked';
+const connectUrl = getVenmoGmailConnectUrl({ payeeDetails, returnUrl });
+await WebBrowser.openAuthSessionAsync(connectUrl, returnUrl);
+// Re-check your backend's seller-credential/status after return or dismissal.
+```
+
+Use a scheme registered in your Expo app binary; Expo Go is not a substitute
+for testing your app's callback. See Expo's
+[`openAuthSessionAsync` documentation](https://docs.expo.dev/versions/latest/sdk/webbrowser/#webbrowseropenauthsessionasyncurl-redirecturl-options).
+The browser popup helper remains browser-only; native hosts use the URL builder.
+
+Peer keeps Google's OAuth callback on Peer and verifies the selected account
+before navigating to `returnUrl` unchanged. No Google codes, tokens, email,
+account hash, or success flag are appended. If automatic navigation is blocked,
+select **Return to your app**. Consent or verification errors stay visible and
+also offer a manual return. A return, dismissal, or cancellation is not proof of
+linking: only an active `google_oauth` credential from the status API is linked.
+
+Apps that need no SDK can build the same URL themselves:
+`https://app.peer.xyz/connect/venmo?returnUrl=<URL-encoded-callback>#<payeeDetails>`.
+The query parameter must precede the account hash fragment. Malformed URLs,
+unsafe schemes, embedded credentials, and duplicate parameters are rejected
+before consent or credential upload.
+
+Omit `returnUrl` or leave it empty to keep the existing behavior: Peer attempts
+`window.close()` after verification. Script-opened desktop popups can close;
+mobile browser tabs that disallow closure keep the success message visible.
+
 ### Popup customization
 
 Pass `appearance` to either hosted-link helper and `popup` to the browser opener:
@@ -1027,6 +1066,31 @@ const hash = await client.signalIntent({
 });
 ```
 
+`createDeposit` and `prepareCreateDeposit` also accept `referralCode` for
+Peer deposit-level referral attribution, using the same `peer-ref-XXXXXX` marker
+as the Cash SDK:
+
+```ts
+const { prepared } = await client.prepareCreateDeposit({
+  ...depositParams,
+  referralCode: 'ABC123',
+  txOverrides: { referrer: 'my-app' },
+});
+```
+
+Codes must contain six alphanumeric characters; whitespace is trimmed and letters
+are uppercased. Invalid codes reject before payee registration or transaction
+submission. The resulting ERC-8021 codes are `peer-ref-ABC123`, `my-app`, then
+`bc_nbn6qkni`. Omitting `referralCode` preserves existing attribution. The SDK does
+not add the Cash-specific `peer-cash` source marker.
+
+Curator resolves the referral code and determines deposit-level integration credit;
+this option does not set a fee or redeem a maker referral. Ordinary
+`txOverrides.referrer` codes remain analytics attribution. When `referralCode` is
+supplied, an existing `peer-ref-` marker in `txOverrides.referrer` is rejected
+before side effects, including an identical marker. Supply the referral through
+one option only; Curator treats conflicting referral attribution as ambiguous.
+
 Lower-level helpers are also exported: `BASE_BUILDER_CODE`, `ZKP2P_IOS_REFERRER`, `ZKP2P_ANDROID_REFERRER`, `getAttributionDataSuffix()`, `appendAttributionToCalldata()`, `encodeWithAttribution()`, and `sendTransactionWithAttribution()`.
 
 ## TypeDoc API Reference

package/dist/build-metadata.json

@@ -2,11 +2,11 @@
   "schemaVersion": 2,
   "source": {
     "repository": "zkp2p/zkp2p-clients",
-    "commitSha": "a87f38c512f987fc3b9234b5aee31115bf840a18",
+    "commitSha": "c34d74604e3cab83656d6ba85203099456962b0c",
     "kind": "github",
     "distributable": true
   },
-  "sdkPackageVersion": "0.14.2",
+  "sdkPackageVersion": "0.14.4",
   "contractsPackageVersion": "0.4.2-rc.2",
   "indexerSchemaPackageVersion": "0.22.0",
   "activeDisputeStack": {

package/dist/{chunk-BVBHBKX7.mjs → chunk-HQACV3RF.mjs}

@@ -5,8 +5,8 @@ var __export = (target, all) => {
 };
 
 // <define:__ZKP2P_SDK_BUILD_METADATA__>
-var define_ZKP2P_SDK_BUILD_METADATA_default = { schemaVersion: 2, source: { repository: "zkp2p/zkp2p-clients", commitSha: "a87f38c512f987fc3b9234b5aee31115bf840a18", kind: "github", distributable: true }, sdkPackageVersion: "0.14.2", contractsPackageVersion: "0.4.2-rc.2", indexerSchemaPackageVersion: "0.22.0", activeDisputeStack: { base: { version: 2, selectionHash: "ba40c2954b408d0c658881a8d28e5bfcc9bade5cc3d953fd17eae1eca69d841c" }, baseStaging: { version: 2, selectionHash: "6c49c1ce51eec594a22385c4efcab08aa9926b6b63a725e14a0027ec5d2f4fc9" } } };
+var define_ZKP2P_SDK_BUILD_METADATA_default = { schemaVersion: 2, source: { repository: "zkp2p/zkp2p-clients", commitSha: "c34d74604e3cab83656d6ba85203099456962b0c", kind: "github", distributable: true }, sdkPackageVersion: "0.14.4", contractsPackageVersion: "0.4.2-rc.2", indexerSchemaPackageVersion: "0.22.0", activeDisputeStack: { base: { version: 2, selectionHash: "ba40c2954b408d0c658881a8d28e5bfcc9bade5cc3d953fd17eae1eca69d841c" }, baseStaging: { version: 2, selectionHash: "6c49c1ce51eec594a22385c4efcab08aa9926b6b63a725e14a0027ec5d2f4fc9" } } };
 
 export { __export, define_ZKP2P_SDK_BUILD_METADATA_default };
-//# sourceMappingURL=chunk-BVBHBKX7.mjs.map
-//# sourceMappingURL=chunk-BVBHBKX7.mjs.map
+//# sourceMappingURL=chunk-HQACV3RF.mjs.map
+//# sourceMappingURL=chunk-HQACV3RF.mjs.map

package/dist/{chunk-BVBHBKX7.mjs.map → chunk-HQACV3RF.mjs.map}

@@ -1 +1 @@
-{"version":3,"sources":["%3Cdefine:__ZKP2P_SDK_BUILD_METADATA__%3E"],"names":[],"mappings":";;;;;;;AAAA,IAAA,uCAAA,GAAA,EAAC,aAAA,EAAgB,CAAA,EAAE,MAAA,EAAS,EAAC,YAAa,qBAAA,EAAsB,SAAA,EAAY,0CAAA,EAA2C,IAAA,EAAO,UAAS,aAAA,EAAgB,IAAA,EAAI,EAAE,iBAAA,EAAoB,UAAS,uBAAA,EAA0B,YAAA,EAAa,2BAAA,EAA8B,QAAA,EAAS,oBAAqB,EAAC,IAAA,EAAO,EAAC,OAAA,EAAU,GAAE,aAAA,EAAgB,kEAAA,EAAkE,EAAE,WAAA,EAAc,EAAC,OAAA,EAAU,CAAA,EAAE,aAAA,EAAgB,kEAAA,IAAmE","file":"chunk-BVBHBKX7.mjs","sourcesContent":["{\"schemaVersion\":2,\"source\":{\"repository\":\"zkp2p/zkp2p-clients\",\"commitSha\":\"a87f38c512f987fc3b9234b5aee31115bf840a18\",\"kind\":\"github\",\"distributable\":true},\"sdkPackageVersion\":\"0.14.2\",\"contractsPackageVersion\":\"0.4.2-rc.2\",\"indexerSchemaPackageVersion\":\"0.22.0\",\"activeDisputeStack\":{\"base\":{\"version\":2,\"selectionHash\":\"ba40c2954b408d0c658881a8d28e5bfcc9bade5cc3d953fd17eae1eca69d841c\"},\"baseStaging\":{\"version\":2,\"selectionHash\":\"6c49c1ce51eec594a22385c4efcab08aa9926b6b63a725e14a0027ec5d2f4fc9\"}}}"]}
+{"version":3,"sources":["%3Cdefine:__ZKP2P_SDK_BUILD_METADATA__%3E"],"names":[],"mappings":";;;;;;;AAAA,IAAA,uCAAA,GAAA,EAAC,aAAA,EAAgB,CAAA,EAAE,MAAA,EAAS,EAAC,YAAa,qBAAA,EAAsB,SAAA,EAAY,0CAAA,EAA2C,IAAA,EAAO,UAAS,aAAA,EAAgB,IAAA,EAAI,EAAE,iBAAA,EAAoB,UAAS,uBAAA,EAA0B,YAAA,EAAa,2BAAA,EAA8B,QAAA,EAAS,oBAAqB,EAAC,IAAA,EAAO,EAAC,OAAA,EAAU,GAAE,aAAA,EAAgB,kEAAA,EAAkE,EAAE,WAAA,EAAc,EAAC,OAAA,EAAU,CAAA,EAAE,aAAA,EAAgB,kEAAA,IAAmE","file":"chunk-HQACV3RF.mjs","sourcesContent":["{\"schemaVersion\":2,\"source\":{\"repository\":\"zkp2p/zkp2p-clients\",\"commitSha\":\"c34d74604e3cab83656d6ba85203099456962b0c\",\"kind\":\"github\",\"distributable\":true},\"sdkPackageVersion\":\"0.14.4\",\"contractsPackageVersion\":\"0.4.2-rc.2\",\"indexerSchemaPackageVersion\":\"0.22.0\",\"activeDisputeStack\":{\"base\":{\"version\":2,\"selectionHash\":\"ba40c2954b408d0c658881a8d28e5bfcc9bade5cc3d953fd17eae1eca69d841c\"},\"baseStaging\":{\"version\":2,\"selectionHash\":\"6c49c1ce51eec594a22385c4efcab08aa9926b6b63a725e14a0027ec5d2f4fc9\"}}}"]}

package/dist/{chunk-OP2REHNS.mjs → chunk-JU7CL4RJ.mjs}

@@ -1,5 +1,5 @@
 import { currencyKeccak256, getCurrencyInfoFromHash } from './chunk-ZB22BZLZ.mjs';
-import { __export } from './chunk-BVBHBKX7.mjs';
+import { __export } from './chunk-HQACV3RF.mjs';
 import { hexToBytes, keccak256, toBytes, bytesToHex } from 'viem';
 
 // src/utils/bigint.ts
@@ -97848,5 +97848,5 @@ function enrichPvIntentView(view, chainId, env = "production") {
 }
 
 export { DISPUTE_PROTECTION_POLICY_ABI, DISPUTE_PROTECTION_POLICY_ABI2, DisputeNullifierRegistry_default3 as DisputeNullifierRegistry_default, DisputeProtectionPolicy_default3 as DisputeProtectionPolicy_default, DisputeVerifier_default3 as DisputeVerifier_default, IntentLifecycleHookV1_default3 as IntentLifecycleHookV1_default, METHOD_NAME_TO_HASH, MultiAttestationVerifier_default3 as MultiAttestationVerifier_default, ORCHESTRATOR_V3_ABI2 as ORCHESTRATOR_V3_ABI, OrchestratorRegistry_default3 as OrchestratorRegistry_default, OrchestratorV3_default3 as OrchestratorV3_default, PAYMENT_PLATFORMS, STAKE_VAULT_ABI2 as STAKE_VAULT_ABI, SUPPORTED_PAYMENT_METHOD_HASHES, StakeVault_default3 as StakeVault_default, WhitelistPolicy_default3 as WhitelistPolicy_default, asciiToBytes32, enrichPvDepositView, enrichPvIntentView, ensureBytes32, getContracts, getDisputeProtectionPolicyContract, getGatingServiceAddress, getIntentGuardianContract, getOrchestratorV3Contract, getPaymentMethodsCatalog, getRateManagerContracts, getStakeVaultContract, hasIntentGuardian, matchesPaymentMethodNameAndHash, matchesQuotePaymentMethod, parseBigIntLike, parseDepositView, parseIntentView, resolveFiatCurrencyBytes32, resolvePaymentMethodHash, resolvePaymentMethodHashFromCatalog, resolvePaymentMethodNameFromHash };
-//# sourceMappingURL=chunk-OP2REHNS.mjs.map
-//# sourceMappingURL=chunk-OP2REHNS.mjs.map
+//# sourceMappingURL=chunk-JU7CL4RJ.mjs.map
+//# sourceMappingURL=chunk-JU7CL4RJ.mjs.map