@polymeshassociation/polymesh-sdk 14.0.0-beta.11

package/base/Context.d.ts

@@ -0,0 +1,287 @@
+import { ApiPromise } from '@polkadot/api';
+import { InterfaceTypes, Signer as PolkadotSigner } from '@polkadot/types/types';
+import { SigningManager } from '@polymathnetwork/signing-manager-types';
+import { NormalizedCacheObject } from 'apollo-cache-inmemory';
+import ApolloClient, { ApolloQueryResult } from 'apollo-client';
+import BigNumber from 'bignumber.js';
+import { TxTag } from "../polkadot/types";
+import { Account, Asset, Identity } from "../internal";
+import { Query } from "../middleware/types";
+import { AccountBalance, ClaimData, ClaimType, DistributionWithDetails, ProtocolFees, ResultSet, SubCallback, SubsidyWithAllowance, TransactionArgument, UnsubCallback } from "../types";
+import { GraphqlQuery } from "../types/internal";
+/**
+ * @hidden
+ *
+ * Context in which the SDK is being used
+ *
+ * - Holds the polkadot API instance
+ * - Holds the middleware API instance (if any)
+ * - Holds the Signing Manager (if any)
+ */
+export declare class Context {
+    private isDisconnected;
+    polymeshApi: ApiPromise;
+    /**
+     * Whether the current node is an archive node (contains a full history from genesis onward) or not
+     */
+    isArchiveNode: boolean;
+    ss58Format: BigNumber;
+    private _middlewareApi;
+    private _polymeshApi;
+    private _signingManager?;
+    private signingAddress?;
+    /**
+     * @hidden
+     */
+    private constructor();
+    /**
+     * @hidden
+     */
+    static createPolymeshApiProxy(ctx: Context): ApiPromise;
+    /**
+     * @hidden
+     *
+     * Create the Context instance
+     */
+    static create(params: {
+        polymeshApi: ApiPromise;
+        middlewareApi: ApolloClient<NormalizedCacheObject> | null;
+        signingManager?: SigningManager;
+    }): Promise<Context>;
+    /**
+     * @hidden
+     */
+    private isCurrentNodeArchive;
+    /**
+     * @hidden
+     *
+     * @note the signing Account will be set to the Signing Manager's first Account. If the Signing Manager has
+     *   no Accounts yet, the signing Account will be left empty
+     */
+    setSigningManager(signingManager: SigningManager): Promise<void>;
+    /**
+     * @hidden
+     */
+    private get signingManager();
+    /**
+     * @hidden
+     *
+     * Retrieve a list of Accounts that can sign transactions
+     */
+    getSigningAccounts(): Promise<Account[]>;
+    /**
+     * @hidden
+     *
+     * Set the signing Account from among the existing ones in the Signing Manager
+     *
+     * @throws if the passed address isn't valid, or isn't present in the Signing Manager
+     */
+    setSigningAddress(signingAddress: string): Promise<void>;
+    /**
+     * @hidden
+     *
+     * Retrieve the Account POLYX balance
+     *
+     * @note can be subscribed to
+     */
+    accountBalance(account?: string | Account): Promise<AccountBalance>;
+    accountBalance(account: string | Account | undefined, callback: SubCallback<AccountBalance>): Promise<UnsubCallback>;
+    /**
+     * @hidden
+     *
+     * Retrieve the Account subsidizer relationship. If there is no such relationship, return null
+     *
+     * @note can be subscribed to
+     */
+    accountSubsidy(account?: string | Account): Promise<SubsidyWithAllowance | null>;
+    accountSubsidy(account: string | Account | undefined, callback: SubCallback<SubsidyWithAllowance | null>): Promise<UnsubCallback>;
+    /**
+     * @hidden
+     *
+     * Retrieve the signing Account
+     *
+     * @throws if there is no signing Account associated to the SDK instance
+     */
+    getSigningAccount(): Account;
+    /**
+     * @hidden
+     *
+     * Retrieve the signing Identity
+     *
+     * @throws if there is no Identity associated to the signing Account (or there is no signing Account associated to the SDK instance)
+     */
+    getSigningIdentity(): Promise<Identity>;
+    /**
+     * @hidden
+     *
+     * Retrieve the polkadot.js promise client
+     */
+    getPolymeshApi(): ApiPromise;
+    /**
+     * @hidden
+     *
+     * Retrieve the signing address
+     *
+     * @throws if there is no signing Account associated to the SDK instance
+     */
+    getSigningAddress(): string;
+    /**
+     * @hidden
+     *
+     * Retrieve the external signer from the Signing Manager
+     */
+    getExternalSigner(): PolkadotSigner;
+    /**
+     * @hidden
+     *
+     * Check whether a set of Identities exist
+     */
+    getInvalidDids(identities: (string | Identity)[]): Promise<string[]>;
+    /**
+     * @hidden
+     *
+     * Returns an Identity when given a DID string
+     *
+     * @throws if the Identity does not exist
+     */
+    getIdentity(identity: Identity | string): Promise<Identity>;
+    /**
+     * @hidden
+     *
+     * Retrieve the protocol fees associated with running specific transactions
+     *
+     * @param tags - list of transaction tags (i.e. [TxTags.asset.CreateAsset, TxTags.asset.RegisterTicker] or ["asset.createAsset", "asset.registerTicker"])
+     * @param blockHash - optional hash of the block to get the protocol fees at that block
+     */
+    getProtocolFees({ tags, blockHash, }: {
+        tags: TxTag[];
+        blockHash?: string;
+    }): Promise<ProtocolFees[]>;
+    /**
+     * @hidden
+     *
+     * Return whether the passed transaction can be subsidized
+     */
+    supportsSubsidy({ tag }: {
+        tag: TxTag;
+    }): boolean;
+    /**
+     * Retrieve the types of arguments that a certain transaction requires to be run
+     *
+     * @param args.tag - tag associated with the transaction that will be executed if the proposal passes
+     */
+    getTransactionArguments({ tag }: {
+        tag: TxTag;
+    }): TransactionArgument[];
+    /**
+     * @hidden
+     */
+    getDividendDistributionsForAssets(args: {
+        assets: Asset[];
+    }): Promise<DistributionWithDetails[]>;
+    /**
+     * @hidden
+     *
+     * @note no claimTypes value means ALL claim types
+     */
+    getIdentityClaimsFromChain(args: {
+        targets: (string | Identity)[];
+        claimTypes?: ClaimType[];
+        trustedClaimIssuers?: (string | Identity)[];
+        includeExpired: boolean;
+    }): Promise<ClaimData[]>;
+    /**
+     * @hidden
+     */
+    getIdentityClaimsFromMiddleware(args: {
+        targets?: (string | Identity)[];
+        trustedClaimIssuers?: (string | Identity)[];
+        claimTypes?: Exclude<ClaimType, ClaimType.InvestorUniquenessV2>[];
+        includeExpired?: boolean;
+        size?: BigNumber;
+        start?: BigNumber;
+    }): Promise<ResultSet<ClaimData>>;
+    /**
+     * @hidden
+     *
+     * Retrieve a list of claims. Can be filtered using parameters
+     *
+     * @param opts.targets - Identities (or Identity IDs) for which to fetch claims (targets). Defaults to all targets
+     * @param opts.trustedClaimIssuers - Identity IDs of claim issuers. Defaults to all claim issuers
+     * @param opts.claimTypes - types of the claims to fetch. Defaults to any type
+     * @param opts.includeExpired - whether to include expired claims. Defaults to true
+     * @param opts.size - page size
+     * @param opts.start - page offset
+     *
+     * @note uses the middleware (optional)
+     */
+    issuedClaims(opts?: {
+        targets?: (string | Identity)[];
+        trustedClaimIssuers?: (string | Identity)[];
+        claimTypes?: Exclude<ClaimType, ClaimType.InvestorUniquenessV2>[];
+        includeExpired?: boolean;
+        size?: BigNumber;
+        start?: BigNumber;
+    }): Promise<ResultSet<ClaimData>>;
+    /**
+     * @hidden
+     *
+     * Retrieve the middleware client
+     *
+     * @throws if the middleware is not enabled
+     */
+    get middlewareApi(): ApolloClient<NormalizedCacheObject>;
+    /**
+     * @hidden
+     *
+     * Make a query to the middleware server using the apollo client
+     */
+    queryMiddleware<Result extends Partial<Query>>(query: GraphqlQuery<unknown>): Promise<ApolloQueryResult<Result>>;
+    /**
+     * @hidden
+     *
+     * Return whether the middleware was enabled at startup
+     */
+    isMiddlewareEnabled(): boolean;
+    /**
+     * @hidden
+     *
+     * Return whether the middleware is enabled and online
+     */
+    isMiddlewareAvailable(): Promise<boolean>;
+    /**
+     * @hidden
+     *
+     * Retrieve the latest block number
+     */
+    getLatestBlock(): Promise<BigNumber>;
+    /**
+     * @hidden
+     *
+     * Retrieve the network version
+     */
+    getNetworkVersion(): Promise<string>;
+    /**
+     * @hidden
+     *
+     * Disconnect the Polkadot API, middleware, and render this instance unusable
+     *
+     * @note after disconnecting, trying to access any property in this object will result
+     *   in an error
+     */
+    disconnect(): Promise<void>;
+    /**
+     * @hidden
+     *
+     * Returns a (shallow) clone of this instance. Useful for providing a separate
+     *   Context to Procedures with different signing Accounts
+     */
+    clone(): Context;
+    /**
+     *  @hidden
+     *
+     * Creates an instance of a type as registered in the polymeshApi instance
+     */
+    createType<K extends keyof InterfaceTypes>(type: K, params: unknown): InterfaceTypes[K];
+}
+//# sourceMappingURL=Context.d.ts.map

