Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: NWC connection URL and improve checks to see if balance is supported #226

Merged
merged 3 commits into from
May 12, 2024
Merged

Fix: NWC connection URL and improve checks to see if balance is supported #226

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f2d3105
fix: update js-sdk dependency to fix NWC url passing issue
rolznz May 12, 2024
8a7bffa
fix: only request and display balance if provider supports it
rolznz May 12, 2024
62d3202
chore: bump version
rolznz May 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,13 @@ You can use Bitcoin Connect without any build tools:

```html
<script type="module">
import {launchModal} from 'https://esm.sh/@getalby/bitcoin-connect@3.4.0'; // jsdelivr.net, skypack.dev also work
import {launchModal} from 'https://esm.sh/@getalby/bitcoin-connect@3.4.1'; // jsdelivr.net, skypack.dev also work

// use Bitcoin connect API normally...
launchModal();

// or if you just want access to the web components:
import 'https://esm.sh/@getalby/bitcoin-connect@3.4.0';
import 'https://esm.sh/@getalby/bitcoin-connect@3.4.1';
</script>

<!-- Bitcoin Connect components are now available -->
Expand Down
2 changes: 1 addition & 1 deletion demos/html/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta charset="utf-8" />
<title>Bitcoin Connect</title>
<script type="module">
import {onConnected} from 'https://esm.sh/@getalby/bitcoin-connect@3.4.0';
import {onConnected} from 'https://esm.sh/@getalby/bitcoin-connect@3.4.1';
onConnected((provider) => {
console.log('Connected with provider', provider);
});
Expand Down
4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@getalby/bitcoin-connect",
"version": "3.4.0",
"version": "3.4.1",
"description": "Web components to connect to a lightning wallet and power a website with WebLN",
"type": "module",
"source": "src/index.ts",
Expand Down Expand Up @@ -48,7 +48,7 @@
},
"dependencies": {
"@getalby/lightning-tools": "^5.0.3",
"@getalby/sdk": "^3.5.0",
"@getalby/sdk": "^3.5.1",
"@lightninglabs/lnc-web": "^0.3.1-alpha",
"qrcode-generator": "^1.4.4",
"zustand": "^4.5.2"
Expand Down
4 changes: 2 additions & 2 deletions react/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@getalby/bitcoin-connect-react",
"version": "3.4.0",
"version": "3.4.1",
"type": "module",
"source": "src/index.ts",
"main": "./dist/index.cjs",
Expand All @@ -27,7 +27,7 @@
"build": "microbundle --globals react=React --jsx React.createElement --jsxFragment React.Fragment --jsxImportSource react"
},
"dependencies": {
"@getalby/bitcoin-connect": "^3.4.0"
"@getalby/bitcoin-connect": "^3.4.1"
},
"devDependencies": {
"@types/react": "^18.2.21",
Expand Down
18 changes: 9 additions & 9 deletions react/yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1018,13 +1018,13 @@
"@babel/helper-validator-identifier" "^7.22.5"
to-fast-properties "^2.0.0"

"@getalby/bitcoin-connect@^3.4.0":
version "3.4.0"
resolved "https://registry.yarnpkg.com/@getalby/bitcoin-connect/-/bitcoin-connect-3.4.0.tgz#60d51a9c7f98b6e3fdc22f9893d5884c07706f7d"
integrity sha512-xkGxaBkHA9Ugnz4eAAq22aV/17VhesRaF09mMLgA6s1PXXN8Q871T/4EOn4kYscKKtyqMg/OSZ698vGDU0sMEA==
"@getalby/bitcoin-connect@^3.4.1":
version "3.4.1"
resolved "https://registry.yarnpkg.com/@getalby/bitcoin-connect/-/bitcoin-connect-3.4.1.tgz#b12b27ecf6c5b7ddbafd962a99880a32ce639a25"
integrity sha512-RLfBAMKVWcEjWFU8OidqFDpass2piTjtY/bCaDFYiB79pMCtzGpS/HjfBdqgPITgM0b5kQUySdKylDBfVAnMgw==
dependencies:
"@getalby/lightning-tools" "^5.0.3"
"@getalby/sdk" "^3.5.0"
"@getalby/sdk" "^3.5.1"
"@lightninglabs/lnc-web" "^0.3.1-alpha"
qrcode-generator "^1.4.4"
zustand "^4.5.2"
Expand All @@ -1034,10 +1034,10 @@
resolved "https://registry.yarnpkg.com/@getalby/lightning-tools/-/lightning-tools-5.0.3.tgz#4cc6ef1253a30fb4913af89b842645e0c04994bf"
integrity sha512-QG3/SBI5n2py5IgsjP3K+c8eq55eiI3PQB12yo9Pot0b5hcN7TNNoTKn0fgLJjO1iEVCUkF513kDOpjjXwK0hQ==

"@getalby/sdk@^3.5.0":
version "3.5.0"
resolved "https://registry.yarnpkg.com/@getalby/sdk/-/sdk-3.5.0.tgz#8ef53cda9f22cf31d3e99d3ff4d00366aee0567d"
integrity sha512-gnjILgoXOMjCVD1fHcoS3ghhO0UpvFHXuCBb0hz5iuzRYxbPWHXt0eVd60y+z5kR/+T+/S3S2fRMnbCYma+ppQ==
"@getalby/sdk@^3.5.1":
version "3.5.1"
resolved "https://registry.yarnpkg.com/@getalby/sdk/-/sdk-3.5.1.tgz#2549f416e200d42bfa83e4d2f9999305eac5ba8c"
integrity sha512-Qz9GgXMoVpupDLqbzA2CHpru+9yqijQrxeRN7CDfV6l39js/BGwin93MFTh7eFj2TsMo+i8JeM3BVn+SJn/iRg==
dependencies:
eventemitter3 "^5.0.1"
nostr-tools "^1.17.0"
Expand Down
12 changes: 8 additions & 4 deletions src/components/bc-balance.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,14 +85,18 @@ export class Balance extends withTwind()(BitcoinConnectElement) {
if (!provider) {
return;
}
// TODO: consider using getInfo to check if balance is supported
// and do not show an error if it is not supported
// (do not display the balance - needs to be handled somewhere else)
if (!provider.getBalance) {

const info = store.getState().info;
if (
!info?.methods ||
info.methods.indexOf('getBalance') < 0 ||
!provider.getBalance
Comment on lines +90 to +93
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to me these checks are always a bit of a code-smell. and if is one already and then the more complicated it is the more problematic it is to read it easily and understand what is going for a new developer.

in this PR you do this check already at 3 places that would need to be kept in sync.
be careful there and we need to think about the clear defined API (internal and external)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree. Maybe we calculate this once when the connection is initialized and remove the check from the balance component (it should never reach that). I'll try clean this up tomorrow.

) {
throw new Error(
'The current WebLN provider does not support getBalance'
);
}

const balanceResponse = await provider.getBalance();
if (balanceResponse) {
this._balanceSats = balanceResponse.balance;
Expand Down
16 changes: 15 additions & 1 deletion src/components/bc-button.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {launchModal} from '../api.js';
import './bc-balance';
import store from '../state/store.js';
import {waitingIcon} from './icons/waitingIcon.js';
import {GetInfoResponse, WebLNProvider} from '@webbtc/webln-types';

/**
* A button that when clicked launches the modal.
Expand All @@ -20,20 +21,33 @@ export class Button extends withTwind()(BitcoinConnectElement) {

@state()
protected _showBalance: boolean | undefined = undefined;
@state()
protected _info: GetInfoResponse | undefined = undefined;
@state()
protected _provider: WebLNProvider | undefined = undefined;

constructor() {
super();

this._showBalance = store.getState().showBalance;
this._info = store.getState().info;
this._provider = store.getState().provider;

// TODO: handle unsubscribe
store.subscribe((store) => {
this._showBalance = store.showBalance;
this._info = store.info;
this._provider = store.provider;
});
}

override render() {
const isLoading = this._connecting || (!this._connected && this._modalOpen);
const showBalance =
!!this._showBalance &&
!!this._info?.methods &&
this._info.methods.indexOf('getBalance') > -1 &&
!!this._provider?.getBalance;

return html`<div>
<div
Expand Down Expand Up @@ -62,7 +76,7 @@ export class Button extends withTwind()(BitcoinConnectElement) {
: html`${this.title}`}
</span>
</bci-button>
${this._connected && this._showBalance !== false
${this._connected && showBalance
? html`<bc-balance class="select-none cursor-pointer"></bc-balance> `
: null}
</div>
Expand Down
17 changes: 16 additions & 1 deletion src/components/bc-start.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,31 +9,46 @@ import {disconnectSection} from './templates/disconnectSection';
import './bc-balance';
import store from '../state/store';
import './bc-currency-switcher';
import {GetInfoResponse, WebLNProvider} from '@webbtc/webln-types';

// TODO: split up this component into disconnected and connected
@customElement('bc-start')
export class Start extends withTwind()(BitcoinConnectElement) {
@state()
protected _showBalance: boolean | undefined = undefined;
@state()
protected _info: GetInfoResponse | undefined = undefined;
@state()
protected _provider: WebLNProvider | undefined = undefined;

constructor() {
super();

this._showBalance = store.getState().showBalance;
this._info = store.getState().info;
this._provider = store.getState().provider;

// TODO: handle unsubscribe
store.subscribe((store) => {
this._showBalance = store.showBalance;
this._info = store.info;
this._provider = store.provider;
});
}

override render() {
const showBalance =
!!this._showBalance &&
!!this._info?.methods &&
this._info.methods.indexOf('getBalance') > -1 &&
!!this._provider?.getBalance;

return html`<div
class="flex flex-col justify-center items-center w-full font-sans"
>
${this._connected
? html`
${this._showBalance !== false
${showBalance
? html`<span
class="text-xs font-medium mb-2 ${classes[
'text-neutral-secondary'
Expand Down
12 changes: 11 additions & 1 deletion src/state/store.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import {connectors} from '../connectors';
import {Connector} from '../connectors/Connector';
import {Route} from '../components/routes';
import {ConnectorFilter} from '../types/ConnectorFilter';
import {WebLNProvider} from '@webbtc/webln-types';
import {GetInfoResponse, WebLNProvider} from '@webbtc/webln-types';
import {WebLNProviderConfig} from '../types/WebLNProviderConfig';

interface Store {
Expand All @@ -23,6 +23,7 @@ interface Store {
readonly providerConfig: WebLNProviderConfig | undefined;
readonly connector: Connector | undefined;
readonly config: ConnectorConfig | undefined;
readonly info: GetInfoResponse | undefined;

connect(config: ConnectorConfig): void;
disconnect(): void;
Expand Down Expand Up @@ -61,6 +62,7 @@ const store = createStore<Store>((set, get) => ({
providerConfig: undefined,
connector: undefined,
config: undefined,
info: undefined,
connect: async (config: ConnectorConfig) => {
set({
connecting: true,
Expand All @@ -70,11 +72,19 @@ const store = createStore<Store>((set, get) => ({
const connector = new connectors[config.connectorType](config);
const provider = await connector.init();
await provider.enable();
let info: GetInfoResponse | undefined;
try {
info = await provider.getInfo();
} catch (error) {
console.error('Failed to request wallet info');
}

set({
config,
connector,
connected: true,
connecting: false,
info,
provider,
connectorName: config.connectorName,
route: '/start',
Expand Down
8 changes: 4 additions & 4 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1309,10 +1309,10 @@
resolved "https://registry.yarnpkg.com/@getalby/lightning-tools/-/lightning-tools-5.0.3.tgz#4cc6ef1253a30fb4913af89b842645e0c04994bf"
integrity sha512-QG3/SBI5n2py5IgsjP3K+c8eq55eiI3PQB12yo9Pot0b5hcN7TNNoTKn0fgLJjO1iEVCUkF513kDOpjjXwK0hQ==

"@getalby/sdk@^3.5.0":
version "3.5.0"
resolved "https://registry.yarnpkg.com/@getalby/sdk/-/sdk-3.5.0.tgz#8ef53cda9f22cf31d3e99d3ff4d00366aee0567d"
integrity sha512-gnjILgoXOMjCVD1fHcoS3ghhO0UpvFHXuCBb0hz5iuzRYxbPWHXt0eVd60y+z5kR/+T+/S3S2fRMnbCYma+ppQ==
"@getalby/sdk@^3.5.1":
version "3.5.1"
resolved "https://registry.yarnpkg.com/@getalby/sdk/-/sdk-3.5.1.tgz#2549f416e200d42bfa83e4d2f9999305eac5ba8c"
integrity sha512-Qz9GgXMoVpupDLqbzA2CHpru+9yqijQrxeRN7CDfV6l39js/BGwin93MFTh7eFj2TsMo+i8JeM3BVn+SJn/iRg==
dependencies:
eventemitter3 "^5.0.1"
nostr-tools "^1.17.0"
Expand Down