@astar-network/types
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.4 • Public • Published

    @astar-network/types

    NPM

    This package is meant to be used with the @polakdot-js/api library.

    Available Types

    • shidenDefinitions (Kusama Parachain)
    • shibuyaDefinitions (Shiden Testnet)
    • dustyDefinitions [deprecated]
    • plasmDefinitions [deprecated]

    Usage

    Importing Types

    You can use the ApiOptions interface to set the node configuration before initializing the Polkadot API instance.

    import { WsProvider, ApiPromise } from '@polkadot/api';
    import { ApiOptions } from '@polkadot/api/types';
    import { shidenDefinitions} from '@astar-network/types';
    
    // using ApiOptions interface
    const options: ApiOptions = {
        provider: new WsProvider('ws://localhost:9944'),
        types: {
            ...shidenDefinitions,
        },
    };
    
    const api = new ApiRx(options);

    Or, you can pass the node types directly when initializing the API instance.

    import { WsProvider, ApiPromise } from '@polkadot/api';
    import { shidenDefinitions} from '@astar-network/types';
    
    // using the ApiPromise class
    const api = await ApiPromise.create({
        provider: new WsProvider('ws://localhost:9944'),
        types: {
            ...shidenDefinitions,
        }
    });
    
    await api.isReady;

    Finally, you can register the types after the API instance has already been created.

    import { shidenDefinitions} from '@astar-network/types';
    
    // already initialized api instance
    await api.registerTypes(shidenDefinitions);

    Generating Types

    First, you'll have to manually define chain specific types for each pallets from the src/interfaces/<module-name>/definitions.ts file.

    The script should export an object that looks something like this:

    export default {
        types: {
            StructA: {
                id: 'u8',
                value_hash: 'H256',
            },
            TypeA: 'H256',
            ...
        },
    };

    Install

    npm i @astar-network/types

    DownloadsWeekly Downloads

    1

    Version

    1.0.4

    License

    MIT

    Unpacked Size

    7.46 kB

    Total Files

    8

    Last publish

    Collaborators

    • nikhilastar
    • shunsukew
    • codespool
    • willastar
    • hoonsubin