{"dist":{"shasum":"6b3a3affaf5da05b463aab10643be5da01c2e5fe","tarball":"https://registry.npmjs.org/@walletconnect/client/-/client-2.0.0-alpha.25.tgz","fileCount":69,"integrity":"sha512-lB7clY9Da8jcukqePCcw0vRzo4XpPv6msEdfKkYnqSphNhTnxYLeJo/reUdfPjSdMcbQjPbdz6pgQQlNc0tBKQ==","signatures":[{"sig":"MEYCIQClBJJbwr0MrbLqeyLk5T8xTQKbEp4PvaMbSvluCnmQtAIhAMzyKuAWHoyq7CxtnKJoDWD9xs2N2JPNF4PAQvH3ulFO","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1201553,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgLtxaCRA9TVsSAnZWagAAqLMP+QAM0Deu9lY/9EpgA9Iu\ndzMo4Wn15jAtP6SCjqNYl/KybBnA3H0WcoUe5tXuBTbn2XHXhFeTnPmI547p\nWx80Vk8yodXvQncKRJN03LsOnj4Rwl6ITkCRSxY2JC6lZDWFhJD+VEovr9Kw\nN0QUc4Mw637ibdohcn7BMhXDmHhDDUhZKIo5VtPvwVZ8aSaMhj8eIP5jHtAm\nT74oHj6TF1NqA+bORatx5W6gYcTsNNJQeuOlt3V/Yg1PB4b/Pfq2mzANsjV+\nEz65U+rN0vPZ8IE5W33dEvO520pPAdmYJnMyZ4qed2pDJvtPcKbKXla8x1J4\nQyqbuIvfGanM4MdzjidhSEDQfiNmLWMyZdSA5Z8f1Q5mIWV0yKHMEQo+wfie\nkGsPfpGTE7oeT47cKfC56uOmKWbqn3XRKNuU7x7GA6qchu9OkWTnBcMCEdQC\nwhv2pQemRAaFA2jhP5gHN+jeeo9ZPdT8R30A8e49nf+0mgMNZkG5t74rWJ/a\n3X3amF+Db3ysFcWUh/AlUOuuZT1x5pjNO0HXtyHYWEQ+PZNs4es9k7H6LPmS\n65sgqdfzlaxof7bq85l0PIY4VuQVQM6ru2ql+4U7mGasqLo2DmfVffXSkz8B\nIad8MKcA2GHjB2Mrv0uds44XckkIVsHzhNCHzPFhknICff7hH9f8klFb5eqG\nQz77\r\n=Zt7P\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/cjs/index.js","name":"@walletconnect/client","types":"dist/cjs/index.d.ts","unpkg":"dist/umd/index.min.js","author":{"name":"WalletConnect Labs","email":"walletconnectlabs.com"},"readme":"# @walletconnect/client\n\nClient for WalletConnect Protocol\n\n## Description\n\nThis library provides a Standalone Client for WalletConnect 2.0 Protocol for both Dapps and Wallets. Integration will differ from the perspective of each client as the Proposer and Responder, respectively. It's compatible with NodeJS, Browser and React-Native applications (NodeJS modules required to be polyfilled for React-Native)\n\n## Install\n\n```bash\nyarn add @walletconnect/client\n# OR\n\nnpm install --save @walletconnect/client\n```\n\n## Create Session\n\nThis quick start example will describe how an integration should be followed for both Dapps and Wallets respectively\n\n### Dapps\n\n1. Initiate your WalletConnect client with the relay server\n\n```js\nimport WalletConnectClient from \"@walletconnect/client\";\n\nconst client = await WalletConnectClient.init({ relayProvider: \"wss://staging.walletconnect.org\" });\n```\n\n2. Subscribe to pairing proposal event for sharing URI\n\n```js\nimport { CLIENT_EVENTS } from \"@walletconnect/client\";\nimport { PairingTypes } from \"@walletconnect/types\";\n\nclient.on(CLIENT_EVENTS.pairing.proposal, async (proposal: PairingTypes.Proposal) => {\n  // uri should be shared with the Wallet either through QR Code scanning or mobile deep linking\n  const { uri } = proposal.signal.params;\n});\n```\n\n3. Connect application and specify session permissions\n\n```js\nconst session = await client.connect({\n  metadata: {\n    name: \"Example Dapp\",\n    description: \"Example Dapp\",\n    url: \"#\",\n    icons: [\"https://walletconnect.org/walletconnect-logo.png\"],\n  },\n  permissions: {\n    blockchain: {\n      chains: [\"eip155:1\"],\n    },\n    jsonrpc: {\n      methods: [\"eth_sendTransaction\", \"personal_sign\", \"eth_signTypedData\"],\n    },\n  },\n});\n```\n\n### Wallets\n\n1. Initiate your WalletConnect client with the relay server\n\n```js\nimport WalletConnectClient from \"@walletconnect/client\";\n\nconst client = await WalletConnectClient.init({ relayProvider: \"wss://staging.walletconnect.org\" });\n```\n\n2. Subscribe to session proposal event for user approval and session created when successful\n\n```js\nimport { CLIENT_EVENTS } from \"@walletconnect/client\";\nimport { SessionTypes } from \"@walletconnect/types\";\n\nclient.on(CLIENT_EVENTS.session.proposal, async (proposal: SessionTypes.Proposal) => {\n  // user should be prompted to approve the proposed session permissions displaying also dapp metadata\n  const { proposer, permissions } = proposal;\n  const { metadata } = proposer;\n  let approved: boolean;\n  handleSessionUserApproval(approved, proposal); // described in the step 4\n});\n\nclient.on(CLIENT_EVENTS.session.created, async (session: SessionTypes.Created) => {\n  // session created succesfully\n});\n```\n\n3. Establish pairing with shared URI from dapp\n\n```js\nclient.pair({ uri });\n```\n\n4. Handle user approval for proposed session\n\n```js\nfunction handleSessionUserApproval(approved: boolean, proposal: SessionTypes.Proposal) {\n  if (userApproved) {\n    // if user approved then include response with accounts matching the chains and wallet metadata\n    const response: SessionTypes.Response = {\n      metadata: {\n        name: \"Test Wallet\",\n        description: \"Test Wallet\",\n        url: \"#\",\n        icons: [\"https://walletconnect.org/walletconnect-logo.png\"],\n      },\n      state: {\n        accounts: [\"0x1d85568eEAbad713fBB5293B45ea066e552A90De@eip155:1\"],\n      },\n    }\n    await client.approve({ proposal, response });\n  } else {\n    // if user didn't approve then reject with no response\n    await client.reject({ proposal });\n  }\n}\n```\n\n## JSON-RPC Payloads\n\n### Dapps\n\nOnce the session has been succesfull then you can start making JSON-RPC requests to be approved and signed by the wallet\n\n```js\nconst result = await client.request({\n  topic: session.topic,\n  chainId: \"eip155:1\",\n  request: {\n    id: 1,\n    jsonrpc: \"2.0\",\n    method: \"personal_sign\",\n    params: [\n      \"0x1d85568eEAbad713fBB5293B45ea066e552A90De\",\n      \"0x7468697320697320612074657374206d65737361676520746f206265207369676e6564\",\n    ],\n  },\n});\n```\n\n### Wallets\n\nGiven that session has settled succesfully since user approved the session on the wallet side, then the Wallet should subscribe to session payload events on the client\n\n```js\nimport { CLIENT_EVENTS } from \"@walletconnect/client\";\nimport { SessionTypes } from \"@walletconnect/types\";\nimport { JsonRpcResponse } from \"@json-rpc-tools/utils\";\n\nclient.on(CLIENT_EVENTS.session.payload, async (payloadEvent: SessionTypes.PayloadEvent) => {\n  // WalletConnect client can track multiple sessions\n  // assert the topic from which application requested\n  const { topic, payload } = payloadEvent;\n  const session = await client.session.get(payloadEvent.topic);\n  // now you can display to the user for approval using the stored metadata\n  const { metadata } = session.peer;\n  // after user has either approved or not the request it should be formatted\n  // as response with either the result or the error message\n  let result: any;\n  const response = approved\n    ? {\n        topic,\n        response: {\n          id: payload.id,\n          jsonrpc: \"2.0\",\n          result,\n        },\n      }\n    : {\n        topic,\n        response: {\n          id: payload.id,\n          jsonrpc: \"2.0\",\n          error: {\n            code: -32000,\n            message: \"User rejected JSON-RPC request\",\n          },\n        },\n      };\n  await client.respond(response);\n});\n```\n\n## API\n\n```typescript\nexport interface ClientOptions {\n  logger?: string | Logger;\n  storage?: IKeyValueStorage;\n  relayProvider?: string | IJsonRpcProvider;\n  overrideContext?: string;\n}\n\nexport abstract class IClient extends IEvents {\n  public readonly protocol = \"wc\";\n  public readonly version = 2;\n\n  public abstract logger: Logger;\n\n  public abstract relayer: IRelayer;\n  public abstract storage: IKeyValueStorage;\n\n  public abstract pairing: IPairing;\n  public abstract session: ISession;\n\n  constructor(opts?: ClientOptions) {\n    super();\n  }\n\n  // for proposer to propose a session to a responder\n  public abstract connect(params: ClientTypes.ConnectParams): Promise<SessionTypes.Settled>;\n  // for responder to receive a session proposal from a proposer\n  public abstract pair(params: ClientTypes.PairParams): Promise<void>;\n\n  // for responder to approve a session proposal\n  public abstract approve(params: ClientTypes.ApproveParams): Promise<SessionTypes.Settled>;\n  // for responder to reject a session proposal\n  public abstract reject(params: ClientTypes.RejectParams): Promise<void>;\n\n  // for responder to update session state\n  public abstract update(params: ClientTypes.UpdateParams): Promise<void>;\n  // for either to send notifications\n  public abstract notify(params: ClientTypes.NotifyParams): Promise<void>;\n\n  // for proposer to request JSON-RPC\n  public abstract request(params: ClientTypes.RequestParams): Promise<any>;\n  // for responder to respond JSON-RPC\n  public abstract respond(params: ClientTypes.RespondParams): Promise<void>;\n\n  // for either to disconnect a session\n  public abstract disconnect(params: ClientTypes.DisconnectParams): Promise<void>;\n}\n\nexport declare namespace ClientTypes {\n  export interface ConnectParams {\n    metadata: SessionTypes.Metadata;\n    permissions: SessionTypes.BasePermissions;\n    relay?: RelayerTypes.ProtocolOptions;\n    pairing?: SignalTypes.ParamsPairing;\n  }\n\n  export interface PairParams {\n    uri: string;\n  }\n\n  export interface ApproveParams {\n    proposal: SessionTypes.Proposal;\n    response: SessionTypes.Response;\n  }\n  export interface RejectParams {\n    proposal: SessionTypes.Proposal;\n  }\n\n  export type UpdateParams = SessionTypes.UpdateParams;\n\n  export type NotifyParams = SessionTypes.NotifyParams;\n\n  export interface RequestParams {\n    topic: string;\n    request: RequestArguments;\n    chainId?: string;\n  }\n\n  export interface RespondParams {\n    topic: string;\n    response: JsonRpcResponse;\n  }\n\n  export interface DisconnectParams {\n    topic: string;\n    reason: string;\n  }\n}\n```\n\n## License\n\nLGPL-3.0\n","license":"LGPL-3.0","scripts":{"help":"tsc --help","lint":"eslint -c '../../.eslintrc' --fix './src/**/*.ts'","test":"run-s test:pre test:run","build":"run-s build:pre build:cjs build:umd","clean":"rm -rf dist","watch":"tsc -p tsconfig.json --watch","test:pre":"rm -rf ./test/test.db","test:run":"env TS_NODE_PROJECT=\"tsconfig.cjs.json\" mocha --exit -r ts-node/register ./test/**/*.spec.ts","build:cjs":"npx tsc -p tsconfig.cjs.json","build:pre":"run-s clean","build:umd":"webpack"},"_npmUser":{"name":"pedrouid","email":"pedrogomes94@gmail.com"},"homepage":"https://github.com/walletconnect-labs/walletconnect-v2-monorepo/","keywords":["wallet","walletconnect"],"deprecated":"WalletConnect's v1 SDKs are now deprecated. Please upgrade to a v2 SDK. For details see: https://docs.walletconnect.com/","_npmVersion":"6.14.10","description":"Client for WalletConnect Protocol","directories":{},"maintainers":[{"name":"pedrouid","email":"pedrogomes94@gmail.com"}],"_nodeVersion":"14.15.4","dependencies":{"pino":"^6.7.0","enc-utils":"^3.0.0","pino-pretty":"^4.3.0","relay-provider":"^1.2.0","keyvaluestorage":"^0.7.1","safe-json-utils":"^1.1.1","@pedrouid/pino-utils":"^1.0.1","@walletconnect/types":"^2.0.0-alpha.25","@walletconnect/utils":"^2.0.0-alpha.25","@json-rpc-tools/utils":"^1.6.2","@json-rpc-tools/provider":"^1.6.2"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"chai":"^4.2.0","mocha":"^8.2.1","sinon":"^9.2.2","eslint":"^5.16.0","core-js":"^3.6.5","ts-node":"^9.0.0","webpack":"^4.41.5","prettier":"^1.19.1","@babel/cli":"^7.12.1","typescript":"^3.7.5","@babel/core":"^7.12.3","@babel/node":"^7.12.1","@types/chai":"^4.2.14","@types/jest":"^22.2.3","@types/node":"^14.14.2","@types/pino":"^6.3.3","npm-run-all":"^4.1.5","webpack-cli":"^3.3.10","@types/mocha":"^8.0.4","@types/sinon":"^4.3.1","@babel/polyfill":"^7.12.1","@babel/register":"^7.12.1","chai-as-promised":"^7.1.1","@babel/preset-env":"^7.12.1","eslint-plugin-node":"^9.2.0","@pedrouid/timestamp":"^1.0.0","eslint-plugin-react":"^7.19.0","eslint-plugin-import":"^2.20.1","eslint-plugin-promise":"^4.2.1","eslint-config-prettier":"^6.10.0","eslint-config-standard":"^12.0.0","eslint-plugin-prettier":"^3.1.2","eslint-plugin-standard":"^4.0.1","@types/chai-as-promised":"^7.1.0","@babel/preset-typescript":"^7.12.1","@typescript-eslint/parser":"^2.24.0","@typescript-eslint/eslint-plugin":"^2.24.0"},"_npmOperationalInternal":{"tmp":"tmp/client_2.0.0-alpha.25_1613683802463_0.7534064011305988","host":"s3://npm-registry-packages"},"_id":"@walletconnect/client@2.0.0-alpha.25","version":"2.0.0-alpha.25"}