@frak-labs/nexus-sdk 0.0.8 → 0.0.10

package/dist/core/actions/index.d.ts

@@ -1,7 +1,9 @@
-export { G as GetUnlockOptionsParams, W as WatchUnlockStatusParams, g as getArticleUnlockOptions, w as watchUnlockStatus } from '../../watchUnlockStatus-DQYfUj46.js';
-import { N as NexusClient, W as WalletStatusReturnType, a as NexusWalletSdkConfig, S as StartArticleUnlockReturnType, b as StartArticleUnlockParams } from '../../client-MgLVRfPw.js';
+export { G as GetUnlockOptionsParams, W as WatchUnlockStatusParams, g as getArticleUnlockOptions, w as watchUnlockStatus } from '../../watchUnlockStatus-g8wIxpeM.js';
+import { N as NexusClient, W as WalletStatusReturnType, a as NexusWalletSdkConfig, b as StartArticleUnlockReturnType, S as StartArticleUnlockParams, c as SendTransactionActionParamsType, d as SendTransactionReturnType, g as SiweAuthenticateActionParamsType, f as SiweAuthenticateReturnType } from '../../client-6_BJp7Ub.js';
+import { S as SendInteractionParamsType, a as SendInteractionReturnType } from '../../interaction-D_CzyqRE.js';
 import 'viem';
 import 'viem/chains';
+import 'viem/siwe';
 
 /**
  * Function used to watch the current nexus wallet status
@@ -27,4 +29,30 @@ declare function decodeStartUnlockReturn({ result, hash, }: {
     validationHash: string;
 }>>;
 
-export { decodeStartUnlockReturn, getStartArticleUnlockUrl, watchWalletStatus };
+/**
+ * Function used to send a user transaction
+ * @param client
+ * @param tx
+ * @param context
+ * @param callback
+ */
+declare function sendTransaction(client: NexusClient, { tx, context }: SendTransactionActionParamsType): Promise<SendTransactionReturnType>;
+
+/**
+ * Function used to launch a siwe authentication
+ * @param client
+ * @param siwe
+ * @param context
+ */
+declare function siweAuthenticate(client: NexusClient, { siwe, context }: SiweAuthenticateActionParamsType): Promise<SiweAuthenticateReturnType>;
+
+/**
+ * Function used to send an interaction
+ * @param client
+ * @param contentId
+ * @param request
+ * @param validation
+ */
+declare function sendInteraction(client: NexusClient, { contentId, interaction, validation }: SendInteractionParamsType): Promise<SendInteractionReturnType>;
+
+export { decodeStartUnlockReturn, getStartArticleUnlockUrl, sendInteraction, sendTransaction, siweAuthenticate, watchWalletStatus };

package/dist/core/actions/index.js

@@ -2,14 +2,21 @@ import {
   decodeStartUnlockReturn,
   getArticleUnlockOptions,
   getStartArticleUnlockUrl,
+  sendInteraction,
+  sendTransaction,
+  siweAuthenticate,
   watchUnlockStatus,
   watchWalletStatus
-} from "../../chunk-4VFMYMTH.js";
-import "../../chunk-5QWG35A2.js";
+} from "../../chunk-T54VMWHQ.js";
+import "../../chunk-TPC5PMRC.js";
+import "../../chunk-PKBMQBKP.js";
 export {
   decodeStartUnlockReturn,
   getArticleUnlockOptions,
   getStartArticleUnlockUrl,
+  sendInteraction,
+  sendTransaction,
+  siweAuthenticate,
   watchUnlockStatus,
   watchWalletStatus
 };

package/dist/core/index.cjs

@@ -1,22 +1,19 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
-var _chunkJXQKTLEEcjs = require('../chunk-JXQKTLEE.cjs');
+var _chunkSGLR6RFAcjs = require('../chunk-SGLR6RFA.cjs');
 
 
 
 
 
 
+var _chunkBPFJZRJ6cjs = require('../chunk-BPFJZRJ6.cjs');
+require('../chunk-ETV4XYOV.cjs');
 
 
-var _chunk2XUJYDD3cjs = require('../chunk-2XUJYDD3.cjs');
 
 
 
 
 
