Polymesh SDK API Reference
v10.0.0
v10.0.0
  • Introduction
  • Globals
  • Classes
    • Account
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • Context
    • CorporateAction
    • CorporateActions
    • Count
    • CustomPermissionGroup
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • KnownPermissionGroup
    • Middleware
    • NumberedPortfolio
    • Offerings
    • Percentage
    • PermissionGroup
    • Permissions
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • SecurityToken
    • Settlements
    • Sto
    • TickerReservation
    • TokenHolders
    • TokenPermissions
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
    • AffirmationStatus
    • AuthorizationType
    • CalendarUnit
    • ClaimType
    • ConditionTarget
    • ConditionType
    • CorporateActionKind
    • CountryCode
    • ErrorCode
    • InstructionStatus
    • InstructionType
    • KnownTokenType
    • PermissionGroupType
    • PermissionType
    • ProposalStage
    • RoleType
    • ScopeType
    • SignerType
    • StoBalanceStatus
    • StoSaleStatus
    • StoTimingStatus
    • TargetTreatment
    • TickerReservationStatus
    • TokenIdentifierType
    • TransactionArgumentType
    • TransactionQueueStatus
    • TransactionStatus
    • TransferError
    • TransferRestrictionType
    • TransferStatus
    • TxGroup
    • VenueType
  • Interfaces
    • ActiveTransferRestrictions
    • AddBatchTransactionOpts
    • AddClaimsParams
    • AddInstructionParams
    • AddInstructionsParams
    • AddInvestorUniquenessClaimParams
    • AddPairBaseParams
    • AddTransactionOpts
    • AddTransactionOptsBase
    • AgentWithGroup
    • ArrayTransactionArgument
    • Balance
    • CalendarPeriod
    • CddProviderRole
    • CheckpointWithData
    • ClaimClassicTickerParams
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • ControllerTransferParams
    • CorporateActionDefaults
    • CorporateActionTargets
    • CountTransferRestriction
    • CountTransferRestrictionInput
    • CreateCheckpointScheduleParams
    • CreateGroupParams
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • DistributionParticipant
    • DistributionPayment
    • DistributionWithDetails
    • DividendDistributionDetails
    • DividendDistributionParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • FeesBreakdown
    • GroupedInstructions
    • HistoricAgentOperation
    • HistoricSettlement
    • HumanReadable
    • IdentityBalance
    • IdentityRole
    • IdentityWithClaims
    • InstructionAffirmation
    • InvestInStoParams
    • Investment
    • InviteAccountParams
    • InviteExternalAgentParams
    • IssueTokensParams
    • KeyringPair
    • LeaveIdentityParams
    • Leg
    • LinkCaDocsParams
    • MiddlewareConfig
    • ModifyCorporateActionsAgentParams
    • ModifyInstructionAffirmationParams
    • ModifyPrimaryIssuanceAgentParams
    • ModifySignerPermissionsParams
    • ModifyTokenTrustedClaimIssuersAddSetParams
    • ModifyTokenTrustedClaimIssuersRemoveParams
    • MoveFundsParams
    • NetworkProperties
    • PaginationOptions
    • PayDividendsParams
    • PercentageTransferRestriction
    • PercentageTransferRestrictionInput
    • PlainTransactionArgument
    • PortfolioBalance
    • PortfolioCustodianRole
    • PortfolioMovement
    • ProcedureAuthorizationStatus
    • ProcedureMethod
    • ProcedureOpts
    • ProposalDetails
    • ProposalTimeFrames
    • ProposalVote
    • RedeemTokenParams
    • RegisterIdentityParams
    • RemoveCheckpointScheduleParams
    • RemoveCorporateActionParams
    • RemoveExternalAgentParams
    • RemoveSecondaryKeysParams
    • RenamePortfolioParams
    • Requirement
    • RequirementCompliance
    • ReserveTickerParams
    • ResultSet
    • RevokeClaimsParams
    • ScheduleDetails
    • ScheduleWithDetails
    • Scope
    • SecondaryKey
    • SectionPermissions
    • SecurityTokenDetails
    • SetAssetRequirementsParams
    • SetCountTransferRestrictionsParams
    • SetCustodianParams
    • SetGroupPermissionsParams
    • SetPercentageTransferRestrictionsParams
    • SetPermissionGroupParams
    • SetTokenDocumentsParams
    • SettlementLeg
    • SignerValue
    • SimpleEnumTransactionArgument
    • SimplePermissions
    • StoDetails
    • StoStatus
    • StoTier
    • StoWithDetails
    • Subsidy
    • TaxWithholding
    • ThirdPartyFees
    • TickerOwnerRole
    • TickerReservationDetails
    • Tier
    • ToggleFreezeSecondaryKeysParams
    • ToggleFreezeStoParams
    • ToggleFreezeTransfersParams
    • TogglePauseRequirementsParams
    • TokenBase
    • TokenDocument
    • TokenIdentifier
    • TokenWithGroup
    • TransactionPermissions
    • TransactionsParams
    • TransferBreakdown
    • TransferPolyxParams
    • TransferRestriction
    • TransferRestrictionInputBase
    • TransferRestrictionResult
    • TransferTickerOwnershipParams
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • TxGroupParams
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
    • WaivePermissionsParams
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • Protected Optional _id
  • Protected context
  • owner
  • uuid
  • Methods
  • exists
  • getCustodian
  • getTokenBalances
  • getTransactionHistory
  • isCustodiedBy
  • isEqual
  • isOwnedBy
  • moveFunds
  • quitCustody
  • setCustodian
  • toJson
  • Static generateUuid
  • Static unserialize

