Class: BaseAsset

Defined in: src/api/entities/Asset/Base/BaseAsset.ts:68

Class used to manage functionality common to all assets.

Extends

• Entity<UniqueIdentifiers, string>

Extended by

• FungibleAsset
• NftCollection

Properties

compliance

compliance: Compliance

Defined in: src/api/entities/Asset/Base/BaseAsset.ts:70

---

documents

documents: Documents

Defined in: src/api/entities/Asset/Base/BaseAsset.ts:71

---

id

id: string

Defined in: src/api/entities/Asset/Base/BaseAsset.ts:78

Unique ID of the Asset in UUID format

---

metadata

metadata: Metadata

Defined in: src/api/entities/Asset/Base/BaseAsset.ts:72

---

permissions

permissions: Permissions

Defined in: src/api/entities/Asset/Base/BaseAsset.ts:73

---

uuid

uuid: string

Defined in: src/api/entities/Entity.ts:46

Inherited from

Entity.uuid

Accessors

rawId

Get Signature

get rawId(): string

Defined in: src/api/entities/Asset/Base/BaseAsset.ts:85

Unique ID of the Asset in hex format

Note

Although UUID format is the usual representation of asset IDs, generic polkadot/substrate tools usually expect it in hex format

Returns

string

Methods

addRequiredMediators()

addRequiredMediators(args: AssetMediatorParams, opts?: ProcedureOpts): Promise<GenericPolymeshTransaction<void, void>>

Defined in: src/api/entities/Asset/Base/BaseAsset.ts:212

Add required mediators. Mediators must approve any trades involving the asset

Parameters

Parameter	Type
args	AssetMediatorParams
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>

Note

this method is of type ProcedureMethod, which means you can call addRequiredMediators.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

---

currentFundingRound()

Call Signature

currentFundingRound(): Promise<string | null>

Defined in: src/api/entities/Asset/Base/BaseAsset.ts:499

Retrieve the Asset's funding round

Returns

Promise<string | null>

Promise that resolves to the current funding round name or null if not set

Call Signature

currentFundingRound(callback: SubCallback<string | null>): Promise<UnsubCallback>

Defined in: src/api/entities/Asset/Base/BaseAsset.ts:509

Retrieve the Asset's funding round

Parameters

Parameter	Type	Description
callback	SubCallback<string | null>	Callback function that receives funding round updates

Returns

Promise<UnsubCallback>

Promise that resolves to an unsubscribe function

Note

can be subscribed to, if connected to node using a web socket

---

details()

Call Signature

details(): Promise<AssetDetails>

Defined in: src/api/entities/Asset/Base/BaseAsset.ts:332

Retrieve the Asset's data

Returns

Promise<AssetDetails>

Promise that resolves to the Asset details

Call Signature

details(callback: SubCallback<AssetDetails>): Promise<UnsubCallback>

Defined in: src/api/entities/Asset/Base/BaseAsset.ts:342

Retrieve the Asset's data

Parameters

Parameter	Type	Description
callback	SubCallback<AssetDetails>	Callback function that receives Asset details updates

Returns

Promise<UnsubCallback>

Promise that resolves to an unsubscribe function

Note

can be subscribed to, if connected to node using a web socket

---

freeze()

freeze(opts?: ProcedureOpts): Promise<GenericPolymeshTransaction<void, void>>

Defined in: src/api/entities/Asset/Base/BaseAsset.ts:202

Freeze transfers of the Asset

Parameters

Parameter	Type
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>

Note

this method is of type NoArgsProcedureMethod, which means you can call freeze.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

---

getIdentifiers()

Call Signature

getIdentifiers(): Promise<SecurityIdentifier[]>

Defined in: src/api/entities/Asset/Base/BaseAsset.ts:241

Retrieve the Asset's identifiers list

Returns

Promise<SecurityIdentifier[]>

Promise that resolves to the list of security identifiers

Call Signature

getIdentifiers(callback?: SubCallback<SecurityIdentifier[]>): Promise<UnsubCallback>

Defined in: src/api/entities/Asset/Base/BaseAsset.ts:251

Retrieve the Asset's identifiers list

Parameters

Parameter	Type	Description
callback?	SubCallback<SecurityIdentifier[]>	Callback function that receives identifier updates

Returns

Promise<UnsubCallback>

Promise that resolves to an unsubscribe function

Note

can be subscribed to, if connected to node using a web socket

---

getRequiredMediators()

getRequiredMediators(): Promise<Identity[]>

Defined in: src/api/entities/Asset/Base/BaseAsset.ts:444

Get required Asset mediators. These Identities must approve any Instruction involving the asset

Returns

Promise<Identity[]>

---

getVenueFilteringDetails()

getVenueFilteringDetails(): Promise<VenueFilteringDetails>

Defined in: src/api/entities/Asset/Base/BaseAsset.ts:464

Get venue filtering details

Returns

Promise<VenueFilteringDetails>

---

isEqual()

isEqual(entity: Entity<unknown, unknown>): boolean

Defined in: src/api/entities/Entity.ts:61

Determine whether this Entity is the same as another one

Parameters

Parameter	Type
entity	Entity<unknown, unknown>

Returns

boolean

Inherited from

Entity.isEqual

---

isFrozen()

Call Signature

isFrozen(): Promise<boolean>

