{"id":21850473,"url":"https://github.com/circlefin/w3s-pw-web-sdk","last_synced_at":"2025-04-14T14:56:08.932Z","repository":{"id":209566015,"uuid":"713855643","full_name":"circlefin/w3s-pw-web-sdk","owner":"circlefin","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-11T08:34:09.000Z","size":258,"stargazers_count":11,"open_issues_count":9,"forks_count":13,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-03-28T03:51:08.477Z","etag":null,"topics":["web3"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/circlefin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-11-03T11:30:57.000Z","updated_at":"2025-03-11T11:47:46.000Z","dependencies_parsed_at":"2024-03-01T08:30:32.197Z","dependency_job_id":"cdcb3108-7f72-4159-9119-333ac710a3ac","html_url":"https://github.com/circlefin/w3s-pw-web-sdk","commit_stats":null,"previous_names":["circlefin/w3s-pw-web-sdk"],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/circlefin%2Fw3s-pw-web-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/circlefin%2Fw3s-pw-web-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/circlefin%2Fw3s-pw-web-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/circlefin%2Fw3s-pw-web-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/circlefin","download_url":"https://codeload.github.com/circlefin/w3s-pw-web-sdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248902003,"owners_count":21180549,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["web3"],"created_at":"2024-11-28T00:17:43.200Z","updated_at":"2025-04-14T14:56:08.911Z","avatar_url":"https://github.com/circlefin.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Circle Programmable Wallets Web SDK\n\n## Table of Contents\n\n- [Circle Programmable Wallets Web SDK](#circle-programmable-wallets-web-sdk)\n  - [Table of Contents](#table-of-contents)\n  - [Overview](#overview)\n  - [Installation](#installation)\n  - [Usage](#usage)\n    - [Prerequisites](#prerequisites)\n    - [Initiating the SDK](#initiating-the-sdk)\n  - [Documentation](#documentation)\n  - [Examples](#examples)\n\n---\n\n## Overview\n\nProgrammable Wallets Web SDK empowers developers to build web3 wallets on web apps with ease. It’s a non-custodial wallet solution that brings seamless onboarding \u0026 transaction experience for end-users and utilizes industry standard MPC cryptographic technology to ensure the security of private key as well as the safety of user assets.\n\n## Installation\n\n```bash\n$ npm install @circle-fin/w3s-pw-web-sdk\n```\n\n## Usage\n\n### Prerequisites\n\nSign up for [Circle's Dev Console](https://developers.circle.com/w3s/docs/circle-developer-account) to obtain an APP ID.\n\n### Initiating the SDK\n\nA minimal example for initiating the SDK is as follows:\n\n```jsx\nimport { W3SSdk } from '@circle-fin/w3s-pw-web-sdk'\n\nconst sdk = new W3SSdk({\n  appSettings: {\n    appId: '\u003cYour App Id\u003e'\n  },\n})\n\nsdk.setAuthentication({\n  userToken: '\u003cYour user token\u003e',\n  encryptionKey: '\u003cYour encryption key\u003e',\n})\n\nsdk.execute(challengeId, (error, result) =\u003e {\n  if (error) {\n    console.log(\n      `${error?.code?.toString() || 'Unknown code'}: ${\n        error?.message ?? 'Error!'\n      }`\n    )\n\n    return\n  }\n\n  console.log(`Challenge: ${result.type}`)\n  console.log(`status: ${result.status}`)\n\n  if (result.data) {\n    console.log(`signature: ${result.data?.signature}`)\n  }\n})\n```\n\n## Documentation\n\nCheck out the developer documentations below for an easy-breezy setup and smoother usage experience.\n\n- [Web SDK doc](https://developers.circle.com/w3s/docs/web)\n- [Web SDK UI Customization API doc](https://developers.circle.com/w3s/docs/web-sdk-ui-customizations)\n\n## Examples\n\nWe provide 3 frontend examples for you to try out:\n\n- [js-example](https://github.com/circlefin/w3s-pw-web-sdk/tree/master/examples/js-example)\n- [react-example](https://github.com/circlefin/w3s-pw-web-sdk/tree/master/examples/react-example)\n- [vue-example](https://github.com/circlefin/w3s-pw-web-sdk/tree/master/examples/vue-example)\n\nPlease follow the steps below to start building:\n\n1. Clone this repo.\n2. Obtain the APP ID from [Circle Developer Console](https://console.circle.com/).\n3. Running the script. please follow the README.md in the example folder to execute the sample app.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcirclefin%2Fw3s-pw-web-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcirclefin%2Fw3s-pw-web-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcirclefin%2Fw3s-pw-web-sdk/lists"}