@silencelaboratories/walletprovider-sdk 0.0.6 → 0.0.7

package/README.md

@@ -1,13 +1,20 @@
 # walletprovider-sdk
 
-# Documentation
-
-Please refer to [documentation](./docs/walletprovider-sdk.md)
+The frontend library for Silent Network.
 
 # Demo
 
 Under the [demo](./demo) directory we provide the sample webpage that shows example usage of the library.
-In order to run it execute the following
+In order to run it execute the following:
+
+1. Build the library
+
+```
+bun install
+bun run build
+```
+
+2. Run the demo
 
 ```
 cd demo
@@ -15,7 +22,107 @@ npm install
 npm run dev
 ```
 
-# Build
+The demo fetches configuration from the `.env` file. We provided example `.env` [here](./demo/.env).
+
+The demo communicates with [backend service](#the-backend). Run it before using the demo page.
+
+# Using the library
+
+The library is published on [npmjs](https://www.npmjs.com/package/@silencelaboratories/walletprovider-sdk) registry.
+
+Install it in your project as usual:
+
+```
+npm i @silencelaboratories/walletprovider-sdk
+```
+
+## The backend
+
+The library communicates with backend service. The example implementation of such service is accessible [here](https://shipyard.rs/silencelaboratories/crates/wallet-provider-service). Please refer to backend documentation in order to run the service.
+
+Frontend uses [WalletProviderServiceClient](./docs/walletprovider-sdk.walletproviderserviceclient.md) object in order to connect to the backend and send requests.
+
+# Documentation
+
+For description of classes, interfaces, types, please refer to [documentation](./docs/walletprovider-sdk.md).
+
+## Keygen
+
+The full working example is in the [demo](./demo/src/routes/%2Bpage.svelte#L87).
+The core object to use is the [NetworkSigner](./docs/walletprovider-sdk.networksigner.md).
+
+It allows to generate keys and do signatures. In order to create, you need two other components. The [WalletProviderServiceClient](./docs/walletprovider-sdk.walletproviderserviceclient.md) that connects to the Backend part of the SDK, and the authentication module. Currently we provide EOA authentication via [EOAAuth](./docs/walletprovider-sdk.eoaauth.md).
+
+Let's create the `NetworkSigner`
+
+```ts
+const wpClient = await createWalletProviderService(clusterConfig);
+// Authenticate using EOA
+const eoaAuth = new EOAAuth(accountsFromBrowserWallet[0], new BrowserWallet());
+
+// Create a new signer instance
+const sdk = new NetworkSigner(wpClient, threshold, partiesNumber, eoaAuth);
+```
+
+Now you can generate a key, using the [authenticateAndCreateKey](./docs/walletprovider-sdk.networksigner.authenticateandcreatekey.md) method. The method accepts optional permissions. No permissions means _allow all operations_.
+
+```ts
+const permissions = {
+  permissions: [
+    {
+      type: 'erc20',
+      method: 'approve',
+      to: '0x1234567890123456789012345678901234567890',
+      args: {
+        spender: '0x1234567890123456789012345678901234567890',
+        value: 10000,
+        eq: '<',
+      },
+    },
+  ],
+};
+
+// Generate a new key
+let resp: KeygenResponse = await sdk.authenticateAndCreateKey(JSON.stringify(permissions));
+```
+
+Calling this method will cause to the Browser Wallet window to pop up, requesting the User to sign the request. After execution [KeygenResponse](./docs/walletprovider-sdk.keygenresponse.md) is returned.
+
+The [KeygenResponse](./docs/walletprovider-sdk.keygenresponse.md) contains `keyId` and `publicKey`. The `publicKey` is the public part of the key generated by Silent Network. Use the `keyId` in subsequent calls to sign.
+
+## Signing
+
+The full signing example is [here](./demo/src/routes/%2Bpage.svelte#L158).
+
+Use the [NetworkSigner.authenticateAndSign](./docs/walletprovider-sdk.networksigner.authenticateandsign.md) method in order to generate a signature.
+
+```ts
+let signMessage = JSON.stringify({
+  userOperation: {
+    sender: '0x8d4cb2540d993fe34c646299f1ab4af3012ff34c',
+    nonce: '0x7',
+    initCode: '',
+    callData: '0000189a...',
+    callGasLimit: '123130',
+    verificationGasLimit: '153427',
+    preVerificationGas: '66768',
+    maxFeePerGas: '',
+    maxPriorityFeePerGas: '',
+    paymasterAndData: '',
+  },
+  entryPointVersion: 'v0.6.0',
+  entryPointAddress: '0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789',
+  chainId: 80002,
+});
+
+let resp = await sdk.authenticateAndSign(selectedKeyId, signMessage);
+```
+
+The [SignResponse](./docs/walletprovider-sdk.signresponse.md) contains the signature `sign` and the recovery ID `recid`.
+
+# Developing the library
+
+Audience of this section are library developers.
 
 ## Bun runtime is required
 

package/dist/authentication.d.ts

@@ -33,6 +33,13 @@ export declare class EOAAuth implements AuthModule {
     /** An interface to the wallet, like MetaMask, that is used to sign the requests */
     browserWallet: IBrowserWallet;
     constructor(userId: string, browserWallet: IBrowserWallet);
+    /**
+     * Prepares a message to present on the Browser Wallet window and requests to sign it.
+     * @param setup - either Keygen or Sign setup options
+     * @param challenge - the challenge received from the backend
+     *
+     * @public
+     */
     authenticate({ setup, challenge, }: {
         setup: KeygenSetupOpts | SignSetupOpts;
         challenge: string;

package/dist/authentication.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"authentication.d.ts","sourceRoot":"","sources":["../src/authentication.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACjE,OAAO,EAAE,cAAc,EAAwB,MAAM,qBAAqB,CAAC;AAE3E;;GAEG;AACH,oBAAY,UAAU;IACpB,oDAAoD;IACpD,GAAG,IAAA;IACH,wBAAwB;IACxB,IAAI,IAAA;CACL;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EAAE,MAAM,CAAC;IAEf,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,WAAW,EAAE,eAAe,CAAC;IAC7B,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,WAAW,UAAU;IACzB,YAAY,CAAC,EACX,KAAK,EACL,SAAS,GACV,EAAE;QACD,KAAK,EAAE,eAAe,GAAG,aAAa,CAAC;QACvC,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;CACjC;AAED;;GAEG;AACH,qBAAa,OAAQ,YAAW,UAAU;IACxC,2EAA2E;IAC3E,MAAM,EAAE,MAAM,CAAC;IACf,mFAAmF;IACnF,aAAa,EAAE,cAAc,CAAC;gBAElB,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,cAAc;IAKnD,YAAY,CAAC,EACjB,KAAK,EACL,SAAS,GACV,EAAE;QACD,KAAK,EAAE,eAAe,GAAG,aAAa,CAAC;QACvC,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,kBAAkB,CAAC;CAQhC"}
+{"version":3,"file":"authentication.d.ts","sourceRoot":"","sources":["../src/authentication.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACjE,OAAO,EAAE,cAAc,EAAwB,MAAM,qBAAqB,CAAC;AAE3E;;GAEG;AACH,oBAAY,UAAU;IACpB,oDAAoD;IACpD,GAAG,IAAA;IACH,wBAAwB;IACxB,IAAI,IAAA;CACL;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,MAAM,CAAC;IAEX,MAAM,EAAE,MAAM,CAAC;IAEf,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,WAAW,EAAE,eAAe,CAAC;IAC7B,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,WAAW,UAAU;IACzB,YAAY,CAAC,EACX,KAAK,EACL,SAAS,GACV,EAAE;QACD,KAAK,EAAE,eAAe,GAAG,aAAa,CAAC;QACvC,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;CACjC;AAED;;GAEG;AACH,qBAAa,OAAQ,YAAW,UAAU;IACxC,2EAA2E;IAC3E,MAAM,EAAE,MAAM,CAAC;IACf,mFAAmF;IACnF,aAAa,EAAE,cAAc,CAAC;gBAElB,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,cAAc;IAKzD;;;;;;OAMG;IACG,YAAY,CAAC,EACjB,KAAK,EACL,SAAS,GACV,EAAE;QACD,KAAK,EAAE,eAAe,GAAG,aAAa,CAAC;QACvC,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,kBAAkB,CAAC;CAQhC"}

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export { NetworkSigner, SignResponse, KeygenResponse } from './networkSigner.ts';
 export { AuthMethod, EOAAuth } from './authentication.ts';
 export type { IBrowserWallet, TypedData } from './EOAauthentication.ts';
-export type { IWalletProviderServiceClient } from './walletProviderServiceClientInterface.ts';
+export type { ClientConfig, IWalletProviderServiceClient } from './walletProviderServiceClientInterface.ts';
 export { WalletProviderServiceClient } from './walletProviderServiceClient.ts';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACjF,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE1D,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAExE,YAAY,EAAE,4BAA4B,EAAE,MAAM,2CAA2C,CAAC;AAC9F,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACjF,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE1D,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAExE,YAAY,EAAE,YAAY,EAAE,4BAA4B,EAAE,MAAM,2CAA2C,CAAC;AAC5G,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC"}

package/dist/index.js

@@ -1 +1 @@
-function V(x){return x.message!==void 0}var K=1;class Z{t;n;key_label;metadata;constructor({t:x,n:H,key_label:B,permissions:F}){if(this.t=x,this.n=H,this.key_label=B,this.metadata=[],F)this.metadata.push([K,F])}}class ${authModule;threshold;totalNodes;wp_client;constructor(x,H,B,F){if(H===0)throw new Error("Threshold cannot be 0");this.threshold=H,this.totalNodes=B,this.authModule=F,this.wp_client=x}async authenticateAndCreateKey(x){try{const H=new Z({t:this.threshold,n:this.totalNodes,permissions:x});console.log("Generated Payload:",H);const B=(U)=>this.authModule.authenticate({setup:H,challenge:U}),F=await this.wp_client.startKeygen({setup:H,signer:B});return console.log("Keygen response:",F),F}catch(H){throw console.error(H),H}}async authenticateAndSign(x,H){const B={t:this.threshold,key_id:x,message:H},F=(J)=>this.authModule.authenticate({setup:B,challenge:J}),U=await this.wp_client.startSigngen({setup:B,signer:F});return console.log("Sign response:",U),U}}var E=function(x,H){const B={t:x.t,n:x.n,key_label:x.key_label,metadata:[]};return{types:{EIP712Domain:G,...y},domain:f,primaryType:"Request",message:{setup:B,challenge:H}}},W=function(x,H){return{types:{EIP712Domain:G,...A},domain:f,primaryType:"Request",message:{setup:x,challenge:H}}};async function T({setup:x,user_id:H,challenge:B,browserWallet:F}){let U;if(V(x))console.log("Creating Sign request"),U=W(x,B);else console.log("Creating Keygen request"),U=E(x,B);console.log("typed request:"),console.log(JSON.stringify(U,void 0,4));const J=await F.signTypedData(H,U);return console.log("User signed a request",J),{credentials:{credentials:H,method:"eoa",id:"id"},signature:J}}var N=[{name:"tag",type:"uint16"},{name:"value",type:"string"}],y={Request:[{name:"setup",type:"KeygenSetupOpts"},{name:"challenge",type:"string"}],KeygenSetupOpts:[{name:"t",type:"uint32"},{name:"n",type:"uint32"},{name:"metadata",type:"TaggedValue[]"}],TaggedValue:N},A={Request:[{name:"setup",type:"SignSetupOpts"},{name:"challenge",type:"string"}],SignSetupOpts:[{name:"t",type:"uint32"},{name:"key_id",type:"string"},{name:"message",type:"string"}]},f={name:"SilentShard authentication",version:"0.1.0"},G=[{name:"name",type:"string"},{name:"version",type:"string"}];var X;(function(B){B[B["EOA"]=0]="EOA";B[B["NONE"]=1]="NONE"})(X||(X={}));class D{userId;browserWallet;constructor(x,H){this.userId=x,this.browserWallet=H}async authenticate({setup:x,challenge:H}){return await T({setup:x,user_id:this.userId,challenge:H,browserWallet:this.browserWallet})}}var b=(x)=>btoa(String.fromCodePoint.apply(null,Array.from(x)));var z;(function(U){U[U["initiated"]=0]="initiated";U[U["waitingForSign"]=1]="waitingForSign";U[U["waitingForResult"]=2]="waitingForResult";U[U["finished"]=3]="finished"})(z||(z={}));class C{walletProviderId;walletProviderUrl;constructor(x){this.walletProviderId=x.walletProviderId,this.walletProviderUrl=x.walletProviderUrl}getWalletId(){return this.walletProviderId}async startKeygen({setup:x,signer:H}){return this.connect(x,H).then((B)=>{const F=B.split(":"),U=F[1].split("=")[1],J=F[0].split("=")[1];return{publicKey:U,keyId:J}})}async startSigngen({setup:x,signer:H}){return this.connect(x,H).then((B)=>{const F=B.split(":"),U=F[0].split("=")[1],J=F[1].split("=")[1];return{sign:U,recid:parseInt(J)}})}connect(x,H){return new Promise((B,F)=>{let U=z.initiated,J;if(V(x))J="signgen",x.message=b((new TextEncoder()).encode(x.message));else J="keygen";const Q=new WebSocket(`${this.walletProviderUrl}/${J}`);Q.addEventListener("open",(L)=>{switch(console.log(`Connection opened in state ${U} with event ${JSON.stringify(L,void 0,"\t")}`),U){case z.initiated:U=z.waitingForSign,console.log(`Sending setup: ${JSON.stringify(x)}`),Q.send(JSON.stringify(x));break;case z.waitingForSign:case z.waitingForResult:U=z.finished,F("Incorrect protocol state");break;case z.finished:break}}),Q.addEventListener("message",async(L)=>{switch(console.log(`Connection message in state ${U} with event ${JSON.stringify(L,void 0,"\t")}`),U){case z.initiated:U=z.finished,F("Incorrect protocol state");break;case z.waitingForSign:{U=z.waitingForResult;const Y=await H(L.data);console.log(`Sending signature: ${JSON.stringify(Y)}`),Q.send(JSON.stringify(Y));break}case z.waitingForResult:U=z.finished,Q.close(),B(L.data);break;case z.finished:break}}),Q.addEventListener("error",(L)=>{if(console.log(`Connection error in state ${U} with event ${JSON.stringify(L,void 0,"\t")}`),U!=z.finished)U=z.finished,F("Incorrect protocol state")}),Q.addEventListener("close",(L)=>{if(console.log(`Connection closed in state ${U} with event ${JSON.stringify(L,void 0,"\t")}`),U!=z.finished)U=z.finished,F("Incorrect protocol state")})})}}export{C as WalletProviderServiceClient,$ as NetworkSigner,D as EOAAuth,X as AuthMethod};
+function V(x){return x.message!==void 0}var N=1;class Z{t;n;key_label;metadata;constructor({t:x,n:H,key_label:F,permissions:z}){if(this.t=x,this.n=H,this.key_label=F,this.metadata=[],z)this.metadata.push([N,z])}}class ${authModule;threshold;totalNodes;wp_client;constructor(x,H,F,z){if(H===0)throw new Error("Threshold cannot be 0");this.threshold=H,this.totalNodes=F,this.authModule=z,this.wp_client=x}async authenticateAndCreateKey(x){try{const H=new Z({t:this.threshold,n:this.totalNodes,permissions:x});console.log("Generated Payload:",H);const F=(U)=>this.authModule.authenticate({setup:H,challenge:U}),z=await this.wp_client.startKeygen({setup:H,signer:F});return console.log("Keygen response:",z),z}catch(H){throw console.error(H),H}}async authenticateAndSign(x,H){const F={t:this.threshold,key_id:x,message:H},z=(J)=>this.authModule.authenticate({setup:F,challenge:J}),U=await this.wp_client.startSigngen({setup:F,signer:z});return console.log("Sign response:",U),U}}var q=function(x,H){const F={t:x.t,n:x.n,key_label:x.key_label,metadata:[]};return{types:{EIP712Domain:G,...K},domain:f,primaryType:"Request",message:{setup:F,challenge:H}}},y=function(x,H){return{types:{EIP712Domain:G,...b},domain:f,primaryType:"Request",message:{setup:x,challenge:H}}};async function T({setup:x,user_id:H,challenge:F,browserWallet:z}){let U;if(V(x))console.log("Creating Sign request"),U=y(x,F);else console.log("Creating Keygen request"),U=q(x,F);console.log("typed request:"),console.log(JSON.stringify(U,void 0,4));const J=await z.signTypedData(H,U);return console.log("User signed a request",J),{credentials:{credentials:H,method:"eoa",id:"id"},signature:J}}var E=[{name:"tag",type:"uint16"},{name:"value",type:"string"}],K={Request:[{name:"setup",type:"KeygenSetupOpts"},{name:"challenge",type:"string"}],KeygenSetupOpts:[{name:"t",type:"uint32"},{name:"n",type:"uint32"},{name:"metadata",type:"TaggedValue[]"}],TaggedValue:E},b={Request:[{name:"setup",type:"SignSetupOpts"},{name:"challenge",type:"string"}],SignSetupOpts:[{name:"t",type:"uint32"},{name:"key_id",type:"string"},{name:"message",type:"string"}]},f={name:"SilentShard authentication",version:"0.1.0"},G=[{name:"name",type:"string"},{name:"version",type:"string"}];var X;(function(F){F[F["EOA"]=0]="EOA";F[F["NONE"]=1]="NONE"})(X||(X={}));class D{userId;browserWallet;constructor(x,H){this.userId=x,this.browserWallet=H}async authenticate({setup:x,challenge:H}){return await T({setup:x,user_id:this.userId,challenge:H,browserWallet:this.browserWallet})}}var A=(x)=>btoa(String.fromCodePoint.apply(null,Array.from(x)));var B;(function(U){U[U["initiated"]=0]="initiated";U[U["waitingForSign"]=1]="waitingForSign";U[U["waitingForResult"]=2]="waitingForResult";U[U["finished"]=3]="finished"})(B||(B={}));class C{walletProviderId;walletProviderUrl;constructor(x){this.walletProviderId=x.walletProviderId,this.walletProviderUrl=x.walletProviderUrl}getWalletId(){return this.walletProviderId}async startKeygen({setup:x,signer:H}){return this.connect(x,H).then((F)=>{const z=F.split(":"),U=z[1].split("=")[1],J=z[0].split("=")[1];return{publicKey:U,keyId:J}})}async startSigngen({setup:x,signer:H}){return this.connect(x,H).then((F)=>{const z=F.split(":"),U=z[0].split("=")[1],J=z[1].split("=")[1];return{sign:U,recid:parseInt(J)}})}connect(x,H){return new Promise((F,z)=>{let U=B.initiated,J;if(V(x))J="signgen",x.message=A((new TextEncoder()).encode(x.message));else J="keygen";const Q=new WebSocket(`${this.walletProviderUrl}/${J}`);Q.addEventListener("open",(L)=>{switch(console.log(`Connection opened in state ${U} with event ${JSON.stringify(L,void 0,"\t")}`),U){case B.initiated:U=B.waitingForSign,console.log(`Sending setup: ${JSON.stringify(x)}`),Q.send(JSON.stringify(x));break;case B.waitingForSign:case B.waitingForResult:U=B.finished,z("Incorrect protocol state");break;case B.finished:break}}),Q.addEventListener("message",async(L)=>{switch(console.log(`Connection message in state ${U} with event ${JSON.stringify(L,void 0,"\t")}`),U){case B.initiated:U=B.finished,z("Incorrect protocol state");break;case B.waitingForSign:{U=B.waitingForResult;const Y=await H(L.data);console.log(`Sending signature: ${JSON.stringify(Y)}`),Q.send(JSON.stringify(Y));break}case B.waitingForResult:U=B.finished,Q.close(),F(L.data);break;case B.finished:break}}),Q.addEventListener("error",(L)=>{if(console.log(`Connection error in state ${U} with event ${JSON.stringify(L,void 0,"\t")}`),U!=B.finished)U=B.finished,z("Incorrect protocol state")}),Q.addEventListener("close",(L)=>{if(console.log(`Connection closed in state ${U} with event ${JSON.stringify(L,void 0,"\t")}`),U!=B.finished)U=B.finished,z("Incorrect protocol state")})})}}export{C as WalletProviderServiceClient,$ as NetworkSigner,D as EOAAuth,X as AuthMethod};

package/dist/networkSigner.d.ts

@@ -77,7 +77,7 @@ export declare class NetworkSigner {
      * @param permissions - optional permissions that will be stored in the key metadata.
      * The permissions are validated during sign requests.
      * @returns {@link KeygenResponse} containing `keyId` and the `pubKey` public part of the key
-     *
+     * @public
      * @alpha
      */
     authenticateAndCreateKey(permissions?: string): Promise<KeygenResponse>;
@@ -86,6 +86,7 @@ export declare class NetworkSigner {
      * @param keyId - the key id returned from `authenticateAndCreateKey`
      * @param message - the message to sign by the MPC network
      * @returns {@link SignResponse}
+     * @public
      * @alpha
      */
     authenticateAndSign(keyId: string, message: string): Promise<SignResponse>;

package/dist/networkSigner.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"networkSigner.d.ts","sourceRoot":"","sources":["../src/networkSigner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AACrE,OAAO,EAAU,KAAK,4BAA4B,EAAE,MAAM,2CAA2C,CAAC;AAEtG;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAGD,6CAA6C;AAC7C,qBAAa,eAAe;IAC1B,+GAA+G;IAC/G,CAAC,EAAE,MAAM,CAAC;IACV,kGAAkG;IAClG,CAAC,EAAE,MAAM,CAAC;IACV,yBAAyB;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;gBAEjB,EAAE,CAAC,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE;CAUjH;AAED,6CAA6C;AAC7C,MAAM,MAAM,aAAa,GAAG;IAC1B,uEAAuE;IACvE,CAAC,EAAE,MAAM,CAAC;IACV,mCAAmC;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,0BAA0B;IAC1B,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,kEAAkE;AAClE,wBAAgB,eAAe,CAAC,MAAM,EAAE,eAAe,GAAG,aAAa,GAAG,MAAM,IAAI,aAAa,CAEhG;AAED,+EAA+E;AAC/E,MAAM,MAAM,wBAAwB,CAAC,CAAC,IAAI;IACxC,KAAK,EAAE,CAAC,CAAC;IACT,mBAAmB,EAAE,kBAAkB,CAAC;CACzC,CAAC;AAEF;;;GAGG;AACH,qBAAa,aAAa;IACxB,6FAA6F;IAC7F,UAAU,EAAE,UAAU,CAAC;IACvB,qHAAqH;IACrH,SAAS,EAAE,MAAM,CAAC;IAClB,+EAA+E;IAC/E,UAAU,EAAE,MAAM,CAAC;IACnB,qCAAqC;IACrC,SAAS,EAAE,4BAA4B,CAAC;IAExC;;;;;;OAMG;gBACS,QAAQ,EAAE,4BAA4B,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU;IAYjH;;;;;;;OAOG;IACG,wBAAwB,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAuB7E;;;;;;OAMG;IACG,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;CAejF"}
+{"version":3,"file":"networkSigner.d.ts","sourceRoot":"","sources":["../src/networkSigner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AACrE,OAAO,EAAU,KAAK,4BAA4B,EAAE,MAAM,2CAA2C,CAAC;AAEtG;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAGD,6CAA6C;AAC7C,qBAAa,eAAe;IAC1B,+GAA+G;IAC/G,CAAC,EAAE,MAAM,CAAC;IACV,kGAAkG;IAClG,CAAC,EAAE,MAAM,CAAC;IACV,yBAAyB;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;gBAEjB,EAAE,CAAC,EAAE,CAAC,EAAE,SAAS,EAAE,WAAW,EAAE,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE;CAUjH;AAED,6CAA6C;AAC7C,MAAM,MAAM,aAAa,GAAG;IAC1B,uEAAuE;IACvE,CAAC,EAAE,MAAM,CAAC;IACV,mCAAmC;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,0BAA0B;IAC1B,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,kEAAkE;AAClE,wBAAgB,eAAe,CAAC,MAAM,EAAE,eAAe,GAAG,aAAa,GAAG,MAAM,IAAI,aAAa,CAEhG;AAED,+EAA+E;AAC/E,MAAM,MAAM,wBAAwB,CAAC,CAAC,IAAI;IACxC,KAAK,EAAE,CAAC,CAAC;IACT,mBAAmB,EAAE,kBAAkB,CAAC;CACzC,CAAC;AAEF;;;GAGG;AACH,qBAAa,aAAa;IACxB,6FAA6F;IAC7F,UAAU,EAAE,UAAU,CAAC;IACvB,qHAAqH;IACrH,SAAS,EAAE,MAAM,CAAC;IAClB,+EAA+E;IAC/E,UAAU,EAAE,MAAM,CAAC;IACnB,qCAAqC;IACrC,SAAS,EAAE,4BAA4B,CAAC;IAExC;;;;;;OAMG;gBACS,QAAQ,EAAE,4BAA4B,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU;IAYjH;;;;;;;OAOG;IACU,wBAAwB,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAuBpF;;;;;;;OAOG;IACU,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;CAexF"}

package/dist/walletProviderServiceClient.d.ts

@@ -8,6 +8,10 @@ import { type ClientConfig, IWalletProviderServiceClient, type Signer } from './
 export declare class WalletProviderServiceClient implements IWalletProviderServiceClient {
     walletProviderId: string;
     walletProviderUrl: string;
+    /**
+     * Create new client that connects to the backend service
+     * @param config - config containing information about backend service
+     */
     constructor(config: ClientConfig);
     getWalletId(): string;
     startKeygen({ setup, signer }: {

package/dist/walletProviderServiceClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"walletProviderServiceClient.d.ts","sourceRoot":"","sources":["../src/walletProviderServiceClient.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,YAAY,EAElB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,KAAK,YAAY,EAAE,4BAA4B,EAAE,KAAK,MAAM,EAAE,MAAM,wCAAwC,CAAC;AAStH;;;;GAIG;AACH,qBAAa,2BAA4B,YAAW,4BAA4B;IAC9E,gBAAgB,EAAE,MAAM,CAAC;IACzB,iBAAiB,EAAE,MAAM,CAAC;gBAEd,MAAM,EAAE,YAAY;IAKhC,WAAW,IAAI,MAAM;IAIf,WAAW,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;QAAE,KAAK,EAAE,eAAe,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC;IAYnG,YAAY,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;QAAE,KAAK,EAAE,aAAa,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,CAAC;IAatG,OAAO,CAAC,MAAM,EAAE,eAAe,GAAG,aAAa,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAkFlF"}
+{"version":3,"file":"walletProviderServiceClient.d.ts","sourceRoot":"","sources":["../src/walletProviderServiceClient.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,YAAY,EAElB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,KAAK,YAAY,EAAE,4BAA4B,EAAE,KAAK,MAAM,EAAE,MAAM,wCAAwC,CAAC;AAStH;;;;GAIG;AACH,qBAAa,2BAA4B,YAAW,4BAA4B;IAC9E,gBAAgB,EAAE,MAAM,CAAC;IACzB,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;;OAGG;gBACS,MAAM,EAAE,YAAY;IAKhC,WAAW,IAAI,MAAM;IAIf,WAAW,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;QAAE,KAAK,EAAE,eAAe,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC;IAYnG,YAAY,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;QAAE,KAAK,EAAE,aAAa,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,CAAC;IAatG,OAAO,CAAC,MAAM,EAAE,eAAe,GAAG,aAAa,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CAkFlF"}

package/dist/walletProviderServiceClientInterface.d.ts

@@ -1,9 +1,22 @@
 import { UserAuthentication } from './authentication';
 import { KeygenResponse, KeygenSetupOpts, SignResponse, SignSetupOpts } from './networkSigner';
+/**
+ * The config used to create Wallet Provider Service backend client.
+ * Please refer to {@link https://shipyard.rs/silencelaboratories/crates/wallet-provider-service | example backend service}
+ * implementation for requirements that the backend service must fulfill.
+ * @alpha
+ */
 export type ClientConfig = {
+    /**
+     * The id of the Wallet Provider Service
+     * @alpha
+     */
     walletProviderId: string;
+    /**
+     * The URL used to connect to the service
+     * @alpha
+     */
     walletProviderUrl: string;
-    secretKey: string;
 };
 export type Signer = (challenge: string) => Promise<UserAuthentication>;
 /** Interface for client of  Wallet Provider Service

package/dist/walletProviderServiceClientInterface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"walletProviderServiceClientInterface.d.ts","sourceRoot":"","sources":["../src/walletProviderServiceClientInterface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAE/F,MAAM,MAAM,YAAY,GAAG;IACzB,gBAAgB,EAAE,MAAM,CAAC;IACzB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG,CAAC,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAExE;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,WAAW,IAAI,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;QAAE,KAAK,EAAE,eAAe,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IACpG,YAAY,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;QAAE,KAAK,EAAE,aAAa,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;CAClG"}
+{"version":3,"file":"walletProviderServiceClientInterface.d.ts","sourceRoot":"","sources":["../src/walletProviderServiceClientInterface.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAE/F;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG,CAAC,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAExE;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,WAAW,IAAI,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;QAAE,KAAK,EAAE,eAAe,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IACpG,YAAY,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;QAAE,KAAK,EAAE,aAAa,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;CAClG"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@silencelaboratories/walletprovider-sdk",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "Frontend SDK for Wallet Providers",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",