Defined in: src/api/entities/Asset/Base/BaseAsset.ts:289

Check whether transfers are frozen for the Asset

Returns

Promise<boolean>

Promise that resolves to true if transfers are frozen, false otherwise

Call Signature

isFrozen(callback: SubCallback<boolean>): Promise<UnsubCallback>

Defined in: src/api/entities/Asset/Base/BaseAsset.ts:299

Check whether transfers are frozen for the Asset

Parameters

Parameter	Type	Description
callback	SubCallback<boolean>	Callback function that receives frozen status updates

Returns

Promise<UnsubCallback>

Promise that resolves to an unsubscribe function

Note

can be subscribed to, if connected to node using a web socket

---

linkTicker()

linkTicker(args: LinkTickerToAssetParams, opts?: ProcedureOpts): Promise<GenericPolymeshTransaction<void, void>>

Defined in: src/api/entities/Asset/Base/BaseAsset.ts:225

Link ticker to the asset

Parameters

Parameter	Type
args	LinkTickerToAssetParams
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>

Note

if ticker is already reserved, then required role:

• Ticker Owner

Note

this method is of type ProcedureMethod, which means you can call linkTicker.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

---

modify()

modify(args: ModifyAssetParams, opts?: ProcedureOpts): Promise<GenericPolymeshTransaction<Asset, Asset>>

Defined in: src/api/entities/Asset/Base/BaseAsset.ts:121

Modify some properties of the Asset

Parameters

Parameter	Type
args	ModifyAssetParams
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<Asset, Asset>>

Throws

if the passed values result in no changes being made to the Asset

Throws

if the passed assetType is not a known asset type or a custom type that has not been created on the chain

Throws

if trying to modify an NftCollection's assetType

Note

this method is of type ProcedureMethod, which means you can call modify.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

---

removeRequiredMediators()

removeRequiredMediators(args: AssetMediatorParams, opts?: ProcedureOpts): Promise<GenericPolymeshTransaction<void, void>>

Defined in: src/api/entities/Asset/Base/BaseAsset.ts:217

Remove required mediators

Parameters

Parameter	Type
args	AssetMediatorParams
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>

Note

this method is of type ProcedureMethod, which means you can call removeRequiredMediators.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

---

setVenueFiltering()

setVenueFiltering(args: SetVenueFilteringParams, opts?: ProcedureOpts): Promise<GenericPolymeshTransaction<void, void>>

Defined in: src/api/entities/Asset/Base/BaseAsset.ts:102

Enable/disable venue filtering for this Asset and/or set allowed/disallowed venues

Parameters

Parameter	Type
args	SetVenueFilteringParams
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>

Note

this method is of type ProcedureMethod, which means you can call setVenueFiltering.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

---

toHuman()

toHuman(): string

Defined in: src/api/entities/Asset/Base/BaseAsset.ts:565

Return the BaseAsset's ID

Returns

string

Overrides

Entity.toHuman

---

transferOwnership()

transferOwnership(args: TransferAssetOwnershipParams, opts?: ProcedureOpts): Promise<GenericPolymeshTransaction<AuthorizationRequest, AuthorizationRequest>>

Defined in: src/api/entities/Asset/Base/BaseAsset.ts:97

Transfer ownership of the Asset to another Identity. This generates an authorization request that must be accepted by the recipient

Parameters

Parameter	Type
args	TransferAssetOwnershipParams
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<AuthorizationRequest, AuthorizationRequest>>

Note

this will create Authorization Request which has to be accepted by the target Identity. An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived. Also, an Account or Identity can directly fetch the details of an Authorization Request by calling authorizations.getOne

Note

this method is of type ProcedureMethod, which means you can call transferOwnership.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

---

unfreeze()

unfreeze(opts?: ProcedureOpts): Promise<GenericPolymeshTransaction<void, void>>

Defined in: src/api/entities/Asset/Base/BaseAsset.ts:207

Unfreeze transfers of the Asset

Parameters

Parameter	Type
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>

Note

this method is of type NoArgsProcedureMethod, which means you can call unfreeze.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

---

unlinkTicker()

unlinkTicker(opts?: ProcedureOpts): Promise<GenericPolymeshTransaction<void, void>>

Defined in: src/api/entities/Asset/Base/BaseAsset.ts:234

Unlink ticker from the Asset

Parameters

Parameter	Type
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>

Note

Only the ticker owner is allowed to unlink the Asset

Throws

if there is no ticker to unlink

Note

this method is of type NoArgsProcedureMethod, which means you can call unlinkTicker.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

---

generateUuid()

static generateUuid<Identifiers>(identifiers: Identifiers): string

Defined in: src/api/entities/Entity.ts:14

Generate the Entity's UUID from its identifying properties

Type Parameters

Type Parameter
Identifiers

Parameters

Parameter	Type	Description
identifiers	Identifiers	‐

Returns

string

Inherited from

Entity.generateUuid

---

unserialize()

static unserialize<Identifiers>(serialized: string): Identifiers

Defined in: src/api/entities/Entity.ts:23

Unserialize a UUID into its Unique Identifiers

Type Parameters

Type Parameter
Identifiers

Parameters

Parameter	Type	Description
serialized	string	UUID to unserialize

Returns

Identifiers

Inherited from

Entity.unserialize