-
-
-
-
-exports.createIFrameNexusClient = _chunkJXQKTLEEcjs.createIFrameNexusClient; exports.createIframe = _chunk2XUJYDD3cjs.createIframe; exports.decompressDataAndCheckHash = _chunk2XUJYDD3cjs.decompressDataAndCheckHash; exports.getIFrameResponseKeyProvider = _chunk2XUJYDD3cjs.getIFrameResponseKeyProvider; exports.getRedirectResponseResponseKeyProvider = _chunk2XUJYDD3cjs.getRedirectResponseResponseKeyProvider; exports.hashAndCompressData = _chunk2XUJYDD3cjs.hashAndCompressData; exports.iFrameRequestKeyProvider = _chunk2XUJYDD3cjs.iFrameRequestKeyProvider; exports.redirectRequestKeyProvider = _chunk2XUJYDD3cjs.redirectRequestKeyProvider;
+exports.FrakRpcError = _chunkBPFJZRJ6cjs.FrakRpcError; exports.RpcErrorCodes = _chunkBPFJZRJ6cjs.RpcErrorCodes; exports.createIFrameNexusClient = _chunkSGLR6RFAcjs.createIFrameNexusClient; exports.createIframe = _chunkBPFJZRJ6cjs.createIframe; exports.decompressDataAndCheckHash = _chunkBPFJZRJ6cjs.decompressDataAndCheckHash; exports.hashAndCompressData = _chunkBPFJZRJ6cjs.hashAndCompressData;

package/dist/core/index.d.cts

@@ -1,7 +1,10 @@
-import { a as NexusWalletSdkConfig, N as NexusClient, E as ExtractedParametersFromRpc, I as IFrameRpcSchema, c as ExtractedReturnTypeFromRpc, R as RedirectRpcSchema } from '../client-MgLVRfPw.cjs';
-export { A as ArticleUnlockStatusReturnType, f as IFrameEvent, e as IFrameRpcEvent, d as IFrameTransport, P as PaidArticleUnlockPrice, b as StartArticleUnlockParams, S as StartArticleUnlockReturnType, U as UnlockOptionsReturnType, W as WalletStatusReturnType } from '../client-MgLVRfPw.cjs';
+import { a as NexusWalletSdkConfig, N as NexusClient } from '../client--U_6SK0l.cjs';
+export { A as ArticleUnlockStatusReturnType, E as ExtractedParametersFromRpc, m as ExtractedReturnTypeFromRpc, l as IFrameEvent, k as IFrameRpcEvent, I as IFrameRpcSchema, j as IFrameTransport, P as PaidArticleUnlockPrice, R as RedirectRpcSchema, i as RpcResponse, c as SendTransactionActionParamsType, d as SendTransactionReturnType, e as SendTransactionTxType, g as SiweAuthenticateActionParamsType, f as SiweAuthenticateReturnType, h as SiweAuthenticationParams, S as StartArticleUnlockParams, b as StartArticleUnlockReturnType, U as UnlockOptionsReturnType, W as WalletStatusReturnType } from '../client--U_6SK0l.cjs';
+export { P as PreparedInteraction, S as SendInteractionParamsType, a as SendInteractionReturnType } from '../interaction-D_CzyqRE.cjs';
+export { F as FrakRpcError, R as RpcErrorCodes } from '../error-C4Zm5nQe.cjs';
 import 'viem';
 import 'viem/chains';
+import 'viem/siwe';
 
 /**
  * Create a new iframe Nexus client
@@ -41,43 +44,13 @@ type KeyProvider<DataType> = (value: DataType) => string[];
 /**
  * Compress the given params, and add hash protection to (rapidly) prevent interception modification
  * @param data The params to encode
- * @param keyProvider The method used to access the keys
  */
