-
Notifications
You must be signed in to change notification settings - Fork 11
api.entities.Asset.Base.BaseAsset.BaseAsset
api/entities/Asset/Base/BaseAsset.BaseAsset
Class used to manage functionality common to all assets.
-
Entity<UniqueIdentifiers,string>↳
BaseAsset
- addRequiredMediators
- currentFundingRound
- details
- freeze
- getIdentifiers
- getRequiredMediators
- getVenueFilteringDetails
- isEqual
- isFrozen
- modify
- removeRequiredMediators
- setVenueFiltering
- toHuman
- transferOwnership
- unfreeze
- generateUuid
- unserialize
• compliance: Compliance
api/entities/Asset/Base/BaseAsset.ts:66
• did: string
Identity ID of the Asset (used for Claims)
api/entities/Asset/Base/BaseAsset.ts:74
• documents: Documents
api/entities/Asset/Base/BaseAsset.ts:67
• metadata: Metadata
api/entities/Asset/Base/BaseAsset.ts:68
• permissions: Permissions
api/entities/Asset/Base/BaseAsset.ts:69
• ticker: string
ticker of the Asset
api/entities/Asset/Base/BaseAsset.ts:79
• uuid: string
▸ addRequiredMediators(args, opts?): Promise<GenericPolymeshTransaction<void, void>>
Add required mediators. Mediators must approve any trades involving the asset
| Name | Type |
|---|---|
args |
AssetMediatorParams |
opts? |
ProcedureOpts |
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
api/entities/Asset/Base/BaseAsset.ts:218
▸ currentFundingRound(): Promise<null | string>
Retrieve the Asset's funding round
Promise<null | string>
Note
can be subscribed to
api/entities/Asset/Base/BaseAsset.ts:454
▸ currentFundingRound(callback): Promise<UnsubCallback>
| Name | Type |
|---|---|
callback |
SubCallback<null | string> |
Promise<UnsubCallback>
api/entities/Asset/Base/BaseAsset.ts:455
▸ details(): Promise<AssetDetails>
Retrieve the Asset's data
Promise<AssetDetails>
Note
can be subscribed to
api/entities/Asset/Base/BaseAsset.ts:307
▸ details(callback): Promise<UnsubCallback>
| Name | Type |
|---|---|
callback |
SubCallback<AssetDetails> |
Promise<UnsubCallback>
api/entities/Asset/Base/BaseAsset.ts:308
▸ freeze(opts?): Promise<GenericPolymeshTransaction<void, void>>
Freeze transfers of the Asset
| Name | Type |
|---|---|
opts? |
ProcedureOpts |
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
api/entities/Asset/Base/BaseAsset.ts:198
▸ getIdentifiers(): Promise<SecurityIdentifier[]>
Retrieve the Asset's identifiers list
Promise<SecurityIdentifier[]>
Note
can be subscribed to
api/entities/Asset/Base/BaseAsset.ts:237
▸ getIdentifiers(callback?): Promise<UnsubCallback>
| Name | Type |
|---|---|
callback? |
SubCallback<SecurityIdentifier[]> |
Promise<UnsubCallback>
api/entities/Asset/Base/BaseAsset.ts:238
▸ getRequiredMediators(): Promise<Identity[]>
Get required Asset mediators. These Identities must approve any Instruction involving the asset
Promise<Identity[]>
api/entities/Asset/Base/BaseAsset.ts:400
▸ getVenueFilteringDetails(): Promise<VenueFilteringDetails>
Get venue filtering details
Promise<VenueFilteringDetails>
api/entities/Asset/Base/BaseAsset.ts:419
▸ isEqual(entity): boolean
Determine whether this Entity is the same as another one
| Name | Type |
|---|---|
entity |
Entity<unknown, unknown> |
boolean
▸ isFrozen(): Promise<boolean>
Check whether transfers are frozen for the Asset
Promise<boolean>
Note
can be subscribed to
api/entities/Asset/Base/BaseAsset.ts:273
▸ isFrozen(callback): Promise<UnsubCallback>
| Name | Type |
|---|---|
callback |
SubCallback<boolean> |
Promise<UnsubCallback>
api/entities/Asset/Base/BaseAsset.ts:274
▸ modify(args, opts?): Promise<GenericPolymeshTransaction<Asset, Asset>>
Modify some properties of the Asset
| Name | Type |
|---|---|
args |
ModifyAssetParams |
opts? |
ProcedureOpts |
Promise<GenericPolymeshTransaction<Asset, Asset>>
Throws
if the passed values result in no changes being made to the Asset
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
api/entities/Asset/Base/BaseAsset.ts:124
▸ removeRequiredMediators(args, opts?): Promise<GenericPolymeshTransaction<void, void>>
Remove required mediators
| Name | Type |
|---|---|
args |
AssetMediatorParams |
opts? |
ProcedureOpts |
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
api/entities/Asset/Base/BaseAsset.ts:228
▸ setVenueFiltering(args, opts?): Promise<GenericPolymeshTransaction<void, void>>
Enable/disable venue filtering for this Asset and/or set allowed/disallowed venues
| Name | Type |
|---|---|
args |
SetVenueFilteringParams |
opts? |
ProcedureOpts |
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
api/entities/Asset/Base/BaseAsset.ts:102
▸ toHuman(): string
Return the NftCollection's ticker
string
api/entities/Asset/Base/BaseAsset.ts:510
▸ transferOwnership(args, opts?): Promise<GenericPolymeshTransaction<AuthorizationRequest, AuthorizationRequest>>
Transfer ownership of the Asset to another Identity. This generates an authorization request that must be accepted by the recipient
| Name | Type |
|---|---|
args |
TransferAssetOwnershipParams |
opts? |
ProcedureOpts |
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
api/entities/Asset/Base/BaseAsset.ts:92
▸ unfreeze(opts?): Promise<GenericPolymeshTransaction<void, void>>
Unfreeze transfers of the Asset
| Name | Type |
|---|---|
opts? |
ProcedureOpts |
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
api/entities/Asset/Base/BaseAsset.ts:208
▸ Static generateUuid<Identifiers>(identifiers): string
Generate the Entity's UUID from its identifying properties
| Name |
|---|
Identifiers |
| Name | Type |
|---|---|
identifiers |
Identifiers |
string
▸ Static unserialize<Identifiers>(serialized): Identifiers
Unserialize a UUID into its Unique Identifiers
| Name |
|---|
Identifiers |
| Name | Type | Description |
|---|---|---|
serialized |
string |
UUID to unserialize |
Identifiers
Entities
- Account
- Asset
- Authorization Request
- Checkpoint
- Checkpoint Schedule
- Corporate Action
- Corporate Action Base
- Custom Permission Group
- Default Portfolio
- Default Trusted Claim Issuer
- Dividend Distribution
- Entity
- Identity
- Instruction
- Known Permission Group
- Metadata Entry
- Multi Sig Proposal
- Numbered Portfolio
- Offering
- Permission Group
- Portfolio
- Subsidies
- Subsidy
- Ticker Reservation
- Venue
- Authorizations
- Types