-
Notifications
You must be signed in to change notification settings - Fork 12
api.entities.types
@polymeshassociation/polymesh-sdk / api/entities/types
Defined in: api/entities/types.ts:131
Type of Authorization Request
AddMultiSigSigner:
"AddMultiSigSigner"
Defined in: api/entities/types.ts:135
AttestPrimaryKeyRotation:
"AttestPrimaryKeyRotation"
Defined in: api/entities/types.ts:132
BecomeAgent:
"BecomeAgent"
Defined in: api/entities/types.ts:139
JoinIdentity:
"JoinIdentity"
Defined in: api/entities/types.ts:137
OldAddRelayerPayingKey:
"OldAddRelayerPayingKey"
Defined in: api/entities/types.ts:140
PortfolioCustody:
"PortfolioCustody"
Defined in: api/entities/types.ts:138
RotatePrimaryKey:
"RotatePrimaryKey"
Defined in: api/entities/types.ts:133
RotatePrimaryKeyToSecondary:
"RotatePrimaryKeyToSecondary"
Defined in: api/entities/types.ts:141
TransferAssetOwnership:
"TransferAssetOwnership"
Defined in: api/entities/types.ts:136
TransferTicker:
"TransferTicker"
Defined in: api/entities/types.ts:134
Defined in: api/entities/types.ts:162
Accredited:
"Accredited"
Defined in: api/entities/types.ts:163
Affiliate:
"Affiliate"
Defined in: api/entities/types.ts:164
Blocked:
"Blocked"
Defined in: api/entities/types.ts:171
BuyLockup:
"BuyLockup"
Defined in: api/entities/types.ts:165
Custom:
"Custom"
Defined in: api/entities/types.ts:172
CustomerDueDiligence:
"CustomerDueDiligence"
Defined in: api/entities/types.ts:167
Exempted:
"Exempted"
Defined in: api/entities/types.ts:170
Jurisdiction:
"Jurisdiction"
Defined in: api/entities/types.ts:169
KnowYourCustomer:
"KnowYourCustomer"
Defined in: api/entities/types.ts:168
SellLockup:
"SellLockup"
Defined in: api/entities/types.ts:166
Defined in: api/entities/types.ts:144
Both:
"Both"
Defined in: api/entities/types.ts:147
Receiver:
"Receiver"
Defined in: api/entities/types.ts:146
Sender:
"Sender"
Defined in: api/entities/types.ts:145
Defined in: api/entities/types.ts:341
IsAbsent:
"IsAbsent"
Defined in: api/entities/types.ts:343
IsAnyOf:
"IsAnyOf"
Defined in: api/entities/types.ts:344
IsExternalAgent:
"IsExternalAgent"
Defined in: api/entities/types.ts:346
IsIdentity:
"IsIdentity"
Defined in: api/entities/types.ts:347
IsNoneOf:
"IsNoneOf"
Defined in: api/entities/types.ts:345
IsPresent:
"IsPresent"
Defined in: api/entities/types.ts:342
Defined in: api/entities/types.ts:302
Balance:
"Balance"
Defined in: api/entities/types.ts:304
Count:
"Count"
Defined in: api/entities/types.ts:303
Defined in: api/entities/types.ts:761
ExceptMeta:
"ExceptMeta"
Defined in: api/entities/types.ts:770
not authorized:
- externalAgents
Full:
"Full"
Defined in: api/entities/types.ts:765
all transactions authorized
PolymeshV1Caa:
"PolymeshV1Caa"
Defined in: api/entities/types.ts:777
authorized:
- corporateAction
- corporateBallot
- capitalDistribution
PolymeshV1Pia:
"PolymeshV1Pia"
Defined in: api/entities/types.ts:785
authorized:
- asset.issue
- asset.redeem
- asset.controllerTransfer
- sto (except for sto.invest)
Defined in: api/entities/types.ts:632
Exclude:
"Exclude"
Defined in: api/entities/types.ts:634
Include:
"Include"
Defined in: api/entities/types.ts:633
Defined in: api/entities/types.ts:150
Asset:
"Asset"
Defined in: api/entities/types.ts:153
Custom:
"Custom"
Defined in: api/entities/types.ts:154
Identity:
"Identity"
Defined in: api/entities/types.ts:152
Defined in: api/entities/types.ts:110
Account:
"Account"
Defined in: api/entities/types.ts:113
Identity:
"Identity"
Defined in: api/entities/types.ts:112
Defined in: api/entities/types.ts:289
Represents the StatType from the statistics module.
the chain doesn't use "Scoped" types, but they are needed here to discriminate the input instead of having an optional input
Balance:
"Balance"
Defined in: api/entities/types.ts:291
Count:
"Count"
Defined in: api/entities/types.ts:290
ScopedBalance:
"ScopedBalance"
Defined in: api/entities/types.ts:299
ScopedPercentage is an SDK only type, on chain it is Balance with a claimType option present
ScopedCount:
"ScopedCount"
Defined in: api/entities/types.ts:295
ScopedCount is an SDK only type, on chain it is Count with a claimType option present
Defined in: api/entities/types.ts:175
scope:
Scope
Defined in: api/entities/types.ts:177
type:
Accredited
Defined in: api/entities/types.ts:176
Defined in: api/entities/types.ts:555
optionalcount?:BigNumber
Defined in: api/entities/types.ts:562
The token holder count value for the stat
If not provided when enabling a stat, it will default to zero. If not provided when updating stats, the current value will remain unchanged
Defined in: api/entities/types.ts:180
scope:
Scope
Defined in: api/entities/types.ts:182
type:
Affiliate
Defined in: api/entities/types.ts:181
Defined in: api/entities/types.ts:224
scope:
Scope
Defined in: api/entities/types.ts:226
type:
Blocked
Defined in: api/entities/types.ts:225
Defined in: api/entities/types.ts:185
scope:
Scope
Defined in: api/entities/types.ts:187
type:
BuyLockup
Defined in: api/entities/types.ts:186
Defined in: api/entities/types.ts:195
id:
string
Defined in: api/entities/types.ts:197
type:
CustomerDueDiligence
Defined in: api/entities/types.ts:196
Defined in: api/entities/types.ts:746
Result of a checkPermissions call. If Type is Account, represents whether the Account
has all the necessary secondary key Permissions. If Type is Identity, represents whether the
Identity has all the necessary external agent Permissions
| Type Parameter |
|---|
Type extends SignerType
|
optionalmessage?:string
Defined in: api/entities/types.ts:758
optional message explaining the reason for failure in special cases
optionalmissingPermissions?:TypeextendsAccount?SimplePermissions:TxTag[] |null
Defined in: api/entities/types.ts:750
required permissions which the signer DOESN'T have. Only present if result is false
result:
boolean
Defined in: api/entities/types.ts:754
whether the signer complies with the required permissions or not
Defined in: api/entities/types.ts:795
checkpoint:
Checkpoint
Defined in: api/entities/types.ts:796
createdAt:
Date
Defined in: api/entities/types.ts:797
totalSupply:
BigNumber
Defined in: api/entities/types.ts:798
Defined in: api/entities/types.ts:726
Result of a checkRoles call
optionalmessage?:string
Defined in: api/entities/types.ts:738
optional message explaining the reason for failure in special cases
optionalmissingRoles?:Role[]
Defined in: api/entities/types.ts:730
required roles which the Identity DOESN'T have. Only present if result is false
result:
boolean
Defined in: api/entities/types.ts:734
whether the signer possesses all the required roles or not
Defined in: api/entities/types.ts:522
TransferRestrictionBase
claim:
InputStatClaim
Defined in: api/entities/types.ts:526
The type of investors this restriction applies to. e.g. non-accredited
optionalexemptedIds?:string[]
Defined in: api/entities/types.ts:509
array of Identity IDs that are exempted from the Restriction
TransferRestrictionBase.exemptedIds
issuer:
Identity
Defined in: api/entities/types.ts:536
optionalmax?:BigNumber
Defined in: api/entities/types.ts:534
The maximum amount of investors that must meet the Claim criteria
min:
BigNumber
Defined in: api/entities/types.ts:530
The minimum amount of investors the must meet the Claim criteria
Defined in: api/entities/types.ts:244
| Type Parameter | Default type |
|---|---|
ClaimType |
Claim |
claim:
ClaimType
Defined in: api/entities/types.ts:250
expiry:
Date|null
Defined in: api/entities/types.ts:249
issuedAt:
Date
Defined in: api/entities/types.ts:247
issuer:
Identity
Defined in: api/entities/types.ts:246
lastUpdatedAt:
Date
Defined in: api/entities/types.ts:248
target:
Identity
Defined in: api/entities/types.ts:245
Defined in: api/entities/types.ts:538
TransferRestrictionBase
claim:
InputStatClaim
Defined in: api/entities/types.ts:542
The type of investors this restriction applies to. e.g. Canadian investor
optionalexemptedIds?:string[]
Defined in: api/entities/types.ts:509
array of Identity IDs that are exempted from the Restriction
TransferRestrictionBase.exemptedIds
issuer:
Identity
Defined in: api/entities/types.ts:552
max:
BigNumber
Defined in: api/entities/types.ts:550
The maximum percentage of the total supply that investors meeting the Claim criteria must hold
min:
BigNumber
Defined in: api/entities/types.ts:546
The minimum percentage of the total supply that investors meeting the Claim criteria must hold
Defined in: api/entities/types.ts:311
optionalassetId?:string
Defined in: api/entities/types.ts:313
scope:
Scope|null
Defined in: api/entities/types.ts:312
Defined in: api/entities/types.ts:439
claim:
Claim
Defined in: api/entities/types.ts:441
optionalexpiry?:Date
Defined in: api/entities/types.ts:442
target:
string|Identity
Defined in: api/entities/types.ts:440
Defined in: api/entities/types.ts:434
complies:
boolean
Defined in: api/entities/types.ts:436
requirements:
RequirementCompliance[]
Defined in: api/entities/types.ts:435
Defined in: api/entities/types.ts:413
defaultTrustedClaimIssuers:
TrustedClaimIssuer<false>[]
Defined in: api/entities/types.ts:418
used for conditions where no trusted claim issuers were specified
requirements:
Requirement[]
Defined in: api/entities/types.ts:414
Defined in: api/entities/types.ts:350
target:
ConditionTarget
Defined in: api/entities/types.ts:351
optionaltrustedClaimIssuers?:TrustedClaimIssuer<false>[]
Defined in: api/entities/types.ts:355
if undefined, the default trusted claim issuers for the Asset are used
Defined in: api/entities/types.ts:423
complies:
boolean
Defined in: api/entities/types.ts:425
condition:
Condition
Defined in: api/entities/types.ts:424
Defined in: api/entities/types.ts:615
ballot:
CorporateBallot
Defined in: api/entities/types.ts:616
details:
CorporateBallotDetails
Defined in: api/entities/types.ts:617
Defined in: api/entities/types.ts:512
TransferRestrictionBase
count:
BigNumber
Defined in: api/entities/types.ts:513
optionalexemptedIds?:string[]
Defined in: api/entities/types.ts:509
array of Identity IDs that are exempted from the Restriction
TransferRestrictionBase.exemptedIds
Defined in: api/entities/types.ts:216
customClaimTypeId:
BigNumber
Defined in: api/entities/types.ts:219
scope:
Scope
Defined in: api/entities/types.ts:218
type:
Custom
Defined in: api/entities/types.ts:217
Defined in: api/entities/types.ts:620
amount:
BigNumber
Defined in: api/entities/types.ts:625
blockHash:
string
Defined in: api/entities/types.ts:622
blockNumber:
BigNumber
Defined in: api/entities/types.ts:621
date:
Date
Defined in: api/entities/types.ts:623
target:
Identity
Defined in: api/entities/types.ts:624
withheldTax:
BigNumber
Defined in: api/entities/types.ts:629
percentage (0-100) of tax withholding for the target identity
Defined in: api/entities/types.ts:610
details:
DividendDistributionDetails
Defined in: api/entities/types.ts:612
distribution:
DividendDistribution
Defined in: api/entities/types.ts:611
Defined in: api/entities/types.ts:211
scope:
Scope
Defined in: api/entities/types.ts:213
type:
Exempted
Defined in: api/entities/types.ts:212
Defined in: api/entities/types.ts:383
type:
IsExternalAgent
Defined in: api/entities/types.ts:384
Defined in: api/entities/types.ts:852
amount:
BigNumber
Defined in: api/entities/types.ts:854
asset:
string|FungibleAsset
Defined in: api/entities/types.ts:853
optionalmemo?:string
Defined in: api/entities/types.ts:858
identifier string to help differentiate transfers
Defined in: api/entities/types.ts:378
identity:
Identity
Defined in: api/entities/types.ts:380
type:
IsIdentity
Defined in: api/entities/types.ts:379
Defined in: api/entities/types.ts:306
Defined in: api/entities/types.ts:308
identity:
Identity
Defined in: api/entities/types.ts:307
Defined in: api/entities/types.ts:205
code:
CountryCode
Defined in: api/entities/types.ts:207
scope:
Scope
Defined in: api/entities/types.ts:208
type:
Jurisdiction
Defined in: api/entities/types.ts:206
Defined in: api/entities/types.ts:200
scope:
Scope
Defined in: api/entities/types.ts:202
type:
KnowYourCustomer
Defined in: api/entities/types.ts:201
Defined in: api/entities/types.ts:94
size:
BigNumber
Defined in: api/entities/types.ts:95
optionalstart?:BigNumber
Defined in: api/entities/types.ts:96
Defined in: api/entities/types.ts:373
claims:
Claim[]
Defined in: api/entities/types.ts:375
Defined in: api/entities/types.ts:374
Defined in: api/entities/types.ts:790
details:
OfferingDetails
Defined in: api/entities/types.ts:792
offering:
Offering
Defined in: api/entities/types.ts:791
Defined in: api/entities/types.ts:89
size:
BigNumber
Defined in: api/entities/types.ts:90
optionalstart?:string
Defined in: api/entities/types.ts:91
Defined in: api/entities/types.ts:516
TransferRestrictionBase
optionalexemptedIds?:string[]
Defined in: api/entities/types.ts:509
array of Identity IDs that are exempted from the Restriction
TransferRestrictionBase.exemptedIds
percentage:
BigNumber
Defined in: api/entities/types.ts:520
maximum percentage (0-100) of the total supply of the Asset that can be held by a single investor at once
Defined in: api/entities/types.ts:801
Defined in: api/entities/types.ts:802
permissions:
Permissions
Defined in: api/entities/types.ts:803
optionalunmatchedPermissions?:string[]
Defined in: api/entities/types.ts:804
Defined in: api/entities/types.ts:700
All Permission Groups of a specific Asset, separated by known and custom
custom:
CustomPermissionGroup[]
Defined in: api/entities/types.ts:702
known:
KnownPermissionGroup[]
Defined in: api/entities/types.ts:701
Defined in: api/entities/types.ts:671
Permissions a Secondary Key has over the Identity. A null value means the key has
all permissions of that type (e.g. if assets is null, the key has permissions over all
of the Identity's Assets)
assets:
SectionPermissions<FungibleAsset> |null
Defined in: api/entities/types.ts:675
Assets over which this key has permissions
portfolios:
SectionPermissions<DefaultPortfolio|NumberedPortfolio> |null
Defined in: api/entities/types.ts:689
transactionGroups:
TxGroup[]
Defined in: api/entities/types.ts:687
list of Transaction Groups this key can execute. Having permissions over a TxGroup
means having permissions over every TxTag in said group. Partial group permissions are not
covered by this value. For a full picture of transaction permissions, see the transactions property
NOTE: If transactions is null, ignore this value
transactions:
TransactionPermissions|null
Defined in: api/entities/types.ts:679
Transactions this key can execute
Defined in: api/entities/types.ts:408
conditions:
Condition[]
Defined in: api/entities/types.ts:410
id:
BigNumber
Defined in: api/entities/types.ts:409
Defined in: api/entities/types.ts:428
complies:
boolean
Defined in: api/entities/types.ts:431
conditions:
ConditionCompliance[]
Defined in: api/entities/types.ts:430
id:
BigNumber
Defined in: api/entities/types.ts:429
Defined in: api/entities/types.ts:101
| Type Parameter |
|---|
T |
optionalcount?:BigNumber
Defined in: api/entities/types.ts:107
methods will have count defined when middleware is configured, but be undefined otherwise. This happens when the chain node is queried directly
data:
T[]
Defined in: api/entities/types.ts:102
next:
NextKey
Defined in: api/entities/types.ts:103
Defined in: api/entities/types.ts:605
details:
ScheduleDetails
Defined in: api/entities/types.ts:607
schedule:
CheckpointSchedule
Defined in: api/entities/types.ts:606
Defined in: api/entities/types.ts:157
type:
ScopeType
Defined in: api/entities/types.ts:158
value:
string
Defined in: api/entities/types.ts:159
Defined in: api/entities/types.ts:642
Signer/agent permissions for a specific type
| Type Parameter | Description |
|---|---|
T |
type of Permissions (Asset, Transaction, Portfolio, etc) |
type:
PermissionType
Defined in: api/entities/types.ts:650
Whether the permissions are inclusive or exclusive
values:
T[]
Defined in: api/entities/types.ts:646
Values to be included/excluded
Defined in: api/entities/types.ts:190
scope:
Scope
Defined in: api/entities/types.ts:192
type:
SellLockup
Defined in: api/entities/types.ts:191
Defined in: api/entities/types.ts:117
type:
SignerType
Defined in: api/entities/types.ts:121
whether the signer is an Account or Identity
value:
string
Defined in: api/entities/types.ts:125
address or DID (depending on whether the signer is an Account or Identity)
Defined in: api/entities/types.ts:710
This represents positive permissions (i.e. only "includes"). It is used for specifying procedure requirements and querying if an Account has certain permissions. Null values represent full permissions in that category
optionalassets?:BaseAsset[] |null
Defined in: api/entities/types.ts:714
list of required Asset permissions
optionalportfolios?: (DefaultPortfolio|NumberedPortfolio)[] |null
Defined in: api/entities/types.ts:720
optionaltransactions?:TxTag[] |null
Defined in: api/entities/types.ts:718
list of required Transaction permissions
Defined in: api/entities/types.ts:368
claim:
Claim
Defined in: api/entities/types.ts:370
Defined in: api/entities/types.ts:369
Defined in: api/entities/types.ts:260
accredited:
boolean
Defined in: api/entities/types.ts:262
type:
Accredited
Defined in: api/entities/types.ts:261
Defined in: api/entities/types.ts:265
affiliate:
boolean
Defined in: api/entities/types.ts:267
type:
Affiliate
Defined in: api/entities/types.ts:266
Defined in: api/entities/types.ts:565
claimType:
TrustedFor
Defined in: api/entities/types.ts:567
issuer:
Identity
Defined in: api/entities/types.ts:566
Defined in: api/entities/types.ts:255
countryCode:
CountryCode|undefined
Defined in: api/entities/types.ts:257
type:
Jurisdiction
Defined in: api/entities/types.ts:256
Defined in: api/entities/types.ts:656
Permissions related to Transactions. Can include/exclude individual transactions or entire modules
-
SectionPermissions<TxTag|ModuleName>
optionalexceptions?:TxTag[]
Defined in: api/entities/types.ts:663
Transactions to be exempted from inclusion/exclusion. This allows more granularity when
setting permissions. For example, let's say we want to include only the asset and staking modules,
but exclude the asset.registerUniqueTicker transaction. We could add both modules to values, and add
TxTags.asset.RegisterUniqueTicker to exceptions
type:
PermissionType
Defined in: api/entities/types.ts:650
Whether the permissions are inclusive or exclusive
values: (
TxTag|ModuleName)[]
Defined in: api/entities/types.ts:646
Values to be included/excluded
Defined in: api/entities/types.ts:326
| Type Parameter | Default type | Description |
|---|---|---|
IsDefault extends boolean
|
false |
whether the Identity is a default trusted claim issuer for an asset or just for a specific compliance condition. Defaults to false |
identity:
IsDefaultextendstrue?DefaultTrustedClaimIssuer:Identity
Defined in: api/entities/types.ts:327
trustedFor:
TrustedFor[] |null
Defined in: api/entities/types.ts:331
a null value means that the issuer is trusted for all claim types
Account =
Account
Defined in: api/entities/types.ts:46
AccountCollection =
PortfolioCollection
Defined in: api/entities/types.ts:822
AccountLike =
string|Account
Defined in: api/entities/types.ts:814
ActiveStats =
object
Defined in: api/entities/types.ts:872
claims:
object[] |undefined
Defined in: api/entities/types.ts:874
isSet:
boolean
Defined in: api/entities/types.ts:873
AssetHolder =
Account|NumberedPortfolio|DefaultPortfolio
Defined in: api/entities/types.ts:818
AssetHolderBalance =
PortfolioBalance
Defined in: api/entities/types.ts:820
AssetHolderLike =
AccountLike|PortfolioLike
Defined in: api/entities/types.ts:816
AttestPrimaryKeyRotationAuthorizationData =
object
Defined in: api/entities/types.ts:445
type:
AttestPrimaryKeyRotation
Defined in: api/entities/types.ts:446
value:
Identity
Defined in: api/entities/types.ts:447
Authorization =
AttestPrimaryKeyRotationAuthorizationData|RotatePrimaryKeyAuthorizationData|JoinIdentityAuthorizationData|PortfolioCustodyAuthorizationData|BecomeAgentAuthorizationData|OldAddRelayerPayingKeyAuthorizationData|RotatePrimaryKeyToSecondaryData|GenericAuthorizationData
Defined in: api/entities/types.ts:495
Authorization request data corresponding to type
AuthorizationRequest =
AuthorizationRequest
Defined in: api/entities/types.ts:49
BecomeAgentAuthorizationData =
object
Defined in: api/entities/types.ts:469
type:
BecomeAgent
Defined in: api/entities/types.ts:470
Defined in: api/entities/types.ts:471
Checkpoint =
Checkpoint
Defined in: api/entities/types.ts:50
CheckpointSchedule =
CheckpointSchedule
Defined in: api/entities/types.ts:51
Claim =
ScopedClaim|UnscopedClaim
Defined in: api/entities/types.ts:242
ClaimCountStatInput = {
claimType:Accredited;issuer:Identity;value?: {accredited:BigNumber;nonAccredited:BigNumber; }; } | {claimType:Affiliate;issuer:Identity;value?: {affiliate:BigNumber;nonAffiliate:BigNumber; }; } | {claimType:Jurisdiction;issuer:Identity;value?:object[]; }
Defined in: api/entities/types.ts:570
{ claimType: Accredited; issuer: Identity; value?: { accredited: BigNumber; nonAccredited: BigNumber; }; }
claimType:
Accredited
issuer:
Identity
optionalvalue?:object
The count values for token holders with the accredited and non-accredited claim
If not provided when enabling a stat, values will default to zero. If not provided when updating stats, the current values will remain unchanged
accredited:
BigNumber
nonAccredited:
BigNumber
{ claimType: Affiliate; issuer: Identity; value?: { affiliate: BigNumber; nonAffiliate: BigNumber; }; }
claimType:
Affiliate
issuer:
Identity
optionalvalue?:object
The count values for token holders with the affiliate and non-affiliate claim
If not provided when enabling a stat, values will default to zero. If not provided when updating stats, the current values will remain unchanged
affiliate:
BigNumber
nonAffiliate:
BigNumber
{ claimType: Jurisdiction; issuer: Identity; value?: object[]; }
claimType:
Jurisdiction
issuer:
Identity
optionalvalue?:object[]
The count values for token holders per jurisdiction claim
If not provided when enabling a stat, values will default to zero. If not provided when updating stats, the current values will remain unchanged
ClaimTypeInput =
TrustedFor
Defined in: api/entities/types.ts:320
Condition =
SingleClaimCondition|MultiClaimCondition|IdentityCondition|ExternalAgentCondition&ConditionBase
Defined in: api/entities/types.ts:387
CorporateAction =
CorporateAction
Defined in: api/entities/types.ts:52
CustomClaimWithoutScope =
Omit<CustomClaim,"scope"> &object
Defined in: api/entities/types.ts:222
scope:
undefined
CustomClaimWithTypeId =
object
Defined in: api/entities/types.ts:316
customClaimTypeId:
BigNumber
Defined in: api/entities/types.ts:316
type:
Custom
Defined in: api/entities/types.ts:316
CustomPermissionGroup =
CustomPermissionGroup
Defined in: api/entities/types.ts:53
DefaultPortfolio =
DefaultPortfolio
Defined in: api/entities/types.ts:54
DefaultTrustedClaimIssuer =
DefaultTrustedClaimIssuer
Defined in: api/entities/types.ts:55
DividendDistribution =
DividendDistribution
Defined in: api/entities/types.ts:56
FungibleAsset =
FungibleAsset
Defined in: api/entities/types.ts:61
GenericAuthorizationData =
object
Defined in: api/entities/types.ts:479
type:
Exclude<AuthorizationType,RotatePrimaryKey|JoinIdentity|PortfolioCustody|BecomeAgent|OldAddRelayerPayingKey|RotatePrimaryKeyToSecondary|AttestPrimaryKeyRotation>
Defined in: api/entities/types.ts:480
value:
string
Defined in: api/entities/types.ts:490
GroupPermissions =
Pick<Permissions,"transactions"|"transactionGroups">
Defined in: api/entities/types.ts:695
Asset permissions shared by agents in a group
Identity =
Identity
Defined in: api/entities/types.ts:57
InputCondition =
SingleClaimCondition|MultiClaimCondition|Modify<IdentityCondition, {identity:string|Identity; }> |ExternalAgentCondition&InputConditionBase
Defined in: api/entities/types.ts:395
InputConditionBase =
Modify<ConditionBase, {trustedClaimIssuers?:InputTrustedClaimIssuer[]; }>
Defined in: api/entities/types.ts:358
InputRequirement =
Modify<Requirement, {conditions:InputCondition[]; }>
Defined in: api/entities/types.ts:421
InputStatClaim =
StatJurisdictionClaimInput|StatAccreditedClaimInput|StatAffiliateClaimInput
Defined in: api/entities/types.ts:270
InputStatType = {
type:Count|Balance; } | {claimIssuer:StatClaimIssuer;type:ScopedCount|ScopedBalance; }
Defined in: api/entities/types.ts:275
InputTrustedClaimIssuer =
Modify<TrustedClaimIssuer, {identity:string|Identity; }>
Defined in: api/entities/types.ts:334
Instruction =
Instruction
Defined in: api/entities/types.ts:58
JoinIdentityAuthorizationData =
object
Defined in: api/entities/types.ts:459
type:
JoinIdentity
Defined in: api/entities/types.ts:460
value:
Permissions
Defined in: api/entities/types.ts:461
KnownPermissionGroup =
KnownPermissionGroup
Defined in: api/entities/types.ts:59
MetadataEntry =
MetadataEntry
Defined in: api/entities/types.ts:64
MultiSig =
MultiSig
Defined in: api/entities/types.ts:47
MultiSigProposal =
MultiSigProposal
Defined in: api/entities/types.ts:48
NextKey =
string|BigNumber|null
Defined in: api/entities/types.ts:99
Nft =
Nft
Defined in: api/entities/types.ts:62
NftCollection =
NftCollection
Defined in: api/entities/types.ts:63
NonFungiblePortfolioMovement =
object
Defined in: api/entities/types.ts:861
asset:
NftCollection|string
Defined in: api/entities/types.ts:862
optionalmemo?:string
Defined in: api/entities/types.ts:867
identifier string to help differentiate transfers
nfts: (
Nft|BigNumber)[]
Defined in: api/entities/types.ts:863
NumberedPortfolio =
NumberedPortfolio
Defined in: api/entities/types.ts:60
Offering =
Offering
Defined in: api/entities/types.ts:65
OldAddRelayerPayingKeyAuthorizationData =
object
Defined in: api/entities/types.ts:474
type:
OldAddRelayerPayingKey
Defined in: api/entities/types.ts:475
value:
SubsidyData
Defined in: api/entities/types.ts:476
PermissionsLike =
object& {transactions?:TransactionPermissions|null; } | {transactionGroups?:TxGroup[]; }
Defined in: api/entities/types.ts:831
Permissions to grant to a Signer over an Identity
optionalassets?:SectionPermissions<string|FungibleAsset> |null
Assets on which to grant permissions. A null value represents full permissions
optionalportfolios?:SectionPermissions<PortfolioLike> |null
Portfolios on which to grant permissions. A null value represents full permissions
TxGroups in the transactionGroups array will be transformed into their corresponding TxTags
PortfolioCustodyAuthorizationData =
object
Defined in: api/entities/types.ts:464
type:
PortfolioCustody
Defined in: api/entities/types.ts:465
value:
NumberedPortfolio|DefaultPortfolio
Defined in: api/entities/types.ts:466
PortfolioLike =
string|Identity|NumberedPortfolio|DefaultPortfolio| {id:BigNumber;identity:string|Identity; }
Defined in: api/entities/types.ts:807
PortfolioMovement =
FungiblePortfolioMovement|NonFungiblePortfolioMovement
Defined in: api/entities/types.ts:870
RotatePrimaryKeyAuthorizationData =
object
Defined in: api/entities/types.ts:450
type:
RotatePrimaryKey
Defined in: api/entities/types.ts:451
RotatePrimaryKeyToSecondaryData =
object
Defined in: api/entities/types.ts:454
Defined in: api/entities/types.ts:455
value:
Permissions
Defined in: api/entities/types.ts:456
ScopedClaim =
JurisdictionClaim|AccreditedClaim|AffiliateClaim|BuyLockupClaim|SellLockupClaim|KycClaim|ExemptedClaim|BlockedClaim|CustomClaim
Defined in: api/entities/types.ts:229
Defined in: api/entities/types.ts:788
StatClaimType =
Accredited|Affiliate|Jurisdiction
Defined in: api/entities/types.ts:253
SubCallback<
T> = (result) =>void|Promise<void>
Defined in: api/entities/types.ts:85
| Type Parameter |
|---|
T |
| Parameter | Type |
|---|---|
result |
T |
void | Promise<void>
Subsidy =
Subsidy
Defined in: api/entities/types.ts:68
TickerReservation =
TickerReservation
Defined in: api/entities/types.ts:66
TrustedFor =
Exclude<ClaimType,Custom> |CustomClaimWithTypeId
Defined in: api/entities/types.ts:318
UnscopedClaim =
CddClaim|CustomClaimWithoutScope
Defined in: api/entities/types.ts:240
UnsubCallback = () =>
void
Defined in: api/entities/types.ts:87
void
Venue =
Venue
Defined in: api/entities/types.ts:67
Re-exports AccountBalance
Re-exports AccountIdentityRelation
Re-exports AccountKeyType
Re-exports AccountTypeInfo
Re-exports ActiveEraInfo
Re-exports ActiveTransferRestrictions
Re-exports AffirmationStatus
Re-exports AgentWithGroup
Re-exports AnyJson
Re-exports Asset
Re-exports AssetDetails
Re-exports AssetDocument
Re-exports AssetDocumentWithId
Re-exports AssetStat
Re-exports AssetWithGroup
Re-exports Balance
Re-exports BaseHistoricAssetTransaction
Re-exports CaCheckpointType
Re-exports CheckpointScheduleParams
Re-exports ClaimStatValue
Re-exports ClaimValue
Re-exports CollectionKey
Re-exports CorporateActionDefaultConfig
Re-exports CorporateActionKind
Renames and re-exports Params
Re-exports CorporateActionTargets
Re-exports DistributionParticipant
Re-exports DividendDistributionDetails
Re-exports DividendDistributionParams
Re-exports FungibleLeg
Re-exports GlobalMetadataKey
Re-exports GroupedInstructions
Re-exports GroupedInvolvedInstructions
Re-exports HeldNfts
Re-exports HistoricAgentOperation
Re-exports HistoricalMultiSigProposal
Re-exports HistoricAssetTransaction
Re-exports HistoricInstruction
Re-exports HistoricNftTransaction
Re-exports HistoricPolyxTransaction
Re-exports HistoricSettlement
Re-exports IdentityBalance
Re-exports IdentityHeldNfts
Re-exports InputCaCheckpoint
Re-exports InputTargets
Re-exports InputTaxWithholding
Re-exports InstructionAffirmation
Re-exports InstructionDetails
Re-exports InstructionEndCondition
Re-exports InstructionLockedInfo
Re-exports InstructionRelockStatus
Re-exports InstructionsByStatus
Re-exports InstructionStatus
Re-exports InstructionStatusResult
Re-exports InstructionType
Re-exports Investment
Re-exports JurisdictionValue
Re-exports KnownAssetType
Re-exports KnownNftType
Re-exports Leg
Re-exports LegStatus
Re-exports LegStatusType
Re-exports MediatorAffirmation
Re-exports MetadataDetails
Re-exports MetadataKeyId
Re-exports MetadataLockStatus
Re-exports MetadataSpec
Re-exports MetadataType
Re-exports MetadataValue
Re-exports MetadataValueDetails
Re-exports MetadataWithValue
Re-exports MultiSigDetails
Re-exports MultiSigProposalAction
Re-exports MultiSigProposalDetails
Re-exports MultiSigProposalVote
Re-exports MultiSigSigners
Re-exports NextCheckpoints
Re-exports NftLeg
Re-exports NftMetadata
Re-exports NftOwnerStatus
Re-exports OffChainAffirmation
Re-exports OffChainFundingDetails
Re-exports OffChainFundingReceipt
Re-exports OffChainLeg
Re-exports OfferingBalanceStatus
Re-exports OfferingDetails
Re-exports OfferingSaleStatus
Re-exports OfferingStatus
Re-exports OfferingTier
Re-exports OfferingTimingStatus
Re-exports PortfolioBalance
Re-exports PortfolioCollection
Re-exports ProposalStatus
Re-exports ReceiverAffirmationRequirement
Re-exports ScheduleDetails
Re-exports ScheduleNextCheckpoint
Re-exports SecurityIdentifier
Re-exports SecurityIdentifierType
Re-exports SettlementLeg
Re-exports StakingCommission
Re-exports StakingLedger
Re-exports StakingNomination
Re-exports StakingPayee
Re-exports StakingUnlockingEntry
Re-exports SubsidyData
Re-exports SubsidyWithAllowance
Re-exports TargetTreatment
Re-exports TaxWithholding
Re-exports TickerRegistrationConfig
Re-exports TickerReservationDetails
Re-exports TickerReservationStatus
Re-exports Tier
Re-exports TransferBreakdown
Re-exports TransferError
Re-exports TransferExemptKey
Re-exports TransferRestrictionExemption
Re-exports TransferRestrictionResult
Re-exports TransferRestrictionStatValues
Re-exports UniqueIdentifiers
Re-exports VenueDetails
Re-exports VenueFilteringDetails
Re-exports VenueType