-declare function hashAndCompressData<T>(data: T, keyProvider: KeyProvider<T>): Promise<CompressedData>;
+declare function hashAndCompressData<T>(data: T): Promise<CompressedData>;
 
 /**
  * Decompress the given string
  * @param compressedData The params to encode
- * @param keyAccessor The key accessor used to query the keys used for the validation hash
  */
-declare function decompressDataAndCheckHash<T>(compressedData: CompressedData, keyAccessor: KeyProvider<T>): Promise<HashProtectedData<T>>;
+declare function decompressDataAndCheckHash<T>(compressedData: CompressedData): Promise<HashProtectedData<T>>;
 
-/**
- * Get the right request key provider for the given args
- * @param args
- */
-declare const iFrameRequestKeyProvider: KeyProvider<ExtractedParametersFromRpc<IFrameRpcSchema>>;
-type RpcResponseKeyProvider<TParameters extends Pick<ExtractedParametersFromRpc<IFrameRpcSchema>, "method">> = KeyProvider<ExtractedReturnTypeFromRpc<IFrameRpcSchema, Extract<ExtractedParametersFromRpc<IFrameRpcSchema>, {
-    method: TParameters["method"];
-}>>>;
-/**
- * Get the right response key provider for the given param
- * @param param
- */
-declare function getIFrameResponseKeyProvider<TParameters extends Pick<ExtractedParametersFromRpc<IFrameRpcSchema>, "method">>(param: TParameters): RpcResponseKeyProvider<TParameters>;
-
-/**
- * Get the right request key provider for the given args
- * @param args
- */
-declare const redirectRequestKeyProvider: KeyProvider<ExtractedParametersFromRpc<RedirectRpcSchema>>;
-type RedirectRpcResponseKeyProvider<TMethod extends ExtractedParametersFromRpc<RedirectRpcSchema>["method"]> = KeyProvider<Extract<RedirectRpcSchema[number], {
-    Method: TMethod;
-}>["ReturnType"]>;
-/**
- * Get the right response key provider for the given redirect method
- * @param method
- */
-declare function getRedirectResponseResponseKeyProvider<TMethod extends ExtractedParametersFromRpc<RedirectRpcSchema>["method"]>(method: TMethod): RedirectRpcResponseKeyProvider<TMethod>;
-
-export { type CompressedData, ExtractedParametersFromRpc, ExtractedReturnTypeFromRpc, type HashProtectedData, IFrameRpcSchema, type KeyProvider, NexusClient, NexusWalletSdkConfig, RedirectRpcSchema, createIFrameNexusClient, createIframe, decompressDataAndCheckHash, getIFrameResponseKeyProvider, getRedirectResponseResponseKeyProvider, hashAndCompressData, iFrameRequestKeyProvider, redirectRequestKeyProvider };
+export { type CompressedData, type HashProtectedData, type KeyProvider, NexusClient, NexusWalletSdkConfig, createIFrameNexusClient, createIframe, decompressDataAndCheckHash, hashAndCompressData };

package/dist/core/index.d.ts

@@ -1,7 +1,10 @@
-import { a as NexusWalletSdkConfig, N as NexusClient, E as ExtractedParametersFromRpc, I as IFrameRpcSchema, c as ExtractedReturnTypeFromRpc, R as RedirectRpcSchema } from '../client-MgLVRfPw.js';
-export { A as ArticleUnlockStatusReturnType, f as IFrameEvent, e as IFrameRpcEvent, d as IFrameTransport, P as PaidArticleUnlockPrice, b as StartArticleUnlockParams, S as StartArticleUnlockReturnType, U as UnlockOptionsReturnType, W as WalletStatusReturnType } from '../client-MgLVRfPw.js';
+import { a as NexusWalletSdkConfig, N as NexusClient } from '../client-6_BJp7Ub.js';
+export { A as ArticleUnlockStatusReturnType, E as ExtractedParametersFromRpc, m as ExtractedReturnTypeFromRpc, l as IFrameEvent, k as IFrameRpcEvent, I as IFrameRpcSchema, j as IFrameTransport, P as PaidArticleUnlockPrice, R as RedirectRpcSchema, i as RpcResponse, c as SendTransactionActionParamsType, d as SendTransactionReturnType, e as SendTransactionTxType, g as SiweAuthenticateActionParamsType, f as SiweAuthenticateReturnType, h as SiweAuthenticationParams, S as StartArticleUnlockParams, b as StartArticleUnlockReturnType, U as UnlockOptionsReturnType, W as WalletStatusReturnType } from '../client-6_BJp7Ub.js';
+export { P as PreparedInteraction, S as SendInteractionParamsType, a as SendInteractionReturnType } from '../interaction-D_CzyqRE.js';
+export { F as FrakRpcError, R as RpcErrorCodes } from '../error-C4Zm5nQe.js';
 import 'viem';
 import 'viem/chains';