package/base/Context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Context.d.ts","sourceRoot":"","sources":["../../src/base/Context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAG3C,OAAO,EAEL,cAAc,EACd,MAAM,IAAI,cAAc,EAGzB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,cAAc,EAAE,MAAM,wCAAwC,CAAC;AACxE,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,YAAY,EAAE,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAChE,OAAO,SAAS,MAAM,cAAc,CAAC;AAIrC,OAAO,EAML,KAAK,EACN,0BAA6B;AAE9B,OAAO,EAAE,OAAO,EAAE,KAAK,EAAwB,QAAQ,EAA0B,oBAAmB;AAEpG,OAAO,EAAiB,KAAK,EAAE,4BAA2B;AAC1D,OAAO,EACL,cAAc,EAEd,SAAS,EACT,SAAS,EAGT,uBAAuB,EAGvB,YAAY,EACZ,SAAS,EAET,WAAW,EACX,oBAAoB,EACpB,mBAAmB,EAEnB,aAAa,EACd,iBAAgB;AACjB,OAAO,EAAE,YAAY,EAAE,0BAAyB;AAoChD;;;;;;;;GAQG;AACH,qBAAa,OAAO;IAClB,OAAO,CAAC,cAAc,CAAS;IAExB,WAAW,EAAE,UAAU,CAAC;IAE/B;;OAEG;IACI,aAAa,UAAS;IAEtB,UAAU,EAAE,SAAS,CAAC;IAE7B,OAAO,CAAC,cAAc,CAA6C;IAEnE,OAAO,CAAC,YAAY,CAAa;IAEjC,OAAO,CAAC,eAAe,CAAC,CAAiB;IAEzC,OAAO,CAAC,cAAc,CAAC,CAAS;IAEhC;;OAEG;IACH,OAAO;IASP;;OAEG;IACH,MAAM,CAAC,sBAAsB,CAAC,GAAG,EAAE,OAAO,GAAG,UAAU;IAevD;;;;OAIG;WACU,MAAM,CAAC,MAAM,EAAE;QAC1B,WAAW,EAAE,UAAU,CAAC;QACxB,aAAa,EAAE,YAAY,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC;QAC1D,cAAc,CAAC,EAAE,cAAc,CAAC;KACjC,GAAG,OAAO,CAAC,OAAO,CAAC;IA6BpB;;OAEG;YACW,oBAAoB;IAgBlC;;;;;OAKG;IACU,iBAAiB,CAAC,cAAc,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAe7E;;OAEG;IACH,OAAO,KAAK,cAAc,GAWzB;IAED;;;;OAIG;IACU,kBAAkB,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAQrD;;;;;;OAMG;IACU,iBAAiB,CAAC,cAAc,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAuBrE;;;;;;OAMG;IACI,cAAc,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC,cAAc,CAAC;IACnE,cAAc,CACnB,OAAO,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,EACrC,QAAQ,EAAE,WAAW,CAAC,cAAc,CAAC,GACpC,OAAO,CAAC,aAAa,CAAC;IAmDzB;;;;;;OAMG;IACI,cAAc,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC;IAChF,cAAc,CACnB,OAAO,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,EACrC,QAAQ,EAAE,WAAW,CAAC,oBAAoB,GAAG,IAAI,CAAC,GACjD,OAAO,CAAC,aAAa,CAAC;IAmDzB;;;;;;OAMG;IACI,iBAAiB,IAAI,OAAO;IAMnC;;;;;;OAMG;IACU,kBAAkB,IAAI,OAAO,CAAC,QAAQ,CAAC;IAepD;;;;OAIG;IACI,cAAc,IAAI,UAAU;IAInC;;;;;;OAMG;IACI,iBAAiB,IAAI,MAAM;IAalC;;;;OAIG;IACI,iBAAiB,IAAI,cAAc;IAM1C;;;;OAIG;IACU,cAAc,CAAC,UAAU,EAAE,CAAC,MAAM,GAAG,QAAQ,CAAC,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAwBjF;;;;;;OAMG;IACU,WAAW,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAiBxE;;;;;;;OAOG;IACU,eAAe,CAAC,EAC3B,IAAI,EACJ,SAAS,GACV,EAAE;QACD,IAAI,EAAE,KAAK,EAAE,CAAC;QACd,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;IAuD3B;;;;OAIG;IACI,eAAe,CAAC,EAAE,GAAG,EAAE,EAAE;QAAE,GAAG,EAAE,KAAK,CAAA;KAAE,GAAG,OAAO;IAgBxD;;;;OAIG;IACI,uBAAuB,CAAC,EAAE,GAAG,EAAE,EAAE;QAAE,GAAG,EAAE,KAAK,CAAA;KAAE,GAAG,mBAAmB,EAAE;IAmJ9E;;OAEG;IACU,iCAAiC,CAAC,IAAI,EAAE;QACnD,MAAM,EAAE,KAAK,EAAE,CAAC;KACjB,GAAG,OAAO,CAAC,uBAAuB,EAAE,CAAC;IAuGtC;;;;OAIG;IACU,0BAA0B,CAAC,IAAI,EAAE;QAC5C,OAAO,EAAE,CAAC,MAAM,GAAG,QAAQ,CAAC,EAAE,CAAC;QAC/B,UAAU,CAAC,EAAE,SAAS,EAAE,CAAC;QACzB,mBAAmB,CAAC,EAAE,CAAC,MAAM,GAAG,QAAQ,CAAC,EAAE,CAAC;QAC5C,cAAc,EAAE,OAAO,CAAC;KACzB,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAyDxB;;OAEG;IACU,+BAA+B,CAAC,IAAI,EAAE;QACjD,OAAO,CAAC,EAAE,CAAC,MAAM,GAAG,QAAQ,CAAC,EAAE,CAAC;QAChC,mBAAmB,CAAC,EAAE,CAAC,MAAM,GAAG,QAAQ,CAAC,EAAE,CAAC;QAC5C,UAAU,CAAC,EAAE,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,oBAAoB,CAAC,EAAE,CAAC;QAClE,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB,IAAI,CAAC,EAAE,SAAS,CAAC;QACjB,KAAK,CAAC,EAAE,SAAS,CAAC;KACnB,GAAG,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IA0DjC;;;;;;;;;;;;;OAaG;IACU,YAAY,CACvB,IAAI,GAAE;QACJ,OAAO,CAAC,EAAE,CAAC,MAAM,GAAG,QAAQ,CAAC,EAAE,CAAC;QAChC,mBAAmB,CAAC,EAAE,CAAC,MAAM,GAAG,QAAQ,CAAC,EAAE,CAAC;QAC5C,UAAU,CAAC,EAAE,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,oBAAoB,CAAC,EAAE,CAAC;QAClE,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB,IAAI,CAAC,EAAE,SAAS,CAAC;QACjB,KAAK,CAAC,EAAE,SAAS,CAAC;KACd,GACL,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IAqChC;;;;;;OAMG;IACH,IAAW,aAAa,IAAI,YAAY,CAAC,qBAAqB,CAAC,CAW9D;IAED;;;;OAIG;IACU,eAAe,CAAC,MAAM,SAAS,OAAO,CAAC,KAAK,CAAC,EACxD,KAAK,EAAE,YAAY,CAAC,OAAO,CAAC,GAC3B,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAiBrC;;;;OAIG;IACI,mBAAmB,IAAI,OAAO;IAIrC;;;;OAIG;IACU,qBAAqB,IAAI,OAAO,CAAC,OAAO,CAAC;IAUtD;;;;OAIG;IACU,cAAc,IAAI,OAAO,CAAC,SAAS,CAAC;IAMjD;;;;OAIG;IACU,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC;IAMjD;;;;;;;OAOG;IACI,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAclC;;;;;OAKG;IACI,KAAK,IAAI,OAAO;IAOvB;;;;OAIG;IACI,UAAU,CAAC,CAAC,SAAS,MAAM,cAAc,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,GAAG,cAAc,CAAC,CAAC,CAAC;CAW/F"}