Noc2/nbv-client-api

Hashed Polkadot API

This client api is used to interacting with gatedMarketplace pallet, this allows quick connection, queries and calls to TX on this pallet.

To install the hashed polkadot api, run the following command:

npm i --save @jmgayosso/hashed-polkadot-api or yarn add --save @jmgayosso/hashed-polkadot-api

To connect to 'hashed chain' we can use an instance of PolkadotApi that handles the connection and provides methods to sign tx, requestUsers from polkadotJS and sign and verify messages.

import { PolkadotApi } from '@jmgayosso/hashed-polkadot-api'

const polkadotApi = new PolkadotApi({
  chainURI: 'wss://n1.hashed.systems',
  appName: 'Hashed portal'
})
await polkadotApi.connect()

PolkadotApi is requeried to create an instance of MarketplaceApi, this class provides all methods to interact with gatedMarketplace pallet.

import { PolkadotApi, MarketplaceApi } from '@jmgayosso/hashed-polkadot-api'

const polkadotApi = new PolkadotApi('wss://n1.hashed.systems')
await polkadotApi.connect()

const marketplaceApi = new MarketplaceApi(polkadotApi)

Once an instance of MarketplaceApi is created, the following methods can be accessed.

MarketplaceApi

• getMarketplaceById: Get marketplace's general details by marketplaceId

await marketplaceApi.getMarketplaceById({
  marketId: '0xa54035afb49b42cdacbe27c830dd1b66078069886e80cdd8bab3d139caa0489e'
})

• getAuthoritiesByMarketplace: Get authorities by marketplace

await marketplaceApi.getAuthoritiesByMarketplace({
  marketId: '0xa54035afb49b42cdacbe27c830dd1b66078069886e80cdd8bab3d139caa0489e'
})

• getAllMarketplaces: Get all marketplaces

await marketplaceApi.getAllMarketplaces({
  startKey,
  pageSize
})

• getMyMarketplaces: Get marketplace's participants by market id

await marketplaceApi.getMyMarketplaces({
   accountId
})

• getParticipantsByMarket: Get marketplace's participants by marketplace

await marketplaceApi.getParticipantsByMarket({
  marketId: '0xa54035afb49b42cdacbe27c830dd1b66078069886e80cdd8bab3d139caa0489e'
})

• applyFor: This function calls to 'apply' extrinsic

await marketplaceApi.applyFor({
  marketId,
  user,
  fields,
  custodianFields
})

• reapplyFor: This function call reapply extrinsic

await marketplaceApi.reapplyFor({
    marketId,
    user,
    fields,
    custodianFields
})

• createMarketplace: This function call createMarketplace extrinsic

await marketplaceApi.createMarketplace({
  admin,
  user,
  label
})

• enrollApplicant: This function call enrollApplicant extrinsic

await marketplaceApi.enrollApplicant({
  marketId,
  user,
  accountOrApplication,
  approved,
  feedback
})

• getApplicationStatusByAccount: Get application information by account

await marketplaceApi.getApplicationStatusByAccount({
  marketId,
  account
})

• getMarketplacesByAuthority: Get marketplaces by authority

await marketplaceApi.getMarketplacesByAuthority({
  accountId,
  marketplaceId
})