Skip to content

Add Guarda Wallet #70

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ This repository contains wallet adapters and components for Tron DApps. With out
| [Trust](https://trustwallet.com) | Android | Not Support |
| | IOS | Not Support |
| | Browser Extension | >= 1.0.0 |
| [Guarda](https://guarda.com/) | Android | >= 1.0.0 |
| | IOS | >= 1.0.0 |
| | Browser Extension | >= 1.0.0 |

> **Note**: In case wallet developers intend to release breaking changes, you can [open an issue here](https://github.com/tronweb3/tronwallet-adapter/issues/new) to inform us, thus enabling us to update the new protocols accordingly.

Expand Down Expand Up @@ -198,6 +201,7 @@ tronwallet-adapter
| | ├─imtoken # adapter for imToken Wallet
| | ├─gatewallet # adapter for gate.io Wallet
| | ├─foxwallet # adapter for FoxWallet
| | ├─guarda # adapter for Guarda Wallet
| | ├─bybit # adapter for Bybit Wallet
| | ├─trust # adapter for Trust Wallet
| ├─react
Expand Down
97 changes: 97 additions & 0 deletions demos/cdn-demo/guarda/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>GuardaAdapter Test Demo</title>
<script src="../node_modules/@tronweb3/tronwallet-adapter-guarda/lib/umd/index.js"></script>
</head>
<body>
<div id="root">
<button id="connectBtn">connect</button>
<button id="disconnectBtn">disconnect</button>
<button id="signMessageBtn">signMessage</button>
<button id="signTransactionBtn">signTransaction</button>
</div>
<script>
const log = function (...args) {
console.log('Adapter:', ...args);
};
let address;
const receiver = 'TMDKznuDWaZwfZHcM61FVFstyYNmK6Njk1';
const { GuardaAdapter } = window['@tronweb3/tronwallet-adapter-guarda'];
const adapter = new GuardaAdapter({
openTronLinkAppOnMobile: true,
openUrlWhenWalletNotFound: false,
checkTimeout: 3000,
});

adapter.on('readyStateChanged', () => {
log('readyState: ', adapter.readyState);
});
adapter.on('connect', () => {
log('connect: ', adapter.address);
address = adapter.address;
adapter
.network()
.then((res) => {
log(res);
})
.catch((e) => {
log(e);
});
});
adapter.on('stateChanged', (state) => {
log('stateChanged: ', state);
});
adapter.on('accountsChanged', (data, preaddr) => {
log('accountsChanged: current', data, ' pre: ', preaddr);
});

adapter.on('chainChanged', (data) => {
log('chainChanged: ', data);
});

adapter.on('disconnect', () => {
log('disconnect');
});

const connectBtn = document.querySelector('#connectBtn');
const disconnectBtn = document.querySelector('#disconnectBtn');
const signMessageBtn = document.querySelector('#signMessageBtn');
const signTransactionBtn = document.querySelector('#signTransactionBtn');

connectBtn.addEventListener('click', onConnect);
disconnectBtn.addEventListener('click', onDisconnect);
signMessageBtn.addEventListener('click', onSignMessage);
signTransactionBtn.addEventListener('click', onSignTransaction);

async function onConnect() {
const res = await adapter.connect();
log('connect successfully: ', adapter.address);
address = adapter.address;
}

async function onDisconnect() {
await adapter.disconnect();
log('disconnect successfully ');
address = undefined;
}

async function onSignMessage() {
const m = 'Hello world';
const res = await adapter.signMessage(m);
log('sign message successfully: ', res);
const address = await tronWeb.trx.verifyMessageV2(m, res);
log('verify successfully');
}

async function onSignTransaction() {
const transaction = await tronWeb.transactionBuilder.sendTrx(receiver, tronWeb.toSun(0.000001), adapter.address);
const signedTransaction = await adapter.signTransaction(transaction);
const res = await tronWeb.trx.sendRawTransaction(signedTransaction);
log('send successfully.');
}
</script>
</body>
</html>
1 change: 1 addition & 0 deletions demos/cdn-demo/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
"@tronweb3/abstract-adapter-evm": "^1.0.1",
"@tronweb3/tronwallet-abstract-adapter": "^1.1.6",
"@tronweb3/tronwallet-adapter-bitkeep": "^1.0.2",
"@tronweb3/tronwallet-adapter-guarda": "^1.0.0",
"@tronweb3/tronwallet-adapter-ledger": "^1.1.8",
"@tronweb3/tronwallet-adapter-metamask": "^1.0.1",
"@tronweb3/tronwallet-adapter-okxwallet": "^1.0.2",
Expand Down
4 changes: 3 additions & 1 deletion demos/dev-demo/src/AdapterBasicTest.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ import {
WalletConnectAdapter,
FoxWalletAdapter,
BybitWalletAdapter,
TrustAdapter
TrustAdapter,
GuardaAdapter
} from '@tronweb3/tronwallet-adapters';
import { memo, useCallback, useEffect, useMemo, useState } from 'react';
import { tronWeb } from './tronweb';
Expand All @@ -35,6 +36,7 @@ export const AdapterBasicTest = memo(function AdapterBasicTest() {
new LedgerAdapter(),
new WalletConnectAdapter(walletconnectConfig),
new TrustAdapter(),
new GuardaAdapter(),
],
[]
);
Expand Down
4 changes: 3 additions & 1 deletion demos/dev-demo/src/components/WalletProvider.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ import {
FoxWalletAdapter,
BybitWalletAdapter,
TronLinkAdapterName,
TrustAdapter
TrustAdapter,
GuardaAdapter
} from '@tronweb3/tronwallet-adapters';
import { walletconnectConfig } from '../config';
import type { Adapter, AdapterName } from "@tronweb3/tronwallet-abstract-adapter";
Expand Down Expand Up @@ -62,6 +63,7 @@ export default function WalletProvider({ children }: PropsWithChildren) {
new FoxWalletAdapter(),
new BybitWalletAdapter(),
new LedgerAdapter(),
new GuardaAdapter(),
new WalletConnectAdapter(walletconnectConfig),
];
}, []);
Expand Down
4 changes: 3 additions & 1 deletion demos/react-ui/next-app/pages/_app.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ export default function App({ Component, pageProps }: AppProps) {
const [adapters, setAdapters] = useState<Adapter[]>([]);
useEffect(() => {
import('@tronweb3/tronwallet-adapters').then((res) => {
const { BitKeepAdapter, OkxWalletAdapter, TokenPocketAdapter, TronLinkAdapter, WalletConnectAdapter } = res;
const { BitKeepAdapter, OkxWalletAdapter, TokenPocketAdapter, TronLinkAdapter, WalletConnectAdapter, GuardaAdapter } = res;
const tronLinkAdapter = new TronLinkAdapter();
const ledger = new LedgerAdapter({
accountNumber: 2,
Expand Down Expand Up @@ -49,13 +49,15 @@ export default function App({ Component, pageProps }: AppProps) {
const bitKeepAdapter = new BitKeepAdapter();
const tokenPocketAdapter = new TokenPocketAdapter();
const okxwalletAdapter = new OkxWalletAdapter();
const guardaAdapter = new GuardaAdapter();
setAdapters([
tronLinkAdapter,
bitKeepAdapter,
tokenPocketAdapter,
okxwalletAdapter,
walletConnectAdapter,
ledger,
guardaAdapter,
]);
});
}, [setAdapters]);
Expand Down
5 changes: 3 additions & 2 deletions demos/react-ui/vite-app/src/App.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import {
} from '@tronweb3/tronwallet-adapter-react-ui';
import toast from 'react-hot-toast';
import { Table, TableBody, TableCell, TableContainer, TableHead, TableRow, TextField, Alert } from '@mui/material';
import { TronLinkAdapter, TokenPocketAdapter, BitKeepAdapter, OkxWalletAdapter, GateWalletAdapter, BybitWalletAdapter, LedgerAdapter, WalletConnectAdapter } from '@tronweb3/tronwallet-adapters';
import { TronLinkAdapter, TokenPocketAdapter, BitKeepAdapter, OkxWalletAdapter, GateWalletAdapter, BybitWalletAdapter, LedgerAdapter, WalletConnectAdapter, GuardaAdapter } from '@tronweb3/tronwallet-adapters';
import { tronWeb } from './tronweb';
import { Button } from '@tronweb3/tronwallet-adapter-react-ui';
const rows = [
Expand Down Expand Up @@ -85,7 +85,8 @@ export function App() {
const okxWalletAdapter = new OkxWalletAdapter();
const gateAdapter = new GateWalletAdapter();
const bybitAdapter = new BybitWalletAdapter();
return [tronLink1, walletConnect1, ledger, tokenPocket, bitKeep, okxWalletAdapter, gateAdapter, bybitAdapter];
const guardaAdapter = new GuardaAdapter();
return [tronLink1, walletConnect1, ledger, tokenPocket, bitKeep, okxWalletAdapter, gateAdapter, bybitAdapter, guardaAdapter];
}, []);
function onConnect() {
console.log('onConnect');
Expand Down
4 changes: 3 additions & 1 deletion demos/vue-ui/vite-app/src/App.vue
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import {
TronLinkAdapter,
WalletConnectAdapter,
BybitWalletAdapter,
GuardaAdapter,
} from '@tronweb3/tronwallet-adapters';
import { WalletModalProvider } from '@tronweb3/tronwallet-adapter-vue-ui';
const tronLink = new TronLinkAdapter();
Expand Down Expand Up @@ -53,7 +54,8 @@ const tokenPocket = new TokenPocketAdapter();
const bitKeep = new BitKeepAdapter();
const okxWalletAdapter = new OkxWalletAdapter();
const bybit = new BybitWalletAdapter();
const adapters = [tronLink, walletConnect, ledger, tokenPocket, bitKeep, okxWalletAdapter, bybit];
const guarda = new GuardaAdapter();
const adapters = [tronLink, walletConnect, ledger, tokenPocket, bitKeep, okxWalletAdapter, bybit, guarda];

function onAdapterChanged(adapter: Adapter) {
console.log('[wallet hooks] onAdapterChanged: ', adapter?.name);
Expand Down
1 change: 1 addition & 0 deletions packages/adapters/adapters/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -343,4 +343,5 @@ Other adapters `Constructor` config api can be found in their source code `READM
- [GateWalletAdapter](https://github.com/tronweb3/tronwallet-adapter/tree/main/packages/adapters/gatewallet)
- [FoxWalletAdapter](https://github.com/tronweb3/tronwallet-adapter/tree/main/packages/adapters/foxwallet)
- [BybitWalletAdapter](https://github.com/tronweb3/tronwallet-adapter/tree/main/packages/adapters/bybit)
- [GuardaAdapter](https://github.com/tronweb3/tronwallet-adapter/tree/main/packages/adapters/guarda)
- [TrustAdapter](https://github.com/tronweb3/tronwallet-adapter/tree/main/packages/adapters/trust)
3 changes: 2 additions & 1 deletion packages/adapters/adapters/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@
"@tronweb3/tronwallet-adapter-gatewallet": "workspace:^",
"@tronweb3/tronwallet-adapter-foxwallet": "workspace:^",
"@tronweb3/tronwallet-adapter-bybit": "workspace:^",
"@tronweb3/tronwallet-adapter-trust": "workspace:^"
"@tronweb3/tronwallet-adapter-trust": "workspace:^",
"@tronweb3/tronwallet-adapter-guarda": "workspace:^"
},
"devDependencies": {
"@vitest/browser": "^2.0.4",
Expand Down
1 change: 1 addition & 0 deletions packages/adapters/adapters/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ export * from '@tronweb3/tronwallet-adapter-imtoken';
export * from '@tronweb3/tronwallet-adapter-foxwallet';
export * from '@tronweb3/tronwallet-adapter-bybit';
export * from '@tronweb3/tronwallet-adapter-trust';
export * from '@tronweb3/tronwallet-adapter-guarda';
1 change: 1 addition & 0 deletions packages/adapters/adapters/tests/e2e/adapters.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,5 @@ test("window['@tronweb3/tronwallet-adapters'] should exist", () => {
expect(Adapters.FoxWalletAdapter).not.toBeUndefined();
expect(Adapters.BybitWalletAdapter).not.toBeUndefined();
expect(Adapters.TrustAdapter).not.toBeUndefined();
expect(Adapters.GuardaAdapter).not.toBeUndefined();
});
20 changes: 20 additions & 0 deletions packages/adapters/guarda/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
The MIT License (MIT)
Copyright (c) 2022-Present, tronweb3

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
63 changes: 63 additions & 0 deletions packages/adapters/guarda/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# @tronweb3/tronwallet-adapter-guarda

Wallet adapter for Guarda Extension and App wallet.

## Installation

```bash
npm install @tronweb3/tronwallet-adapter-guarda
```

## Usage

```typescript
import { GuardaAdapter } from '@tronweb3/tronwallet-adapter-guarda';

const adapter = new GuardaAdapter({
checkTimeout: 2000,
openAppWithDeeplink: true,
openUrlWhenWalletNotFound: true,
});

// Connect to wallet
await adapter.connect();

// Get address
console.log(adapter.address);

// Sign transaction
const signedTx = await adapter.signTransaction(transaction);

// Sign message
const signature = await adapter.signMessage('Hello World');

// Disconnect
await adapter.disconnect();
```

## Configuration

| Option | Type | Default | Description |
|--------|------|---------|-------------|
| `checkTimeout` | `number` | `2000` | Timeout in millisecond for checking if is in Guarda App |
| `openAppWithDeeplink` | `boolean` | `true` | Set if open Guarda app using DeepLink |
| `openUrlWhenWalletNotFound` | `boolean` | `true` | Set if open Guarda website when wallet not found |

## Events

The adapter extends the base adapter and emits the following events:

- `readyStateChanged`: When the wallet ready state changes
- `connect`: When the wallet connects
- `disconnect`: When the wallet disconnects
- `accountsChanged`: When the account changes
- `chainChanged`: When the chain changes
- `stateChanged`: When the adapter state changes

## Caveats

- `multiSign()` and `switchChain(chainId: string)` are not supported.

## License

MIT
17 changes: 17 additions & 0 deletions packages/adapters/guarda/jest.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
export default {
preset: 'ts-jest',
testEnvironment: 'jsdom',
extensionsToTreatAsEsm: ['.ts'],
transform: {
'^.+\\.ts$': ['ts-jest', {
useESM: true,
}],
},
moduleNameMapper: {
'^(\\.{1,2}/.*)\\.js$': '$1',
},
testMatch: ['<rootDir>/tests/**/*.test.ts'],
collectCoverageFrom: ['<rootDir>/src/**/*.ts'],
coverageDirectory: 'coverage',
coverageReporters: ['text', 'lcov', 'html'],
};
Loading