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

feat: improve nft support + dont send funds to assetId #1648

Merged
merged 4 commits into from
Nov 7, 2024
Merged
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
6 changes: 6 additions & 0 deletions .changeset/fresh-poets-count.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@fuel-wallet/types": patch
"fuels-wallet": patch
---

feat: improve nft support + dont allow sending funds to assetId address
1 change: 1 addition & 0 deletions packages/app/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
"@fuel-ui/test-utils": "0.17.0",
"@fuel-wallet/connections": "workspace:*",
"@fuels/local-storage": "0.20.0",
"@fuels/playwright-utils": "workspace:*",
"@fuels/react-xstore": "0.20.0",
"@hookform/resolvers": "3.9.0",
"@react-aria/utils": "3.21.0",
Expand Down
3 changes: 2 additions & 1 deletion packages/app/playwright.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ const IS_CI = process.env.CI;

export const playwrightConfig: PlaywrightTestConfig = {
workers: 1,
retries: 1,
retries: IS_CI ? 1 : 0,
testMatch: join(__dirname, './playwright/**/*.test.ts'),
testDir: join(__dirname, './playwright/'),
outputDir: join(__dirname, './playwright-results/'),
Expand All @@ -30,6 +30,7 @@ export const playwrightConfig: PlaywrightTestConfig = {
trace: 'on-first-retry',
actionTimeout: 5000,
screenshot: 'only-on-failure',
headless: false,
},
// ignore lock test because it takes too long and it will be tested in a separate config
testIgnore: [join(__dirname, './playwright/crx/lock.test.ts')],
Expand Down
70 changes: 54 additions & 16 deletions packages/app/playwright/e2e/SendTransaction.test.ts
Original file line number Diff line number Diff line change
@@ -1,14 +1,8 @@
import type { Account } from '@fuel-wallet/types';
import { expectButtonToBeEnabled } from '@fuels/playwright-utils';
import type { Browser, Page } from '@playwright/test';
import test, { chromium, expect } from '@playwright/test';
import {
type Bech32Address,
Provider,
Wallet,
bn,
fromBech32,
toB256,
} from 'fuels';
import { Provider, Wallet, bn } from 'fuels';

import {
getButtonByText,
Expand Down Expand Up @@ -62,7 +56,13 @@ test.describe('SendTransaction', () => {
await getInputByName(page, 'amount').fill('0.001');

// Submit transaction
await getButtonByText(page, 'Review').click();

const btnLocator = getButtonByText(page, 'Review');

await expectButtonToBeEnabled(btnLocator);
await page.waitForTimeout(5000);
await expectButtonToBeEnabled(btnLocator);
await btnLocator.click();

await getButtonByText(page, 'Approve').click();
await hasText(page, '0.001 ETH');
Expand Down Expand Up @@ -92,7 +92,13 @@ test.describe('SendTransaction', () => {
await getInputByName(page, 'amount').fill('0.001');

// Submit transaction
await getButtonByText(page, 'Review').click();
// make sure the button is enabled
const btnLocator = getButtonByText(page, 'Review');

await expectButtonToBeEnabled(btnLocator);
await page.waitForTimeout(5000);
await expectButtonToBeEnabled(btnLocator);
await btnLocator.click();

// Approve transaction
await hasText(page, '0.001 ETH');
Expand Down Expand Up @@ -131,7 +137,13 @@ test.describe('SendTransaction', () => {
await hasText(page, 'Balance: 1,000,000.000');

// Submit transaction
await getButtonByText(page, 'Review').click();

const btnLocator = getButtonByText(page, 'Review');

await expectButtonToBeEnabled(btnLocator);
await page.waitForTimeout(5000);
await expectButtonToBeEnabled(btnLocator);
await btnLocator.click();

// Approve transaction
await hasText(page, `0.01 ${ALT_ASSET.symbol}`);
Expand Down Expand Up @@ -163,7 +175,12 @@ test.describe('SendTransaction', () => {
await page.waitForSelector('button:has-text("Review")');
await page.waitForTimeout(1000);

await getButtonByText(page, 'Review').click();
const btnLocator = getButtonByText(page, 'Review');

await expectButtonToBeEnabled(btnLocator);
await page.waitForTimeout(5000);
await expectButtonToBeEnabled(btnLocator);
await btnLocator.click();

await hasText(page, '0.001 ETH');

Expand Down Expand Up @@ -200,7 +217,12 @@ test.describe('SendTransaction', () => {
await page.waitForSelector('button:has-text("Review")');
await page.waitForTimeout(1000);

await getButtonByText(page, 'Review').click();
const btnLocator = getButtonByText(page, 'Review');

await expectButtonToBeEnabled(btnLocator);
await page.waitForTimeout(5000);
await expectButtonToBeEnabled(btnLocator);
await btnLocator.click();

await hasText(page, '0.001 ETH');

Expand Down Expand Up @@ -241,7 +263,12 @@ test.describe('SendTransaction', () => {
await page.waitForSelector('button:has-text("Review")');
await page.waitForTimeout(1000);

await getButtonByText(page, 'Review').click();
const btnLocatorBeforeApprv = getButtonByText(page, 'Review');

await expectButtonToBeEnabled(btnLocatorBeforeApprv);
await page.waitForTimeout(5000);
await expectButtonToBeEnabled(btnLocatorBeforeApprv);
await btnLocatorBeforeApprv.click();

// Waiting button change to Approve in order to get updated fee amount
await page.waitForSelector('button:has-text("Approve")');
Expand All @@ -258,7 +285,12 @@ test.describe('SendTransaction', () => {
await page.waitForSelector('button:has-text("Review")');
await page.waitForTimeout(1000);

await getButtonByText(page, 'Review').click();
const btnLocator = getButtonByText(page, 'Review');

await expectButtonToBeEnabled(btnLocator);
await page.waitForTimeout(5000);
await expectButtonToBeEnabled(btnLocator);
await btnLocator.click();

// Waiting button change to Approve in order to get updated fee amount
await page.waitForSelector('button:has-text("Approve")');
Expand Down Expand Up @@ -308,7 +340,13 @@ test.describe('SendTransaction', () => {
const maxAmountAfterFee = await getInputByName(page, 'amount').inputValue();

// Submit transaction
await getButtonByText(page, 'Review').click();

const btnLocator = getButtonByText(page, 'Review');

await expectButtonToBeEnabled(btnLocator);
await page.waitForTimeout(5000);
await expectButtonToBeEnabled(btnLocator);
await btnLocator.click();

// Approve transaction
await hasText(page, `${maxAmountAfterFee} ETH`);
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { Button, CardList } from '@fuel-ui/react';
import type { CoinAsset } from '@fuel-wallet/types';
import { useMemo, useState } from 'react';
import { isUnknownAsset } from '~/systems/Asset';
import { AssetItem, AssetList } from '~/systems/Asset/components';
import type { AssetListEmptyProps } from '~/systems/Asset/components/AssetList/AssetListEmpty';

Expand All @@ -21,31 +22,42 @@ export const BalanceAssets = ({
}: BalanceAssetListProp) => {
const [showUnknown, setShowUnknown] = useState(false);
const unknownLength = useMemo(
() => balances?.filter((balance) => !balance.asset?.name).length,
() =>
balances?.filter(
(balance) => balance.asset && isUnknownAsset(balance.asset)
).length,
[balances]
);

if (isLoading) return <AssetList.Loading items={4} />;
const isEmpty = !balances || !balances.length;
if (isEmpty) return <AssetList.Empty {...emptyProps} />;
const balancesToShow = balances.filter(
(balance) => showUnknown || balance.asset?.name
(balance) =>
showUnknown || (balance.asset && !isUnknownAsset(balance.asset))
);

function toggle() {
setShowUnknown((s) => !s);
}
return (
<CardList>
{balancesToShow.map((balance) => (
<AssetItem
key={balance.asset?.name}
fuelAsset={balance.asset}
amount={balance.amount}
onRemove={onRemove}
onEdit={onEdit}
/>
))}
{balancesToShow.map((balance) => {
if (!balance.asset) return null;

const shouldShowAddAssetBtn = isUnknownAsset(balance.asset);

return (
<AssetItem
key={balance.asset?.name}
fuelAsset={balance.asset}
amount={balance.amount}
onRemove={onRemove}
onEdit={onEdit}
shouldShowAddAssetBtn={shouldShowAddAssetBtn}
/>
);
})}
{!!(!isLoading && unknownLength) && (
<Button size="xs" variant="link" onPress={toggle}>
{showUnknown ? 'Hide' : 'Show'} unknown assets ({unknownLength})
Expand Down
51 changes: 31 additions & 20 deletions packages/app/src/systems/Asset/cache/AssetsCache.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import type { AssetData } from '@fuel-wallet/types';
import type { Asset, Provider } from 'fuels';
import { db } from '~/systems/Core/utils/database';
import { isNft } from '../utils/isNft';
import { fetchNftData } from '../utils/nft';

type Endpoint = {
chainId: number;
Expand Down Expand Up @@ -45,7 +45,8 @@ export class AssetsCache {
timeout,
]);
if (response instanceof Response) {
return response.json();
const jsonResponse = await response.json();
return jsonResponse;
}
} catch (_e: unknown) {}
}
Expand All @@ -61,39 +62,49 @@ export class AssetsCache {
const endpoint = this.getIndexerEndpoint(chainId);
if (!endpoint) return;
// try to get from memory cache first
this.cache[endpoint.chainId] = this.cache[endpoint.chainId] || {};
if (this.cache[endpoint.chainId][assetId]) {
return this.cache[endpoint.chainId][assetId];
this.cache[chainId] = this.cache[chainId] || {};
const assetFromCache = this.cache[chainId][assetId];
if (assetFromCache?.name) {
return assetFromCache;
}

// get from indexed db if not in memory
const savedAsset = await this.storage.getItem(
`${endpoint.chainId}/${assetId}`
);
if (savedAsset) {
this.cache[endpoint.chainId][assetId] = savedAsset;
return savedAsset;
const assetFromDb = await this.storage.getItem(`${chainId}/${assetId}`);
if (assetFromDb?.name) {
this.cache[chainId][assetId] = assetFromDb;
return assetFromDb;
}

const assetFromIndexer = await this.fetchAssetFromIndexer(
endpoint.url,
assetId
);
console.log('asd assetFromIndexer', assetFromIndexer);
if (!assetFromIndexer) return;

const isNftAsset = await isNft({
assetId,
contractId: assetFromIndexer.contractId,
provider,
});

const asset = {
...assetFromIndexer,
isNft: isNftAsset,
isNft: false,
};

this.cache[endpoint.chainId][assetId] = asset;
this.storage.setItem(`${endpoint.chainId}/${assetId}`, asset);
if (assetFromIndexer.contractId) {
const nftData = await fetchNftData({
assetId,
contractId: assetFromIndexer.contractId,
provider,
});
Object.assign(asset, nftData);
}

this.cache[chainId][assetId] = asset;
this.storage.setItem(`${chainId}/${assetId}`, asset);
return asset;
}
asset = {
name: '',
symbol: '',
metadata: {},
};

static getInstance() {
if (!AssetsCache.instance) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ export type AssetItemProps = {
showActions?: boolean;
onRemove?: (assetId: string) => void;
onEdit?: (assetId: string) => void;
shouldShowAddAssetBtn?: boolean;
};

type AssetItemComponent = FC<AssetItemProps> & {
Expand All @@ -49,6 +50,7 @@ export const AssetItem: AssetItemComponent = ({
showActions,
onRemove,
onEdit,
shouldShowAddAssetBtn,
}) => {
const navigate = useNavigate();
const { visibility } = useBalanceVisibility();
Expand Down Expand Up @@ -194,7 +196,7 @@ export const AssetItem: AssetItemComponent = ({
NFT
</Badge>
)}
{(!name || asset.indexed) && !asset.isNft && (
{shouldShowAddAssetBtn && (
<Button
size="xs"
intent="primary"
Expand Down
5 changes: 5 additions & 0 deletions packages/app/src/systems/Asset/utils/assetId.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import type { AssetFuelData } from '@fuel-wallet/types';
import {
type Asset,
type AssetFuel,
Expand Down Expand Up @@ -68,3 +69,7 @@ export const getFuelAssetByAssetId = async (input: {
assetId: input.assetId,
};
};

export const isUnknownAsset = (asset: AssetFuelData) => {
return !asset.name && !asset.verified && !asset.isCustom && !asset.isNft;
};
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { Contract, type Provider } from 'fuels';

export const isNft = async ({
export const fetchNftData = async ({
assetId,
contractId,
provider,
Expand All @@ -11,16 +11,22 @@ export const isNft = async ({
.multiCall([
contract.functions.total_supply({ bits: assetId }),
contract.functions.decimals({ bits: assetId }),
contract.functions.name({ bits: assetId }),
contract.functions.symbol({ bits: assetId }),
])
.dryRun();

const [total_supply, decimals] = result.value;
const [total_supply, decimals, name, symbol] = result.value;

/*
according to sway standards this is how you recognize an NFT:
https://docs.fuel.network/docs/sway-standards/src-20-native-asset/#non-fungible-asset-restrictions
*/
return total_supply.toNumber() === 1 && !decimals;
return {
/*
according to sway standards this is how you recognize an NFT:
https://docs.fuel.network/docs/sway-standards/src-20-native-asset/#non-fungible-asset-restrictions
*/
isNft: total_supply.toNumber() === 1 && !decimals,
name: name as string,
symbol: symbol as string,
};
};

const SRC_20_ABI = {
Expand Down
Loading
Loading