Was this helpful?

  1. Classes

DefaultPortfolio

PreviousCustomPermissionGroupNextDefaultTrustedClaimIssuer

Last updated 3 years ago

Was this helpful?

Represents the default Portfolio for an Identity

Hierarchy

↳

↳ DefaultPortfolio

Index

Properties

Methods

Properties

Protected Optional _id

• _id? : BigNumber

internal Portfolio identifier (unused for default Portfolio)

Protected context

owner

identity of the Portfolio's owner

uuid

• uuid: string

Methods

exists

▸ exists(): Promise‹boolean›

Determine whether this Portfolio exists on chain

Returns: Promise‹boolean›

getCustodian

Retrieve the custodian Identity of this Portfolio

note if no custodian is set, the owner Identity is returned

getTokenBalances

Retrieve the balances of all assets in this Portfolio

Parameters:

Name
Type

args?

undefined | object

getTransactionHistory

Retrieve a list of transactions where this portfolio was involved. Can be filtered using parameters

note supports pagination

note uses the middleware

Parameters:

â–ªDefault value filters: object= {}

Name
Type
Description

account?

undefined | string

account involved in the settlement

size?

undefined | number

page size

start?

undefined | number

page offset

ticker?

undefined | string

ticker involved in the transaction

isCustodiedBy

▸ isCustodiedBy(args?: undefined | object): Promise‹boolean›

Return whether an Identity is the Portfolio custodian

Parameters:

Name
Type

args?

undefined | object

Returns: Promise‹boolean›

isEqual

Determine whether this Entity is the same as another one

Parameters:

Name
Type

entity

Returns: boolean

isOwnedBy

▸ isOwnedBy(args?: undefined | object): Promise‹boolean›

Return whether an Identity is the Portfolio owner

Parameters:

Name
Type

args?

undefined | object

Returns: Promise‹boolean›

moveFunds

Moves funds from this Portfolio to another one owned by the same Identity

note required role:

  • Portfolio Custodian

Parameters:

Name
Type

args

opts?

quitCustody

Returns the custody of the portfolio to the portfolio owner unilaterally

note required role:

  • Portfolio Custodian

Parameters:

Name
Type

args

void

opts?

setCustodian

Send an invitation to an Identity to assign it as custodian for this Portfolio

note this may create an AuthorizationRequest which has to be accepted by the corresponding Identity. An Account or Identity can fetch its pending Authorization Requests by calling authorizations.getReceived

note required role:

  • Portfolio Custodian

Parameters:

Name
Type

args

opts?

toJson

Return the Portfolio ID and owner DID