+import 'viem/siwe';
 
 /**
  * Create a new iframe Nexus client
@@ -41,43 +44,13 @@ type KeyProvider<DataType> = (value: DataType) => string[];
 /**
  * Compress the given params, and add hash protection to (rapidly) prevent interception modification
  * @param data The params to encode
- * @param keyProvider The method used to access the keys
  */
-declare function hashAndCompressData<T>(data: T, keyProvider: KeyProvider<T>): Promise<CompressedData>;
+declare function hashAndCompressData<T>(data: T): Promise<CompressedData>;
 
 /**
  * Decompress the given string
  * @param compressedData The params to encode
- * @param keyAccessor The key accessor used to query the keys used for the validation hash
  */
-declare function decompressDataAndCheckHash<T>(compressedData: CompressedData, keyAccessor: KeyProvider<T>): Promise<HashProtectedData<T>>;
+declare function decompressDataAndCheckHash<T>(compressedData: CompressedData): Promise<HashProtectedData<T>>;
 
-/**
- * Get the right request key provider for the given args
- * @param args
- */
-declare const iFrameRequestKeyProvider: KeyProvider<ExtractedParametersFromRpc<IFrameRpcSchema>>;
-type RpcResponseKeyProvider<TParameters extends Pick<ExtractedParametersFromRpc<IFrameRpcSchema>, "method">> = KeyProvider<ExtractedReturnTypeFromRpc<IFrameRpcSchema, Extract<ExtractedParametersFromRpc<IFrameRpcSchema>, {
-    method: TParameters["method"];
-}>>>;
-/**
- * Get the right response key provider for the given param
- * @param param
- */
-declare function getIFrameResponseKeyProvider<TParameters extends Pick<ExtractedParametersFromRpc<IFrameRpcSchema>, "method">>(param: TParameters): RpcResponseKeyProvider<TParameters>;
-
-/**
- * Get the right request key provider for the given args
- * @param args
- */
-declare const redirectRequestKeyProvider: KeyProvider<ExtractedParametersFromRpc<RedirectRpcSchema>>;
-type RedirectRpcResponseKeyProvider<TMethod extends ExtractedParametersFromRpc<RedirectRpcSchema>["method"]> = KeyProvider<Extract<RedirectRpcSchema[number], {
-    Method: TMethod;
-}>["ReturnType"]>;
-/**
- * Get the right response key provider for the given redirect method
- * @param method
- */
-declare function getRedirectResponseResponseKeyProvider<TMethod extends ExtractedParametersFromRpc<RedirectRpcSchema>["method"]>(method: TMethod): RedirectRpcResponseKeyProvider<TMethod>;
-
-export { type CompressedData, ExtractedParametersFromRpc, ExtractedReturnTypeFromRpc, type HashProtectedData, IFrameRpcSchema, type KeyProvider, NexusClient, NexusWalletSdkConfig, RedirectRpcSchema, createIFrameNexusClient, createIframe, decompressDataAndCheckHash, getIFrameResponseKeyProvider, getRedirectResponseResponseKeyProvider, hashAndCompressData, iFrameRequestKeyProvider, redirectRequestKeyProvider };
+export { type CompressedData, type HashProtectedData, type KeyProvider, NexusClient, NexusWalletSdkConfig, createIFrameNexusClient, createIframe, decompressDataAndCheckHash, hashAndCompressData };

