Class DecentrawebAPI

Decentraweb API wrapper. This API is used during registration process. Usually you don't need to use it directly.

Hierarchy

DecentrawebAPI

Index

Constructors

Properties

baseUrl chainId network

Methods

approveSLDRegistration approveSelfSLDRegistration approveTLDRegistration convertPrice convertPriceBatch domainFromHash get getSLDApprovalPayload getStakedDomains post requestPolygonTLDRegistration requestSelfSLDRegistration sendPolygonTLDCommitment submitPolygonTLDRegistration

Constructors

constructor

new DecentrawebAPI(network): DecentrawebAPI
Parameters
- network: Network
Returns DecentrawebAPI
- Defined in packages/core/src/api/index.ts:39

Properties

`Readonly` baseUrl

baseUrl: string

`Readonly` chainId

chainId: ChainId

`Readonly` network

network: Network

Methods

approveSLDRegistration

approveSLDRegistration(owner, entries, isFeesInDweb?): Promise<SubdomainApproval>
Parameters
- owner: string
- entries: SubdomainEntry[]
- isFeesInDweb: boolean = false
Returns Promise<SubdomainApproval>
- Defined in packages/core/src/api/index.ts:109

approveSelfSLDRegistration

approveSelfSLDRegistration(payload): Promise<SubdomainApproval>
Parameters
- payload: SubdomainApprovalPayload
Returns Promise<SubdomainApproval>
- Defined in packages/core/src/api/index.ts:97

approveTLDRegistration

approveTLDRegistration(owner, names): Promise<TLDApproval>
Parameters
- owner: string
- names: string[]
Returns Promise<TLDApproval>
- Defined in packages/core/src/api/index.ts:56

convertPrice

convertPrice(priceUSD): Promise<PriceConversionResult>
Convert price from USD to ETH, DWEB, and MATIC
Parameters
- priceUSD: number
  
  Price in USD
Returns Promise<PriceConversionResult>
- Defined in packages/core/src/api/index.ts:137

convertPriceBatch

convertPriceBatch(pricesUSD): Promise<PriceConversionResult[]>
Convert multiple amounts from USD to ETH, DWEB, and MATIC
Parameters
- pricesUSD: number[]
  
  array of prices in USD
Returns Promise<PriceConversionResult[]>
- Defined in packages/core/src/api/index.ts:146

domainFromHash

domainFromHash(hash): Promise<null | string>
Parameters
- hash: string
Returns Promise<null | string>
- Defined in packages/core/src/api/index.ts:197

`Private` get

get<R>(path, query): Promise<R>
Type Parameters
- R
Parameters
- path: string
- query: Record<string, string>
Returns Promise<R>
- Defined in packages/core/src/api/index.ts:202

`Private` getSLDApprovalPayload

getSLDApprovalPayload(owner, entries, isFeesInDweb?, sender?): SubdomainApprovalPayload
Parameters
- owner: string
- entries: SubdomainEntry[]
- isFeesInDweb: boolean = false
- sender: string = ''
Returns SubdomainApprovalPayload
- Defined in packages/core/src/api/index.ts:224

getStakedDomains

getStakedDomains(domains): Promise<api.StakedDomain[]>
Parameters
- domains: string[]
Returns Promise<api.StakedDomain[]>
- Defined in packages/core/src/api/index.ts:126

`Private` post

post<R>(path, query, data): Promise<R>
Type Parameters
- R
Parameters
- path: string
- query: Record<string, string>
- data: any
Returns Promise<R>
- Defined in packages/core/src/api/index.ts:210

requestPolygonTLDRegistration

requestPolygonTLDRegistration(payload): Promise<TypedData>
Parameters
- payload: RequestPolyTLDRegistrationPayload
Returns Promise<TypedData>
- Defined in packages/core/src/api/index.ts:173

requestSelfSLDRegistration

requestSelfSLDRegistration(sender, owner, entries, isFeesInDweb?): Promise<{
payload: SubdomainApprovalPayload;
typedData: TypedData;
}>
Parameters
- sender: string
- owner: string
- entries: SubdomainEntry[]
- isFeesInDweb: boolean = false
Returns Promise<{
payload: SubdomainApprovalPayload;
typedData: TypedData;
}>
- Defined in packages/core/src/api/index.ts:79

sendPolygonTLDCommitment

sendPolygonTLDCommitment(payload): Promise<PolyTLDCommitmentRes>
Parameters
- payload: PolyTLDCommitmentPayload
Returns Promise<PolyTLDCommitmentRes>
- Defined in packages/core/src/api/index.ts:162

submitPolygonTLDRegistration

submitPolygonTLDRegistration(payload): Promise<PolyTLDRegistrationRes>
Parameters
- payload: SubmitPolyTLDRegistrationPayload
Returns Promise<PolyTLDRegistrationRes>
- Defined in packages/core/src/api/index.ts:184

Generated using TypeDoc