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.

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

Sats Connect kit #87

Merged
merged 29 commits into from
Apr 6, 2024
Merged
Changes from 1 commit
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
eef91d6
init WalletProvider Wrapper
m-aboelenein Mar 20, 2024
115787e
Sort wallet providers
aryzing Mar 20, 2024
3745d73
Add provider management methods
aryzing Mar 20, 2024
1aa0a34
Remove unused icons
aryzing Mar 20, 2024
4ec4f45
update walletProvider implementation
m-aboelenein Mar 21, 2024
dfa7e80
added example app and refactor WalletProvider class
m-aboelenein Mar 21, 2024
4ff8a91
update test app code
m-aboelenein Mar 22, 2024
d0d249a
cleanup + update WalletProvider methods
m-aboelenein Mar 26, 2024
8fe2d10
Update types
aryzing Mar 26, 2024
c156725
default to base adapter if no adapter was found
m-aboelenein Mar 26, 2024
8357210
Move default selector config to core
aryzing Mar 26, 2024
3867b78
use published packages
m-aboelenein Mar 27, 2024
cd90034
Merge remote-tracking branch 'origin/develop' into connect-kit/v0
m-aboelenein Mar 27, 2024
12a1ea9
update provide name and trigger connect modal if first request cancelled
m-aboelenein Mar 27, 2024
103920f
update sats-connect-core and implement wallet action loading
m-aboelenein Mar 28, 2024
642de5d
update example app version
m-aboelenein Mar 28, 2024
0c55d47
cleanup and update readme
m-aboelenein Apr 1, 2024
39b02c0
Handle provider selection cancellation
aryzing Apr 2, 2024
99a776e
Update ui version
aryzing Apr 2, 2024
a46850c
update core version and test-app
m-aboelenein Apr 2, 2024
70ac819
add usage example in readme
m-aboelenein Apr 5, 2024
b360a71
added mint runes example
m-aboelenein Apr 5, 2024
776de00
update core package
m-aboelenein Apr 5, 2024
ebed7a3
update core version
m-aboelenein Apr 5, 2024
88b844d
update core version
m-aboelenein Apr 5, 2024
7a9f737
Merge pull request #91 from secretkeylabs/runes-rpc-methods-support
m-aboelenein Apr 5, 2024
ceb8fab
update core
m-aboelenein Apr 6, 2024
6fbbb18
format readame
m-aboelenein Apr 6, 2024
46b0334
Update dependencies versions
m-aboelenein Apr 6, 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
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,39 @@ Developers building apps on the Bitcoin ecosystem can use Sats connect to intera
npm i sats-connect
```

## Usage

### import

```
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
```
```ts

import Wallet from 'sats-connect';
```


### Connect Wallet

```
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
```
```ts

const response = await Wallet.request('getAccounts', {
purposes: [
AddressPurpose.Payment,
AddressPurpose.Ordinals,
AddressPurpose.Stacks
],
message: 'Cool app wants to know your addresses!'
});
Copy link
Contributor

Choose a reason for hiding this comment

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

Prettier can format this if ```ts is set above, does it work?

```
### Request a wallet action

```
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
```
```ts

await Wallet.request('sendTransfer', {...});
```

### Disconnect Wallet

```
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
```
```ts

await Wallet.disconnect();
```

## Documentation

For full documentation, visit [docs.xverse.app](https://docs.xverse.app/sats-connect/).
Loading