@dfns/sdk 0.1.0-beta.7 → 0.1.0

package/baseAuthApi.d.ts

@@ -94,6 +94,10 @@ export declare class BaseAuthApi {
      * Completes user login by sending the signed login challenge.
      */
     static createUserLogin(request: CreateUserLoginRequest, options: DfnsBaseApiOptions): Promise<UserLoginResponse>;
+    /**
+     * Completes user logout by sending the user auth token.
+     */
+    static userLogout(options: DfnsBaseApiOptions): Promise<void>;
     /**
      * Initiates Registration by creating a challenge that will need to be signed by a new set of Credentials.
      */

package/baseAuthApi.js

@@ -47,6 +47,19 @@ class BaseAuthApi {
         });
         return response.json();
     }
+    /**
+     * Completes user logout by sending the user auth token.
+     */
+    static async userLogout(options) {
+        if (!options.authToken) {
+            throw new Error('authToken is required');
+        }
+        const response = await (0, fetch_1.simpleFetch)('/auth/logout', {
+            method: 'PUT',
+            apiOptions: options,
+        });
+        return response.json();
+    }
     /**
      * Initiates Registration by creating a challenge that will need to be signed by a new set of Credentials.
      */

package/codegen/Wallets/DelegatedWalletsClient.d.ts

@@ -25,4 +25,6 @@ export declare class DelegatedWalletsClient {
     listSignatures(request: T.ListSignaturesRequest): Promise<T.ListSignaturesResponse>;
     importWalletInit(request: T.ImportWalletRequest): Promise<UserActionChallengeResponse>;
     importWalletComplete(request: T.ImportWalletRequest, signedChallenge: SignUserActionChallengeRequest): Promise<T.ImportWalletResponse>;
+    exportWalletInit(request: T.ExportWalletRequest): Promise<UserActionChallengeResponse>;
+    exportWalletComplete(request: T.ExportWalletRequest, signedChallenge: SignUserActionChallengeRequest): Promise<T.ExportWalletResponse>;
 }

package/codegen/Wallets/DelegatedWalletsClient.js

@@ -272,5 +272,32 @@ class DelegatedWalletsClient {
         });
         return response.json();
     }
+    async exportWalletInit(request) {
+        const path = (0, url_1.buildPathAndQuery)('/wallets/:walletId/export', {
+            path: { walletId: request.walletId },
+            query: {},
+        });
+        const challenge = await baseAuthApi_1.BaseAuthApi.createUserActionChallenge({
+            userActionHttpMethod: 'POST',
+            userActionHttpPath: path,
+            userActionPayload: JSON.stringify(request.body),
+            userActionServerKind: 'Api',
+        }, this.apiOptions);
+        return challenge;
+    }
+    async exportWalletComplete(request, signedChallenge) {
+        const path = (0, url_1.buildPathAndQuery)('/wallets/:walletId/export', {
+            path: { walletId: request.walletId },
+            query: {},
+        });
+        const { userAction } = await baseAuthApi_1.BaseAuthApi.signUserActionChallenge(signedChallenge, this.apiOptions);
+        const response = await (0, fetch_1.simpleFetch)(path, {
+            method: 'POST',
+            body: request.body,
+            headers: { 'x-dfns-useraction': userAction },
+            apiOptions: this.apiOptions,
+        });
+        return response.json();
+    }
 }
 exports.DelegatedWalletsClient = DelegatedWalletsClient;

package/codegen/Wallets/WalletsClient.d.ts

@@ -19,4 +19,5 @@ export declare class WalletsClient {
     getSignature(request: T.GetSignatureRequest): Promise<T.GetSignatureResponse>;
     listSignatures(request: T.ListSignaturesRequest): Promise<T.ListSignaturesResponse>;
     importWallet(request: T.ImportWalletRequest): Promise<T.ImportWalletResponse>;
+    exportWallet(request: T.ExportWalletRequest): Promise<T.ExportWalletResponse>;
 }

package/codegen/Wallets/WalletsClient.js

@@ -196,5 +196,17 @@ class WalletsClient {
         });
         return response.json();
     }
+    async exportWallet(request) {
+        const path = (0, url_1.buildPathAndQuery)('/wallets/:walletId/export', {
+            path: { walletId: request.walletId },
+            query: {},
+        });
+        const response = await (0, fetch_1.userActionFetch)(path, {
+            method: 'POST',
+            body: request.body,
+            apiOptions: this.apiOptions,
+        });
+        return response.json();
+    }
 }
 exports.WalletsClient = WalletsClient;

