ghost-portal/packages/react-api/src/Api.tsx
Jaco Greeff 1c133e7fc7
React API cleanups (#2412)
* React API cleanups

* ApiState cleanups

* Remove stray log from earlier
2020-03-18 09:47:26 +01:00

188 lines
5.9 KiB
TypeScript

// Copyright 2017-2020 @polkadot/react-api authors & contributors
// This software may be modified and distributed under the terms
// of the Apache-2.0 license. See the LICENSE file for details.
import { ChainProperties } from '@polkadot/types/interfaces';
import { ApiProps, ApiState } from './types';
import React, { useContext, useEffect, useMemo, useState } from 'react';
import ApiPromise from '@polkadot/api/promise';
import { typesChain, typesSpec } from '@polkadot/apps-config/api';
import { isWeb3Injected, web3Accounts, web3Enable } from '@polkadot/extension-dapp';
import { WsProvider } from '@polkadot/rpc-provider';
import { StatusContext } from '@polkadot/react-components/Status';
import { TokenUnit } from '@polkadot/react-components/InputNumber';
import keyring from '@polkadot/ui-keyring';
import uiSettings from '@polkadot/ui-settings';
import ApiSigner from '@polkadot/react-signer/ApiSigner';
import { formatBalance, isTestChain } from '@polkadot/util';
import { setSS58Format } from '@polkadot/util-crypto';
import addressDefaults from '@polkadot/util-crypto/address/defaults';
import ApiContext from './ApiContext';
import registry from './typeRegistry';
interface Props {
children: React.ReactNode;
url?: string;
}
interface InjectedAccountExt {
address: string;
meta: {
name: string;
source: string;
};
}
interface ChainData {
injectedAccounts: InjectedAccountExt[];
properties: ChainProperties;
systemChain: string;
systemName: string;
systemVersion: string;
}
const injectedPromise = new Promise((resolve): void => {
window.addEventListener('load', (): void => {
resolve(web3Enable('polkadot-js/apps'));
});
});
const DEFAULT_DECIMALS = registry.createType('u32', 12);
const DEFAULT_SS58 = registry.createType('u32', addressDefaults.prefix);
let api: ApiPromise;
export { api };
async function retrieve (api: ApiPromise): Promise<ChainData> {
const [properties, systemChain, systemName, systemVersion, injectedAccounts] = await Promise.all([
api.rpc.system.properties(),
api.rpc.system.chain(),
api.rpc.system.name(),
api.rpc.system.version(),
injectedPromise
.then(() => web3Accounts())
.then((accounts): InjectedAccountExt[] =>
accounts.map(({ address, meta }): InjectedAccountExt => ({
address,
meta: {
...meta,
name: `${meta.name} (${meta.source === 'polkadot-js' ? 'extension' : meta.source})`
}
}))
)
.catch((error): InjectedAccountExt[] => {
console.error('web3Enable', error);
return [];
})
]);
return {
injectedAccounts,
properties,
systemChain: (systemChain || '<unknown>').toString(),
systemName: systemName.toString(),
systemVersion: systemVersion.toString()
};
}
async function loadOnReady (api: ApiPromise): Promise<ApiState> {
const { injectedAccounts, properties, systemChain, systemName, systemVersion } = await retrieve(api);
const ss58Format = uiSettings.prefix === -1
? properties.ss58Format.unwrapOr(DEFAULT_SS58).toNumber()
: uiSettings.prefix;
const tokenSymbol = properties.tokenSymbol.unwrapOr(undefined)?.toString();
const tokenDecimals = properties.tokenDecimals.unwrapOr(DEFAULT_DECIMALS).toNumber();
const isDevelopment = isTestChain(systemChain);
console.log('api: found chain', systemChain, JSON.stringify(properties));
// explicitly override the ss58Format as specified
registry.setChainProperties(registry.createType('ChainProperties', { ...properties, ss58Format }));
// FIXME This should be removed (however we have some hanging bits, e.g. vanity)
setSS58Format(ss58Format);
// first setup the UI helpers
formatBalance.setDefaults({
decimals: tokenDecimals,
unit: tokenSymbol
});
TokenUnit.setAbbr(tokenSymbol);
// finally load the keyring
keyring.loadAll({
genesisHash: api.genesisHash,
isDevelopment,
ss58Format,
type: 'ed25519'
}, injectedAccounts);
const defaultSection = Object.keys(api.tx)[0];
const defaultMethod = Object.keys(api.tx[defaultSection])[0];
const apiDefaultTx = api.tx[defaultSection][defaultMethod];
const apiDefaultTxSudo = (api.tx.system && api.tx.system.setCode) || apiDefaultTx;
const isSubstrateV2 = !!Object.keys(api.consts).length;
return {
apiDefaultTx,
apiDefaultTxSudo,
isApiReady: true,
isDevelopment,
isSubstrateV2,
systemChain,
systemName,
systemVersion
};
}
function Api ({ children, url }: Props): React.ReactElement<Props> | null {
const { queuePayload, queueSetTxStatus } = useContext(StatusContext);
const [state, setState] = useState<ApiState>({ isApiReady: false } as unknown as ApiState);
const [isApiConnected, setIsApiConnected] = useState(false);
const [isApiInitialized, setIsApiInitialized] = useState(false);
const [isWaitingInjected, setIsWaitingInjected] = useState(isWeb3Injected);
const props = useMemo<ApiProps>(
() => ({ ...state, api, isApiConnected, isApiInitialized, isWaitingInjected }),
[isApiConnected, isApiInitialized, isWaitingInjected, state]
);
// initial initialization
useEffect((): void => {
const provider = new WsProvider(url);
const signer = new ApiSigner(queuePayload, queueSetTxStatus);
api = new ApiPromise({ provider, registry, signer, typesChain, typesSpec });
api.on('connected', (): void => setIsApiConnected(true));
api.on('disconnected', (): void => setIsApiConnected(false));
api.on('ready', async (): Promise<void> => {
try {
setState(await loadOnReady(api));
} catch (error) {
console.error('Unable to load chain', error);
}
});
injectedPromise
.then((): void => setIsWaitingInjected(false))
.catch((error: Error) => console.error(error));
setIsApiInitialized(true);
}, []);
if (!props.isApiInitialized) {
return null;
}
return (
<ApiContext.Provider value={props}>
{children}
</ApiContext.Provider>
);
}
export default React.memo(Api);