package/dist/core/index.js

@@ -1,22 +1,19 @@
 import {
   createIFrameNexusClient
-} from "../chunk-OXP3VK26.js";
+} from "../chunk-HOX3RRO6.js";
 import {
+  FrakRpcError,
+  RpcErrorCodes,
   createIframe,
   decompressDataAndCheckHash,
-  getIFrameResponseKeyProvider,
-  getRedirectResponseResponseKeyProvider,
-  hashAndCompressData,
-  iFrameRequestKeyProvider,
-  redirectRequestKeyProvider
-} from "../chunk-5QWG35A2.js";
+  hashAndCompressData
+} from "../chunk-TPC5PMRC.js";
+import "../chunk-PKBMQBKP.js";
 export {
+  FrakRpcError,
+  RpcErrorCodes,
   createIFrameNexusClient,
   createIframe,
   decompressDataAndCheckHash,
-  getIFrameResponseKeyProvider,
-  getRedirectResponseResponseKeyProvider,
-  hashAndCompressData,
-  iFrameRequestKeyProvider,
-  redirectRequestKeyProvider
+  hashAndCompressData
 };

package/dist/core/interactions/index.cjs

@@ -0,0 +1,9 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+var _chunkNIFJZD3Mcjs = require('../../chunk-NIFJZD3M.cjs');
+require('../../chunk-ETV4XYOV.cjs');
+
+
+
+exports.PressActionsSelector = _chunkNIFJZD3Mcjs.PressActionsSelector; exports.PressInteractionEncoder = _chunkNIFJZD3Mcjs.PressInteractionEncoder;

package/dist/core/interactions/index.d.cts

@@ -0,0 +1,39 @@
+import { Hex, Address } from 'viem';
+import { P as PreparedInteraction } from '../../interaction-D_CzyqRE.cjs';
+
+/**
+ * All the press interactions actions
+ */
+declare const PressActionsSelector: {
+    readonly OpenArticle: "0xc0a24ffb";
+    readonly ReadArticle: "0xd5bd0fbe";
+    readonly Referred: "0x3d1508ad";
+};
+/**
+ * Encode an open article interaction
+ * @param articleId
+ */
+declare function openArticle({ articleId }: {
+    articleId: Hex;
+}): PreparedInteraction;
+/**
+ * Encode a read article interaction
+ * @param articleId
+ */
+declare function readArticle({ articleId }: {
+    articleId: Hex;
+}): PreparedInteraction;
+/**
+ * Encode a referred interaction
+ * @param referrer
+ */
+declare function referred({ referrer }: {
+    referrer: Address;
+}): PreparedInteraction;
+declare const PressInteractionEncoder: {
+    openArticle: typeof openArticle;
+    readArticle: typeof readArticle;
+    referred: typeof referred;
+};
+
+export { PressActionsSelector, PressInteractionEncoder };

package/dist/core/interactions/index.d.ts

@@ -0,0 +1,39 @@
+import { Hex, Address } from 'viem';
+import { P as PreparedInteraction } from '../../interaction-D_CzyqRE.js';
+
+/**
+ * All the press interactions actions
+ */
+declare const PressActionsSelector: {
+    readonly OpenArticle: "0xc0a24ffb";
+    readonly ReadArticle: "0xd5bd0fbe";
+    readonly Referred: "0x3d1508ad";
+};
+/**
+ * Encode an open article interaction
+ * @param articleId
+ */
+declare function openArticle({ articleId }: {
+    articleId: Hex;
+}): PreparedInteraction;
+/**
+ * Encode a read article interaction
+ * @param articleId
+ */
+declare function readArticle({ articleId }: {
+    articleId: Hex;
+}): PreparedInteraction;
+/**
+ * Encode a referred interaction
+ * @param referrer
+ */
+declare function referred({ referrer }: {
+    referrer: Address;
+}): PreparedInteraction;
+declare const PressInteractionEncoder: {
+    openArticle: typeof openArticle;
+    readArticle: typeof readArticle;
+    referred: typeof referred;
+};
+
+export { PressActionsSelector, PressInteractionEncoder };