package/codegen/Wallets/types.d.ts

@@ -89,3 +89,8 @@ export type ImportWalletRequest = {
     body: Wallets.ImportWalletBody;
 };
 export type ImportWalletResponse = Wallets.Wallet;
+export type ExportWalletRequest = {
+    walletId: Foundations.EntityId;
+    body: Wallets.ExportWalletBody;
+};
+export type ExportWalletResponse = Wallets.ExportedSigningKey;

package/codegen/datamodel/Signers/responses.d.ts

@@ -5,3 +5,23 @@ export type ListSignersError = {
     error: ForbiddenError | UnauthorizedError | BadRequestError;
 };
 export type ListSignersResponse = ListSignersSuccess | ListSignersError;
+export type GetLatestClusterHealthSuccess = String;
+export type GetLatestClusterHealthError = {
+    error: ForbiddenError;
+};
+export type GetLatestClusterHealthResponse = GetLatestClusterHealthSuccess | GetLatestClusterHealthError;
+export type ListClustersHealthSuccess = String;
+export type ListClustersHealthError = {
+    error: ForbiddenError;
+};
+export type ListClustersHealthResponse = ListClustersHealthSuccess | ListClustersHealthError;
+export type SetKeyMaxPresigsSuccess = String;
+export type SetKeyMaxPresigsError = {
+    error: ForbiddenError;
+};
+export type SetKeyMaxPresigsResponse = SetKeyMaxPresigsSuccess | SetKeyMaxPresigsError;
+export type TriggerClusterProvisioningSuccess = String;
+export type TriggerClusterProvisioningError = {
+    error: ForbiddenError;
+};
+export type TriggerClusterProvisioningResponse = TriggerClusterProvisioningSuccess | TriggerClusterProvisioningError;

package/codegen/datamodel/Wallets/responses.d.ts

@@ -1,5 +1,5 @@
 import { BadRequestError, EntityNotFoundError, ForbiddenError, UnauthorizedError } from '../Foundations';
