Globals
Index
Enumerations
Classes
Interfaces
Type aliases
Variables
Functions
Object literals
Type aliases
AccountBalance
Ƭ AccountBalance: Balance
Defined in src/types/index.ts:665
AddCountTransferRestrictionParams
Ƭ AddCountTransferRestrictionParams: CountTransferRestrictionInput & object
Defined in src/api/procedures/addTransferRestriction.ts:21
AddPercentageTransferRestrictionParams
Ƭ AddPercentageTransferRestrictionParams: PercentageTransferRestrictionInput & object
Defined in src/api/procedures/addTransferRestriction.ts:25
AddRelayerPayingKeyAuthorizationData
Ƭ AddRelayerPayingKeyAuthorizationData: object
Defined in src/types/index.ts:1045
Type declaration:
type: AddRelayerPayingKey
value: SubsidyData
AddRestrictionParams
Ƭ AddRestrictionParams: Omit‹T extends Count ? AddCountTransferRestrictionParams : AddPercentageTransferRestrictionParams, "type"›
Defined in src/api/entities/Asset/TransferRestrictions/TransferRestrictionBase.ts:35
ArgsType
Ƭ ArgsType: T extends function ? A : never
Defined in src/types/utils/index.ts:20
Less strict version of Parameters
Authorization
Ƭ Authorization: RotatePrimaryKeyAuthorizationData | JoinIdentityAuthorizationData | PortfolioCustodyAuthorizationData | BecomeAgentAuthorizationData | AddRelayerPayingKeyAuthorizationData | RotatePrimaryKeyToSecondaryData | GenericAuthorizationData
Defined in src/types/index.ts:1065
Authorization request data corresponding to type
BecomeAgentAuthorizationData
Ƭ BecomeAgentAuthorizationData: object
Defined in src/types/index.ts:1040
Type declaration:
type: BecomeAgent
CheckpointScheduleParams
Ƭ CheckpointScheduleParams: Omit‹UniqueIdentifiers & Params, "ticker"›
Defined in src/api/entities/CheckpointSchedule/types.ts:10
Claim
Ƭ Claim: ScopedClaim | UnscopedClaim
Defined in src/types/index.ts:299
Condition
Ƭ Condition: SingleClaimCondition | MultiClaimCondition | IdentityCondition | ExternalAgentCondition & ConditionBase
Defined in src/types/index.ts:403
ConfigureDividendDistributionParams
Ƭ ConfigureDividendDistributionParams: Omit‹InitiateCorporateActionParams, "kind" | "checkpoint"› & object
Defined in src/api/procedures/configureDividendDistribution.ts:61
Ensured
Ƭ Ensured: Required‹Pick‹T, K››
Defined in src/types/utils/index.ts:65
Pick a single property from T and ensure it is defined
GenericAuthorizationData
Ƭ GenericAuthorizationData: object
Defined in src/types/index.ts:1050
Type declaration:
value: string
GetReturnType
Ƭ GetReturnType: ActiveTransferRestrictions‹T extends Count ? CountTransferRestriction : PercentageTransferRestriction›
Defined in src/api/entities/Asset/TransferRestrictions/TransferRestrictionBase.ts:49
GroupPermissions
Ƭ GroupPermissions: Pick‹Permissions, "transactions" | "transactionGroups"›
Defined in src/types/index.ts:928
Asset permissions shared by agents in a group
HumanReadableType
Ƭ HumanReadableType: T extends Entity‹unknown, infer H› ? HumanReadableType‹H› : T extends BigNumber ? string : T extends Date ? string : T extends object ? object : T
Defined in src/types/utils/index.ts:26
Recursively traverse a type and transform its Entity properties into their human readable version (as if .toJson had been called on all of them)
InputCaCheckpoint
Ƭ InputCaCheckpoint: Checkpoint | CheckpointSchedule | Date | object | object
Defined in src/api/entities/Asset/Checkpoints/types.ts:10
InputCondition
Ƭ InputCondition: SingleClaimCondition | MultiClaimCondition | Modify‹IdentityCondition, object› | ExternalAgentCondition & InputConditionBase
Defined in src/types/index.ts:411
InputConditionBase
Ƭ InputConditionBase: Modify‹ConditionBase, object›
Defined in src/types/index.ts:374
InputRequirement
Ƭ InputRequirement: Modify‹Requirement, object›
Defined in src/types/index.ts:437
InputTargets
Ƭ InputTargets: Modify‹CorporateActionTargets, object›
Defined in src/api/entities/CorporateActionBase/types.ts:21
InputTaxWithholding
Ƭ InputTaxWithholding: Modify‹TaxWithholding, object›
Defined in src/api/entities/CorporateActionBase/types.ts:28
InputTrustedClaimIssuer
Ƭ InputTrustedClaimIssuer: Modify‹TrustedClaimIssuer, object›
Defined in src/types/index.ts:350
InstructionDetails
Ƭ InstructionDetails: object & object | object
Defined in src/api/entities/Instruction/types.ts:17
InstructionStatusResult
Ƭ InstructionStatusResult: object | object
Defined in src/api/entities/Instruction/types.ts:57
JoinIdentityAuthorizationData
Ƭ JoinIdentityAuthorizationData: object
Defined in src/types/index.ts:1030
Type declaration:
type: JoinIdentity
value: Permissions
MapTxAndArgsArray
Ƭ MapTxAndArgsArray: object
Defined in src/utils/internal.ts:841
Type declaration:
Modify
Ƭ Modify: Omit‹T, keyof R› & R
Defined in src/types/utils/index.ts:55
Override T with the properties of R
ModifyAllowanceParams
Ƭ ModifyAllowanceParams: SetAllowanceParams | IncreaseAllowanceParams | DecreaseAllowanceParams & object
Defined in src/api/procedures/modifyAllowance.ts:32
ModifyAssetParams
Ƭ ModifyAssetParams: object | object | object | object
Defined in src/api/procedures/modifyAsset.ts:12
ModifyCaDefaultConfigParams
Ƭ ModifyCaDefaultConfigParams: object | object | object
Defined in src/api/procedures/modifyCaDefaultConfig.ts:23
ModifyClaimsParams
Ƭ ModifyClaimsParams: AddClaimsParams | EditClaimsParams | RevokeClaimsParams
Defined in src/api/procedures/modifyClaims.ts:50
ModifyComplianceRequirementParams
Ƭ ModifyComplianceRequirementParams: object
Defined in src/api/procedures/modifyComplianceRequirement.ts:11
Type declaration:
conditions: InputCondition[]
id: BigNumber
ModifyOfferingTimesParams
Ƭ ModifyOfferingTimesParams: object | object | object
Defined in src/api/procedures/modifyOfferingTimes.ts:63
ModifyVenueParams
Ƭ ModifyVenueParams: object | object | object
Defined in src/api/procedures/modifyVenue.ts:7
Mutable
Ƭ Mutable: object
Defined in src/types/utils/index.ts:7
Type declaration:
NextKey
Ƭ NextKey: string | BigNumber | null
Defined in src/types/index.ts:672
PermissionsLike
Ƭ PermissionsLike: object & object | object
Defined in src/types/index.ts:1163
Permissions to grant to a Signer over an Identity
note TxGroups in the transactionGroups array will be transformed into their corresponding TxTags
PortfolioCustodyAuthorizationData
Ƭ PortfolioCustodyAuthorizationData: object
Defined in src/types/index.ts:1035
Type declaration:
type: PortfolioCustody
value: NumberedPortfolio | DefaultPortfolio
PortfolioLike
Ƭ PortfolioLike: string | Identity | NumberedPortfolio | DefaultPortfolio | object
Defined in src/types/index.ts:1149
PrivateKey
Ƭ PrivateKey: object | object | object
Defined in src/types/index.ts:1385
URI|mnemonic|hex representation of a private key
ProcedureFunc
Ƭ ProcedureFunc: function
Defined in src/types/utils/index.ts:11
Type declaration:
▸ (): Procedure‹Args, ReturnValue, Storage›
QueryReturnType
Ƭ QueryReturnType: T extends AugmentedQuery‹"promise", infer Fun› ? ReturnType‹Fun› extends Observable‹infer R› ? R : never : never
Defined in src/types/utils/index.ts:46
Extract the return type of a polkadot.js query function
example QueryReturnType<typeof identity.authorizations> returns Option<Authorization>
Role
Ƭ Role: TickerOwnerRole | CddProviderRole | VenueOwnerRole | PortfolioCustodianRole | IdentityRole
Defined in src/types/index.ts:123
RotatePrimaryKeyAuthorizationData
Ƭ RotatePrimaryKeyAuthorizationData: object
Defined in src/types/index.ts:1021
Type declaration:
type: RotatePrimaryKey
RotatePrimaryKeyToSecondaryData
Ƭ RotatePrimaryKeyToSecondaryData: object
Defined in src/types/index.ts:1025
Type declaration:
value: Permissions
ScopedClaim
Ƭ ScopedClaim: JurisdictionClaim | InvestorUniquenessClaim | AccreditedClaim | AffiliateClaim | BuyLockupClaim | SellLockupClaim | KycClaim | ExemptedClaim | BlockedClaim
Defined in src/types/index.ts:286
SetRestrictionsParams
Ƭ SetRestrictionsParams: Omit‹T extends Count ? SetCountTransferRestrictionsParams : SetPercentageTransferRestrictionsParams, "type"›
Defined in src/api/entities/Asset/TransferRestrictions/TransferRestrictionBase.ts:42
SetTransferRestrictionsParams
Ƭ SetTransferRestrictionsParams: object & SetCountTransferRestrictionsParams | SetPercentageTransferRestrictionsParams
Defined in src/api/procedures/setTransferRestrictions.ts:42
Signer
Defined in src/types/index.ts:1131
SubCallback
Ƭ SubCallback: function
Defined in src/types/index.ts:634
Type declaration:
▸ (result: T): void | Promise‹void›
Parameters:
result
T
TransactionArgument
Ƭ TransactionArgument: object & PlainTransactionArgument | ArrayTransactionArgument | SimpleEnumTransactionArgument | ComplexTransactionArgument
Defined in src/types/index.ts:1120
UnionOfProcedureFuncs
Ƭ UnionOfProcedureFuncs: Args extends unknown ? ProcedureFunc‹Args, ReturnValue, Storage› : never
Defined in src/types/utils/index.ts:13
UnscopedClaim
Ƭ UnscopedClaim: NoDataClaim | CddClaim | InvestorUniquenessV2Claim
Defined in src/types/index.ts:297
UnsubCallback
Ƭ UnsubCallback: function
Defined in src/types/index.ts:636
Type declaration:
▸ (): void
WithRequired
Ƭ WithRequired: T & object
Defined in src/types/utils/index.ts:60
Ensure a specific property of T is defined
Variables
Const caNotExistsMessage
Const caNotExistsMessage• caNotExistsMessage: "The Corporate Action doesn't exist" = "The Corporate Action doesn't exist"
Defined in src/api/procedures/removeCorporateAction.ts:33
Const executedMessage
Const executedMessage• executedMessage: "Instruction has already been executed/rejected and it was purged from chain" = "Instruction has already been executed/rejected and it was purged from chain"
Defined in src/api/entities/Instruction/index.ts:57
Const notExistsMessage
Const notExistsMessage• notExistsMessage: "The Portfolio doesn't exist or was removed by its owner" = "The Portfolio doesn't exist or was removed by its owner"
Defined in src/api/entities/CheckpointSchedule/index.ts:41
Defined in src/api/entities/DividendDistribution/index.ts:85
Defined in src/api/entities/Portfolio/index.ts:56
Functions
Const areSameClaimIssuers
Const areSameClaimIssuers▸ areSameClaimIssuers(currentClaimIssuers: TrustedClaimIssuer[], claimIssuers: ModifyAssetTrustedClaimIssuersAddSetParams["claimIssuers"]): boolean
Defined in src/api/procedures/modifyAssetTrustedClaimIssuers.ts:65
Parameters:
currentClaimIssuers
claimIssuers
ModifyAssetTrustedClaimIssuersAddSetParams["claimIssuers"]
Returns: boolean
Const areSameClaims
Const areSameClaims▸ areSameClaims(claim: Claim, __namedParameters: object): boolean
Defined in src/api/procedures/modifyClaims.ts:52
Parameters:
▪ claim: Claim
▪ __namedParameters: object
scope
undefined | null | Scope
type
ClaimTypeEnum
Returns: boolean
Const areSameTargets
Const areSameTargets▸ areSameTargets(targets: CorporateActionTargets, newTargets: InputTargets): boolean
Defined in src/api/procedures/modifyCaDefaultConfig.ts:45
Parameters:
targets
newTargets
Returns: boolean
assembleBatchTransactions
▸ assembleBatchTransactions‹ArgsArray›(txsAndArgs: MapTxAndArgsArray‹ArgsArray›): MapTxWithArgs‹unknown[][]›
Defined in src/utils/internal.ts:864
Assemble the transactions array that has to be passed to addBatchTransaction from a set of parameter arrays with their respective transaction
Type parameters:
▪ ArgsArray: unknown[][]
Parameters:
txsAndArgs
MapTxAndArgsArray‹ArgsArray›
Returns: MapTxWithArgs‹unknown[][]›
Const convertArgsToRaw
Const convertArgsToRaw▸ convertArgsToRaw(claimIssuers: ModifyAssetTrustedClaimIssuersAddSetParams["claimIssuers"], rawTicker: Ticker, context: Context): object
Defined in src/api/procedures/modifyAssetTrustedClaimIssuers.ts:40
Parameters:
claimIssuers
ModifyAssetTrustedClaimIssuersAddSetParams["claimIssuers"]
rawTicker
Ticker
context
Context
Returns: object
claimIssuersToAdd: [][]
inputDids: string[]
createProcedureMethod
▸ createProcedureMethod‹ProcedureArgs, ProcedureReturnValue, Storage›(args: object, context: Context): NoArgsProcedureMethod‹ProcedureReturnValue, ProcedureReturnValue›
Defined in src/utils/internal.ts:414
Create a method that prepares a procedure
Type parameters:
▪ ProcedureArgs
▪ ProcedureReturnValue
▪ Storage
Parameters:
▪ args: object
getProcedureAndArgs
function
voidArgs
true
▪ context: Context
Returns: NoArgsProcedureMethod‹ProcedureReturnValue, ProcedureReturnValue›
▸ createProcedureMethod‹ProcedureArgs, ProcedureReturnValue, ReturnValue, Storage›(args: object, context: Context): NoArgsProcedureMethod‹ProcedureReturnValue, ReturnValue›
Defined in src/utils/internal.ts:431
Type parameters:
▪ ProcedureArgs
▪ ProcedureReturnValue
▪ ReturnValue
▪ Storage
Parameters:
▪ args: object
getProcedureAndArgs
function
transformer
function
voidArgs
true
▪ context: Context
Returns: NoArgsProcedureMethod‹ProcedureReturnValue, ReturnValue›
▸ createProcedureMethod‹MethodArgs, ProcedureArgs, ProcedureReturnValue, Storage›(args: object, context: Context): ProcedureMethod‹MethodArgs, ProcedureReturnValue, ProcedureReturnValue›
Defined in src/utils/internal.ts:450
Type parameters:
▪ MethodArgs: object
▪ ProcedureArgs
▪ ProcedureReturnValue
▪ Storage
Parameters:
▪ args: object
getProcedureAndArgs
function
▪ context: Context
Returns: ProcedureMethod‹MethodArgs, ProcedureReturnValue, ProcedureReturnValue›
▸ createProcedureMethod‹MethodArgs, ProcedureArgs, ProcedureReturnValue, ReturnValue, Storage›(args: object, context: Context): ProcedureMethod‹MethodArgs, ProcedureReturnValue, ReturnValue›
Defined in src/utils/internal.ts:470
Type parameters:
▪ MethodArgs: object
▪ ProcedureArgs
▪ ProcedureReturnValue
▪ ReturnValue
▪ Storage
Parameters:
▪ args: object
getProcedureAndArgs
function
transformer
function
▪ context: Context
Returns: ProcedureMethod‹MethodArgs, ProcedureReturnValue, ReturnValue›
Const findClaimsByOtherIssuers
Const findClaimsByOtherIssuers▸ findClaimsByOtherIssuers(claims: ClaimTarget[], claimsByDid: Record‹string, MiddlewareClaim[]›): Claim[]
Defined in src/api/procedures/modifyClaims.ts:62
Parameters:
claims
claimsByDid
Record‹string, MiddlewareClaim[]›
Returns: Claim[]
Const findPositiveBalanceIuClaims
Const findPositiveBalanceIuClaims▸ findPositiveBalanceIuClaims(claims: ClaimTarget[], context: Context): Promise‹Claim[]›
Defined in src/api/procedures/modifyClaims.ts:78
Parameters:
claims
context
Context
Returns: Promise‹Claim[]›
isAccount
▸ isAccount(value: unknown): value is Account
Defined in src/utils/typeguards.ts:70
Return whether value is an Account
Parameters:
value
unknown
Returns: value is Account
isAccreditedClaim
▸ isAccreditedClaim(claim: Claim): claim is AccreditedClaim
Defined in src/utils/typeguards.ts:214
Return whether Claim is an AccreditedClaim
Parameters:
claim
Returns: claim is AccreditedClaim
isAffiliateClaim
▸ isAffiliateClaim(claim: Claim): claim is AffiliateClaim
Defined in src/utils/typeguards.ts:221
Return whether Claim is an AffiliateClaim
Parameters:
claim
Returns: claim is AffiliateClaim
isAsset
▸ isAsset(value: unknown): value is Asset
Defined in src/utils/typeguards.ts:161
Return whether value is an Asset
Parameters:
value
unknown
Returns: value is Asset
isAuthorizationRequest
▸ isAuthorizationRequest(value: unknown): value is AuthorizationRequest
Defined in src/utils/typeguards.ts:77
Return whether value is an AuthorizationRequest
Parameters:
value
unknown
Returns: value is AuthorizationRequest
isBlockedClaim
▸ isBlockedClaim(claim: Claim): claim is BlockedClaim
Defined in src/utils/typeguards.ts:270
Return whether Claim is a BlockedClaim
Parameters:
claim
Returns: claim is BlockedClaim
isBuyLockupClaim
▸ isBuyLockupClaim(claim: Claim): claim is BuyLockupClaim
Defined in src/utils/typeguards.ts:228
Return whether Claim is a BuyLockupClaim
Parameters:
claim
Returns: claim is BuyLockupClaim
isCddClaim
▸ isCddClaim(claim: Claim): claim is CddClaim
Defined in src/utils/typeguards.ts:242
Return whether Claim is a CddClaim
Parameters:
claim
Returns: claim is CddClaim
isCddProviderRole
▸ isCddProviderRole(role: Role): role is CddProviderRole
Defined in src/utils/typeguards.ts:339
Return whether Role is CddProviderRole
Parameters:
role
Returns: role is CddProviderRole
isCheckpoint
▸ isCheckpoint(value: unknown): value is Checkpoint
Defined in src/utils/typeguards.ts:84
Return whether value is a Checkpoint
Parameters:
value
unknown
Returns: value is Checkpoint
isCheckpointSchedule
▸ isCheckpointSchedule(value: unknown): value is CheckpointSchedule
Defined in src/utils/typeguards.ts:91
Return whether value is a CheckpointSchedule
Parameters:
value
unknown
Returns: value is CheckpointSchedule
isCorporateAction
▸ isCorporateAction(value: unknown): value is CorporateAction
Defined in src/utils/typeguards.ts:98
Return whether value is a CorporateAction
Parameters:
value
unknown
Returns: value is CorporateAction
isCustomPermissionGroup
▸ isCustomPermissionGroup(value: unknown): value is CustomPermissionGroup
Defined in src/utils/typeguards.ts:105
Return whether value is a CustomPermissionGroup
Parameters:
value
unknown
Returns: value is CustomPermissionGroup
isDefaultPortfolio
▸ isDefaultPortfolio(value: unknown): value is DefaultPortfolio
Defined in src/utils/typeguards.ts:112
Return whether value is a DefaultPortfolio
Parameters:
value
unknown
Returns: value is DefaultPortfolio
isDefaultTrustedClaimIssuer
▸ isDefaultTrustedClaimIssuer(value: unknown): value is DefaultTrustedClaimIssuer
Defined in src/utils/typeguards.ts:119
Return whether value is a DefaultTrustedClaimIssuer
Parameters:
value
unknown
Returns: value is DefaultTrustedClaimIssuer
isDividendDistribution
▸ isDividendDistribution(value: unknown): value is DividendDistribution
Defined in src/utils/typeguards.ts:126
Return whether value is a DividendDistribution
Parameters:
value
unknown
Returns: value is DividendDistribution
isEntity
▸ isEntity‹Identifiers, HumanReadable›(value: unknown): value is Entity‹Identifiers, HumanReadable›
Defined in src/utils/typeguards.ts:61
Return whether value is an Entity
Type parameters:
▪ Identifiers
▪ HumanReadable
Parameters:
value
unknown
Returns: value is Entity‹Identifiers, HumanReadable›
isExemptedClaim
▸ isExemptedClaim(claim: Claim): claim is ExemptedClaim
Defined in src/utils/typeguards.ts:263
Return whether Claim is an ExemptedClaim
Parameters:
claim
Returns: claim is ExemptedClaim
isIdentity
▸ isIdentity(value: unknown): value is Identity
Defined in src/utils/typeguards.ts:133
Return whether value is an Identity
Parameters:
value
unknown
Returns: value is Identity
isIdentityCondition
▸ isIdentityCondition(condition: InputCondition): condition is InputConditionBase & IdentityCondition
Defined in src/utils/typeguards.ts:316
Return whether Condition has multiple Claims
Parameters:
condition
Returns: condition is InputConditionBase & IdentityCondition
isIdentityRole
▸ isIdentityRole(role: Role): role is IdentityRole
Defined in src/utils/typeguards.ts:353
Return whether Role is IdentityRole
Parameters:
role
Returns: role is IdentityRole
isInstruction
▸ isInstruction(value: unknown): value is Instruction
Defined in src/utils/typeguards.ts:140
Return whether value is an Instruction
Parameters:
value
unknown
Returns: value is Instruction
isInvestorUniquenessClaim
▸ isInvestorUniquenessClaim(claim: Claim): claim is InvestorUniquenessClaim
Defined in src/utils/typeguards.ts:277
Return whether a Claim is an InvestorUniquenessClaim
Parameters:
claim
Returns: claim is InvestorUniquenessClaim
isInvestorUniquenessV2Claim
▸ isInvestorUniquenessV2Claim(claim: Claim): claim is InvestorUniquenessV2Claim
Defined in src/utils/typeguards.ts:291
Return whether a Claim is an InvestorUniquenessV2Claim
Parameters:
claim
Returns: claim is InvestorUniquenessV2Claim
isJurisdictionClaim
▸ isJurisdictionClaim(claim: Claim): claim is JurisdictionClaim
Defined in src/utils/typeguards.ts:256
Return whether Claim is a JurisdictionClaim
Parameters:
claim
Returns: claim is JurisdictionClaim
isKnownPermissionGroup
▸ isKnownPermissionGroup(value: unknown): value is KnownPermissionGroup
Defined in src/utils/typeguards.ts:147
Return whether value is a KnownPermissionGroup
Parameters:
value
unknown
Returns: value is KnownPermissionGroup
isKycClaim
▸ isKycClaim(claim: Claim): claim is KycClaim
Defined in src/utils/typeguards.ts:249
Return whether Claim is a KycClaim
Parameters:
claim
Returns: claim is KycClaim
isMultiClaimCondition
▸ isMultiClaimCondition(condition: InputCondition): condition is InputConditionBase & MultiClaimCondition
Defined in src/utils/typeguards.ts:307
Return whether Condition has multiple Claims
Parameters:
condition
Returns: condition is InputConditionBase & MultiClaimCondition
isNoDataClaim
▸ isNoDataClaim(claim: Claim): claim is NoDataClaim
Defined in src/utils/typeguards.ts:284
Return whether Claim is a NoDataClaim
Parameters:
claim
Returns: claim is NoDataClaim
isNumberedPortfolio
▸ isNumberedPortfolio(value: unknown): value is NumberedPortfolio
Defined in src/utils/typeguards.ts:154
Return whether value is a NumberedPortfolio
Parameters:
value
unknown
Returns: value is NumberedPortfolio
isOffering
▸ isOffering(value: unknown): value is Offering
Defined in src/utils/typeguards.ts:168
Return whether value is an Offering
Parameters:
value
unknown
Returns: value is Offering
isPolymeshError
▸ isPolymeshError(value: unknown): value is PolymeshError
Defined in src/utils/typeguards.ts:189
Return whether value is a PolymeshError
Parameters:
value
unknown
Returns: value is PolymeshError
isPolymeshTransaction
▸ isPolymeshTransaction(value: unknown): value is PolymeshTransaction
Defined in src/utils/typeguards.ts:359
Return whether value is a PolymeshTransaction
Parameters:
value
unknown
Returns: value is PolymeshTransaction
isPolymeshTransactionBatch
▸ isPolymeshTransactionBatch(value: unknown): value is PolymeshTransactionBatch
Defined in src/utils/typeguards.ts:366
Return whether value is a PolymeshTransactionBatch
Parameters:
value
unknown
Returns: value is PolymeshTransactionBatch
isPortfolioCustodianRole
▸ isPortfolioCustodianRole(role: Role): role is PortfolioCustodianRole
Defined in src/utils/typeguards.ts:325
Return whether Role is PortfolioCustodianRole
Parameters:
role
Returns: role is PortfolioCustodianRole
isScopedClaim
▸ isScopedClaim(claim: Claim): claim is ScopedClaim
Defined in src/utils/typeguards.ts:207
Return whether a Claim is a ScopedClaim
Parameters:
claim
Returns: claim is ScopedClaim
isSellLockupClaim
▸ isSellLockupClaim(claim: Claim): claim is SellLockupClaim
Defined in src/utils/typeguards.ts:235
Return whether Claim is a SellLockupClaim
Parameters:
claim
Returns: claim is SellLockupClaim
isSingleClaimCondition
▸ isSingleClaimCondition(condition: InputCondition): condition is InputConditionBase & SingleClaimCondition
Defined in src/utils/typeguards.ts:298
Return whether Condition has a single Claim
Parameters:
condition
Returns: condition is InputConditionBase & SingleClaimCondition
isTickerOwnerRole
▸ isTickerOwnerRole(role: Role): role is TickerOwnerRole
Defined in src/utils/typeguards.ts:346
Return whether Role is TickerOwnerRole
Parameters:
role
Returns: role is TickerOwnerRole
isTickerReservation
▸ isTickerReservation(value: unknown): value is TickerReservation
Defined in src/utils/typeguards.ts:175
Return whether value is a TickerReservation
Parameters:
value
unknown
Returns: value is TickerReservation
isUnscopedClaim
▸ isUnscopedClaim(claim: Claim): claim is UnscopedClaim
Defined in src/utils/typeguards.ts:196
Return whether a Claim is an UnscopedClaim
Parameters:
claim
Returns: claim is UnscopedClaim
isVenue
▸ isVenue(value: unknown): value is Venue
Defined in src/utils/typeguards.ts:182
Return whether value is a Venue
Parameters:
value
unknown
Returns: value is Venue
isVenueOwnerRole
▸ isVenueOwnerRole(role: Role): role is VenueOwnerRole
Defined in src/utils/typeguards.ts:332
Return whether Role is VenueOwnerRole
Parameters:
role
Returns: role is VenueOwnerRole
tickerToDid
▸ tickerToDid(ticker: string): string
Defined in src/utils/conversion.ts:234
Generate an Asset's DID from a ticker
Parameters:
ticker
string
Returns: string
Const tuple
Const tuple▸ tuple‹T›(...args: T): T
Defined in src/types/utils/index.ts:72
Create a literal tuple type from a list of arguments
Type parameters:
▪ T: unknown[]
Parameters:
...args
T
values to turn into a tuple
Returns: T
txGroupToTxTags
▸ txGroupToTxTags(group: TxGroup): TxTag[]
Defined in src/utils/conversion.ts:624
Retrieve every Transaction Tag associated to a Transaction Group
Parameters:
group
Returns: TxTag[]
Object literals
Const defaultMessages
Const defaultMessages▪ defaultMessages: object
Defined in src/base/PolymeshError.ts:3
[ErrorCode.TransactionAborted]
• [ErrorCode.TransactionAborted]: string = "The transaction was removed from the transaction pool. This might mean that it was malformed (nonce too large/nonce too small/duplicated or invalid transaction)"
Defined in src/base/PolymeshError.ts:7
[ErrorCode.TransactionRejectedByUser]
• [ErrorCode.TransactionRejectedByUser]: string = "The user canceled the transaction signature"
Defined in src/base/PolymeshError.ts:9
[ErrorCode.TransactionReverted]
• [ErrorCode.TransactionReverted]: string = "The transaction execution reverted due to an error"
Defined in src/base/PolymeshError.ts:6
Last updated
Was this helpful?