package/dist/core/interactions/index.js

@@ -0,0 +1,9 @@
+import {
+  PressActionsSelector,
+  PressInteractionEncoder
+} from "../../chunk-72IEHEQX.js";
+import "../../chunk-PKBMQBKP.js";
+export {
+  PressActionsSelector,
+  PressInteractionEncoder
+};

package/dist/error-C4Zm5nQe.d.cts

@@ -0,0 +1,27 @@
+/**
+ * Generic Frak RPC error
+ */
+declare class FrakRpcError<T = undefined> extends Error {
+    code: number;
+    data?: T | undefined;
+    constructor(code: number, message: string, data?: T | undefined);
+}
+/**
+ * All the rpc error codes
+ */
+declare const RpcErrorCodes: {
+    readonly parseError: -32700;
+    readonly invalidRequest: -32600;
+    readonly methodNotFound: -32601;
+    readonly invalidParams: -32602;
+    readonly internalError: -32603;
+    readonly serverError: -32000;
+    readonly clientNotConnected: -32001;
+    readonly configError: -32002;
+    readonly corruptedResponse: -32003;
+    readonly clientAborted: -32004;
+    readonly walletNotConnected: -32005;
+    readonly noInteractionSession: -32006;
+};
+
+export { FrakRpcError as F, RpcErrorCodes as R };

package/dist/error-C4Zm5nQe.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Generic Frak RPC error
+ */
+declare class FrakRpcError<T = undefined> extends Error {
+    code: number;
+    data?: T | undefined;
+    constructor(code: number, message: string, data?: T | undefined);
+}
+/**
+ * All the rpc error codes
+ */
+declare const RpcErrorCodes: {
+    readonly parseError: -32700;
+    readonly invalidRequest: -32600;
+    readonly methodNotFound: -32601;
+    readonly invalidParams: -32602;
+    readonly internalError: -32603;
+    readonly serverError: -32000;
+    readonly clientNotConnected: -32001;
+    readonly configError: -32002;
+    readonly corruptedResponse: -32003;
+    readonly clientAborted: -32004;
+    readonly walletNotConnected: -32005;
+    readonly noInteractionSession: -32006;
+};
+
+export { FrakRpcError as F, RpcErrorCodes as R };

package/dist/interaction-D_CzyqRE.d.cts

@@ -0,0 +1,22 @@
+import { Hex } from 'viem';
+
+type PreparedInteraction = Readonly<{
+    handlerTypeDenominator: Hex;
+    interactionData: Hex;
+}>;
+/**
+ * Parameters of an interaction handling request
+ */
+type SendInteractionParamsType = {
+    contentId: Hex;
+    interaction: PreparedInteraction;
+    validation?: Hex;
+};
+/**
+ * Return type of the send interaction rpc request
+ */
+type SendInteractionReturnType = Readonly<{
+    hash: Hex;
+}>;
+
+export type { PreparedInteraction as P, SendInteractionParamsType as S, SendInteractionReturnType as a };

package/dist/interaction-D_CzyqRE.d.ts

@@ -0,0 +1,22 @@
+import { Hex } from 'viem';
+
+type PreparedInteraction = Readonly<{
+    handlerTypeDenominator: Hex;
+    interactionData: Hex;
+}>;
+/**
+ * Parameters of an interaction handling request
+ */
+type SendInteractionParamsType = {
+    contentId: Hex;
+    interaction: PreparedInteraction;
+    validation?: Hex;
+};
+/**
+ * Return type of the send interaction rpc request
+ */
+type SendInteractionReturnType = Readonly<{
+    hash: Hex;
+}>;
+
+export type { PreparedInteraction as P, SendInteractionParamsType as S, SendInteractionReturnType as a };