Static generateUuid

▸ generateUuid‹Identifiers›(identifiers: Identifiers): string

Generate the Entity's UUID from its identifying properties

Type parameters:

â–ª Identifiers

Parameters:

Name
Type
Description

identifiers

Identifiers

Returns: string

Static unserialize

▸ unserialize‹Identifiers›(serialized: string): Identifiers

Unserialize a UUID into its Unique Identifiers

Type parameters:

â–ª Identifiers

Parameters:

Name
Type
Description

serialized

string

UUID to unserialize

Returns: Identifiers

Inherited from .

Defined in

• context:

Inherited from .

Defined in

• owner:

Inherited from .

Defined in

Inherited from .

Defined in

Overrides .

Defined in

▸ getCustodian(): Promise‹›

Inherited from .

Defined in

Returns: Promise‹›

▸ getTokenBalances(args?: undefined | object): Promise‹[]›

Inherited from .

Defined in

Returns: Promise‹[]›

▸ getTransactionHistory(filters: object): Promise‹‹››

Inherited from .

Defined in

Returns: Promise‹‹››

Inherited from .

Defined in

▸ isEqual(entity: ‹unknown, unknown›): boolean

Inherited from .

Defined in

‹unknown, unknown›

Inherited from .

Defined in

▸ moveFunds(args: , opts?: ): Promise‹‹void››

Inherited from .

Defined in

note this method is of type , which means you can call moveFunds.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹void››

▸ quitCustody(args: void, opts?: ): Promise‹‹void››

Inherited from .

Defined in

note this method is of type , which means you can call quitCustody.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹void››

▸ setCustodian(args: , opts?: ): Promise‹‹void››

Inherited from .

Defined in

note this method is of type , which means you can call setCustodian.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Returns: Promise‹‹void››

â–¸ toJson():

Inherited from .

Overrides .

Defined in

Returns:

Inherited from .

Defined in

Inherited from .

Defined in

src/api/entities/Portfolio/index.ts:75
Context
src/api/entities/Entity.ts:48
Identity
src/api/entities/Portfolio/index.ts:70
src/api/entities/Entity.ts:46
src/api/entities/DefaultPortfolio.ts:23
Identity
src/api/entities/Portfolio/index.ts:257
Identity
PortfolioBalance
src/api/entities/Portfolio/index.ts:139
PortfolioBalance
ResultSet
HistoricSettlement
src/api/entities/Portfolio/index.ts:302
ResultSet
HistoricSettlement
src/api/entities/Portfolio/index.ts:123
Entity
src/api/entities/Entity.ts:61
src/api/entities/Portfolio/index.ts:107
MoveFundsParams
ProcedureOpts
TransactionQueue
src/api/entities/Portfolio/index.ts:235
ProcedureMethod
TransactionQueue
ProcedureOpts
TransactionQueue
src/api/entities/Portfolio/index.ts:248
ProcedureMethod
TransactionQueue
SetCustodianParams
ProcedureOpts
TransactionQueue
src/api/entities/Portfolio/index.ts:222
ProcedureMethod
TransactionQueue
HumanReadable
src/api/entities/Portfolio/index.ts:385
HumanReadable
src/api/entities/Entity.ts:14
src/api/entities/Entity.ts:23
Portfolio
_id
context
owner
uuid
exists
getCustodian
getTokenBalances
getTransactionHistory
isCustodiedBy
isEqual
isOwnedBy
moveFunds
quitCustody
setCustodian
toJson
generateUuid
unserialize
Entity
MoveFundsParams
ProcedureOpts
ProcedureOpts
SetCustodianParams
ProcedureOpts
Portfolio
Entity
Portfolio
Entity
Entity
Portfolio
Portfolio
Portfolio
Portfolio
Entity
Portfolio
Portfolio
Portfolio
Portfolio
Portfolio
Entity
Entity
Entity
context
uuid
exists
isEqual
toJson
generateUuid
unserialize
_id
owner
getCustodian
getTokenBalances
getTransactionHistory
isCustodiedBy
isOwnedBy
moveFunds
quitCustody
setCustodian
toJson