-import { PaginatedEventHistory, PaginatedSignatureList, PaginatedTransactionList, PaginatedTransferList, PaginatedWalletList, SignatureRequest, TransactionRequest, TransferRequest, Wallet, WalletAssets, WalletNfts } from './types';
+import { ExportedSigningKey, PaginatedEventHistory, PaginatedSignatureList, PaginatedTransactionList, PaginatedTransferList, PaginatedWalletList, SignatureRequest, TransactionRequest, TransferRequest, Wallet, WalletAssets, WalletNfts } from './types';
 export type CreateWalletSuccess = Wallet;
 export type CreateWalletError = {
     error: BadRequestError | ForbiddenError | UnauthorizedError | ForbiddenError | BadRequestError | EntityNotFoundError;
@@ -80,3 +80,8 @@ export type ImportWalletError = {
     error: BadRequestError | ForbiddenError | UnauthorizedError | ForbiddenError | BadRequestError | EntityNotFoundError;
 };
 export type ImportWalletResponse = ImportWalletSuccess | ImportWalletError;
+export type ExportWalletSuccess = ExportedSigningKey;
+export type ExportWalletError = {
+    error: BadRequestError | ForbiddenError | UnauthorizedError | ForbiddenError | BadRequestError | EntityNotFoundError;
+};
+export type ExportWalletResponse = ExportWalletSuccess | ExportWalletError;

package/codegen/datamodel/Wallets/types.d.ts

@@ -16,6 +16,10 @@ export type TransferErc721Asset = {
     to: BlockchainAddress;
     tokenId: string;
 };
+export type BroadcastTransaction = {
+    kind: TransactionKind.Transaction;
+    transaction: string;
+};
 export type BroadcastEvmTransaction = {
     kind: TransactionKind.Evm;
     to?: BlockchainAddress;
@@ -42,6 +46,10 @@ export type BroadcastEvmLegacyTransaction = {
     gasLimit?: Amount;
     gasPrice?: Amount;
 };
+export type BroadcastPsbt = {
+    kind: TransactionKind.Psbt;
+    psbt: string;
+};
 export type SignHash = {
     kind: SignatureKind.Hash;
     hash: string;
@@ -50,6 +58,10 @@ export type SignMessage = {
     kind: SignatureKind.Message;
     message: string;
 };
+export type SignTransaction = {
+    kind: SignatureKind.Transaction;
+    transaction: string;
+};
 export type Eip712Domain = {
     name?: string;
     version?: string;
@@ -63,10 +75,30 @@ export type SignEip712TypedData = {
     domain: Eip712Domain;
     message: Record<string, unknown>;
 };
+export type SignPsbt = {
+    kind: SignatureKind.Psbt;
+    psbt: string;
+};
 export type EncryptedKeyShare = {
+    /**
+     * Base64-encoded ID of the signer where the encrypted key share comes from.
+     */
     signerId: string;
+    /**
+     * Base64-encoded key share.
+     */
     encryptedKeyShare: string;
 };
+export type SupportedExportScheme = {
+    /**
+     * Base64-encoded ID of the signer where the encrypted key share comes from.
+     */
+    curve: KeyCurve;
+    /**
+     * Base64-encoded key share.
+     */
+    protocol: KeyProtocol;
+};
 export type Wallet = {
     id: EntityId;
     network: BlockchainNetwork;
@@ -77,10 +109,18 @@ export type Wallet = {
     externalId?: string;
     tags: Tag[];
     dateCreated: IsoDatetime;
+    /**
+     * If present, represents the moment when the wallet was exported for the first time.
+     */
+    dateExported?: IsoDatetime;
     /**
      * Whether the wallet was imported, or if it was generated on Dfns side.
      */
     imported?: boolean;
+    /**
+     * Whether the wallet was ever exported.
+     */
+    exported?: boolean;
 };
 export type SigningKey = {
     scheme: KeyScheme;
@@ -187,6 +227,7 @@ export type TransferRequest = {
     dateBroadcasted?: IsoDatetime;
     dateConfirmed?: IsoDatetime;
     reason?: string;
+    metadata: TransferRequestMetadata;
 };
 export type PaginatedTransferList = {
     walletId: EntityId;
@@ -226,6 +267,8 @@ export type SignatureRequest = {
     requester: RequesterIdentity;
     requestBody: GenerateSignatureBody;
     signature?: Signature;
+    signatures?: Signature[];
+    signedData?: string;
     status: SignatureStatus;
     txHash?: string;
     fee?: Amount;
@@ -245,6 +288,27 @@ export type RequesterIdentity = {
     tokenId?: EntityId;
     appId?: EntityId;
 };
+export type TransferRequestMetadata = {
+    asset: AssetMetadata;
+};
+export type AssetMetadata = {
+    symbol?: string;
+    decimals?: number;
+    verified?: boolean;
+};
+export type ExportedSigningKey = {
+    publicKey: string;
+    /**
+     * The TSS threshold parameter of this wallet private signing key shares.
+     */
+    minSigners: IntegerPositiveStrict;
+    curve: KeyCurve;
+    protocol: KeyProtocol;
+    /**
+     * Key shares of the exported wallet. These key shares are encrypted with the provided encryption key. The wallet private key must then be re-constructed from them.
+     */
+    encryptedKeyShares: EncryptedKeyShare[];
+};
 export type CreateWalletBody = {
     network: BlockchainNetwork;
     externalId?: string;
@@ -261,9 +325,19 @@ export type ImportWalletBody = {
     curve: KeyCurve;
     encryptedKeyShares: EncryptedKeyShare[];
 };
+export type ExportWalletBody = {
+    /**
+     * Encryption public key that will be used by signers to encrypt the exported wallet key shares. The purpose of encrypting key shares is to have them extra-safe and not usable in any place in the system until they are safely returned back to the client issuing the export command.
+     */
+    encryptionKey: string;
+    /**
+     * The schemes supported by the client issuing the export request, for private key reconstruction.
+     */
+    supportedSchemes: SupportedExportScheme[];
+};
 export type TransferAssetBody = TransferNativeAsset | TransferErc20Asset | TransferErc721Asset;
-export type BroadcastTransactionBody = BroadcastEvmTransaction | BroadcastEip1559Transaction | BroadcastEvmLegacyTransaction;
-export type GenerateSignatureBody = SignHash | SignMessage | SignEip712TypedData;
+export type BroadcastTransactionBody = BroadcastTransaction | BroadcastEvmTransaction | BroadcastEip1559Transaction | BroadcastEvmLegacyTransaction | BroadcastPsbt;
+export type GenerateSignatureBody = SignHash | SignMessage | SignTransaction | SignEip712TypedData | SignPsbt;
 export type BlockchainEvent = NativeTransferEvent | Erc20TransferEvent | Erc721TransferEvent;
 export declare enum TransferKind {
     Native = "Native",
@@ -271,19 +345,24 @@ export declare enum TransferKind {
     Erc721 = "Erc721"
 }
 export declare enum TransactionKind {
+    Transaction = "Transaction",
     Evm = "Evm",
     Eip1559 = "Eip1559",
-    EvmLegacy = "EvmLegacy"
+    EvmLegacy = "EvmLegacy",
+    Psbt = "Psbt"
 }
 export declare enum SignatureKind {
     Hash = "Hash",
     Message = "Message",
-    Eip712 = "Eip712"
+    Transaction = "Transaction",
+    Eip712 = "Eip712",
+    Psbt = "Psbt"
 }
 export declare enum WalletStatus {
     Active = "Active",
     Creating = "Creating",
-    Failed = "Failed"
+    Failed = "Failed",
+    Archived = "Archived"
 }
 export declare enum KeyScheme {
     ECDSA = "ECDSA",
@@ -336,7 +415,7 @@ export declare enum BlockchainNetwork {
     AvalancheC = "AvalancheC",
     AvalancheCFuji = "AvalancheCFuji",
     Bitcoin = "Bitcoin",
-    BitcoinTestnet = "BitcoinTestnet",
+    BitcoinTestnet3 = "BitcoinTestnet3",
     Bsc = "Bsc",
     BscTestnet = "BscTestnet",
     Ethereum = "Ethereum",

package/codegen/datamodel/Wallets/types.js

@@ -14,12 +14,16 @@ var TransferKind;
 // FIXME: Missing documentation for TransactionKind
 var TransactionKind;
 (function (TransactionKind) {
+    // FIXME: Missing documentation for Transaction
+    TransactionKind["Transaction"] = "Transaction";
     // FIXME: Missing documentation for Evm
     TransactionKind["Evm"] = "Evm";
     // FIXME: Missing documentation for Eip1559
     TransactionKind["Eip1559"] = "Eip1559";
     // FIXME: Missing documentation for EvmLegacy
     TransactionKind["EvmLegacy"] = "EvmLegacy";
+    // FIXME: Missing documentation for Psbt
+    TransactionKind["Psbt"] = "Psbt";
 })(TransactionKind = exports.TransactionKind || (exports.TransactionKind = {}));
 // FIXME: Missing documentation for SignatureKind
 var SignatureKind;
@@ -28,8 +32,12 @@ var SignatureKind;
     SignatureKind["Hash"] = "Hash";
     // FIXME: Missing documentation for Message
     SignatureKind["Message"] = "Message";
+    // FIXME: Missing documentation for Transaction
+    SignatureKind["Transaction"] = "Transaction";
     // FIXME: Missing documentation for Eip712
     SignatureKind["Eip712"] = "Eip712";
+    // FIXME: Missing documentation for Psbt
+    SignatureKind["Psbt"] = "Psbt";
 })(SignatureKind = exports.SignatureKind || (exports.SignatureKind = {}));
 // FIXME: Missing documentation for WalletStatus
 var WalletStatus;
@@ -40,6 +48,8 @@ var WalletStatus;
     WalletStatus["Creating"] = "Creating";
     // FIXME: Missing documentation for Failed
     WalletStatus["Failed"] = "Failed";
+    // FIXME: Missing documentation for Archived
+    WalletStatus["Archived"] = "Archived";
 })(WalletStatus = exports.WalletStatus || (exports.WalletStatus = {}));
 // FIXME: Missing documentation for KeyScheme
 var KeyScheme;
@@ -144,8 +154,8 @@ var BlockchainNetwork;
     BlockchainNetwork["AvalancheCFuji"] = "AvalancheCFuji";
     // FIXME: Missing documentation for Bitcoin
     BlockchainNetwork["Bitcoin"] = "Bitcoin";
-    // FIXME: Missing documentation for BitcoinTestnet
-    BlockchainNetwork["BitcoinTestnet"] = "BitcoinTestnet";
+    // FIXME: Missing documentation for BitcoinTestnet3
+    BlockchainNetwork["BitcoinTestnet3"] = "BitcoinTestnet3";
     // FIXME: Missing documentation for Bsc
     BlockchainNetwork["Bsc"] = "Bsc";
     // FIXME: Missing documentation for BscTestnet

package/package.json

@@ -1,11 +1,6 @@
 {
   "name": "@dfns/sdk",
-  "version": "0.1.0-beta.7",
-  "dependencies": {
-    "buffer": "6.0.3",
-    "cross-fetch": "3.1.6",
-    "uuid": "9.0.0"
-  },
+  "version": "0.1.0",
   "main": "./index.js",
-  "types": "./index.d.ts"
+  "type": "commonjs"
 }