@dfns/sdk 0.2.3-rc.1 → 0.2.3

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

@@ -0,0 +1,677 @@
+import { Amount, BlockchainAddress, EntityId, IntegerPositiveStrict, IsoDatetime, Tag } from '../Foundations';
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type TransferNativeAsset = {
+    kind: TransferKind.Native;
+    to: BlockchainAddress;
+    amount: Amount;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type TransferErc20Asset = {
+    kind: TransferKind.Erc20;
+    contract: BlockchainAddress;
+    to: BlockchainAddress;
+    amount: Amount;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type TransferErc721Asset = {
+    kind: TransferKind.Erc721;
+    contract: BlockchainAddress;
+    to: BlockchainAddress;
+    tokenId: string;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type BroadcastTransaction = {
+    kind: TransactionKind.Transaction;
+    transaction: string;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type BroadcastEvmTransaction = {
+    kind: TransactionKind.Evm;
+    to?: BlockchainAddress;
+    value?: Amount;
+    data?: string;
+    nonce?: number;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type BroadcastEip1559Transaction = {
+    kind: TransactionKind.Eip1559;
+    to?: BlockchainAddress;
+    value?: Amount;
+    data?: string;
+    nonce?: number;
+    gasLimit?: Amount;
+    maxPriorityFeePerGas?: Amount;
+    maxFeePerGas?: Amount;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type BroadcastEvmLegacyTransaction = {
+    kind: TransactionKind.EvmLegacy;
+    to?: BlockchainAddress;
+    value?: Amount;
+    data?: string;
+    nonce?: number;
+    gasLimit?: Amount;
+    gasPrice?: Amount;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type BroadcastPsbt = {
+    kind: TransactionKind.Psbt;
+    psbt: string;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type SignHash = {
+    kind: SignatureKind.Hash;
+    hash: string;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type SignMessage = {
+    kind: SignatureKind.Message;
+    message: string;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type SignTransaction = {
+    kind: SignatureKind.Transaction;
+    transaction: string;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type Eip712Domain = {
+    name?: string;
+    version?: string;
+    chainId?: number;
+    verifyingContract?: BlockchainAddress;
+    salt?: string;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type SignEip712TypedData = {
+    kind: SignatureKind.Eip712;
+    types: Record<string, unknown>;
+    domain: Eip712Domain;
+    message: Record<string, unknown>;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type SignPsbt = {
+    kind: SignatureKind.Psbt;
+    psbt: string;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type EncryptedKeyShare = {
+    /**
+     * Base64-encoded ID of the signer where the encrypted key share comes from.
+     */
+    signerId: string;
+    /**
+     * Base64-encoded key share.
+     */
+    encryptedKeyShare: string;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type SupportedExportScheme = {
+    /**
+     * Base64-encoded ID of the signer where the encrypted key share comes from.
+     */
+    curve: KeyCurve;
+    /**
+     * Base64-encoded key share.
+     */
+    protocol: KeyProtocol;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type TransferTrc10Asset = {
+    kind: TransferKind.Trc10;
+    tokenId: string;
+    to: BlockchainAddress;
+    amount: Amount;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type TransferTrc20Asset = {
+    kind: TransferKind.Trc20;
+    contract: BlockchainAddress;
+    to: BlockchainAddress;
+    amount: Amount;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type TransferTrc721Asset = {
+    kind: TransferKind.Trc721;
+    contract: BlockchainAddress;
+    to: BlockchainAddress;
+    tokenId: string;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type Wallet = {
+    id: EntityId;
+    network: BlockchainNetwork;
+    status: WalletStatus;
+    signingKey: SigningKey;
+    address?: string;
+    name?: string;
+    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;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type SigningKey = {
+    scheme: KeyScheme;
+    curve: KeyCurve;
+    publicKey: string;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type WalletAssets = {
+    walletId: EntityId;
+    network: BlockchainNetwork;
+    assets: WalletAsset[];
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type WalletAsset = {
+    kind: BalanceKind;
+    contract?: string;
+    symbol?: string;
+    decimals: number;
+    verified?: boolean;
+    balance: Amount;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type WalletNfts = {
+    walletId: EntityId;
+    network: BlockchainNetwork;
+    nfts: WalletNft[];
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type WalletNft = {
+    kind: BalanceKind;
+    contract?: string;
+    symbol?: string;
+    verified?: boolean;
+    tokenIds: string[];
+    count: number;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type PaginatedWalletList = {
+    items: Wallet[];
+    nextPageToken?: string;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type NativeTransferEvent = {
+    kind: EventKind.NativeTransfer;
+    walletId: EntityId;
+    network: BlockchainNetwork;
+    blockNumber: number;
+    txHash: string;
+    index?: string;
+    timestamp: IsoDatetime;
+    fee?: Amount;
+    direction: TransferDirection;
+    symbol: string;
+    decimals: number;
+    verified?: boolean;
+    from: BlockchainAddress;
+    to: BlockchainAddress;
+    value: Amount;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type Erc20TransferEvent = {
+    kind: EventKind.Erc20Transfer;
+    walletId: EntityId;
+    network: BlockchainNetwork;
+    blockNumber: number;
+    txHash: string;
+    index?: string;
+    timestamp: IsoDatetime;
+    fee?: Amount;
+    direction: TransferDirection;
+    contract: BlockchainAddress;
+    symbol?: string;
+    decimals: number;
+    verified?: boolean;
+    from: BlockchainAddress;
+    to: BlockchainAddress;
+    value: Amount;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type Erc721TransferEvent = {
+    kind: EventKind.Erc721Transfer;
+    walletId: EntityId;
+    network: BlockchainNetwork;
+    blockNumber: number;
+    txHash: string;
+    index?: string;
+    timestamp: IsoDatetime;
+    fee?: Amount;
+    direction: TransferDirection;
+    contract: BlockchainAddress;
+    symbol?: string;
+    verified?: boolean;
+    from: BlockchainAddress;
+    to: BlockchainAddress;
+    tokenId: string;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type PaginatedEventHistory = {
+    walletId: EntityId;
+    network: BlockchainNetwork;
+    items: BlockchainEvent[];
+    nextPageToken?: string;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type TransferRequest = {
+    id: EntityId;
+    walletId: EntityId;
+    network: BlockchainNetwork;
+    requester: RequesterIdentity;
+    requestBody: TransferAssetBody;
+    status: TransferStatus;
+    txHash?: string;
+    fee?: Amount;
+    dateRequested: IsoDatetime;
+    datePolicyEvaluated?: IsoDatetime;
+    dateBroadcasted?: IsoDatetime;
+    dateConfirmed?: IsoDatetime;
+    reason?: string;
+    metadata: TransferRequestMetadata;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type PaginatedTransferList = {
+    walletId: EntityId;
+    items: TransferRequest[];
+    nextPageToken?: string;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type TransactionRequest = {
+    id: EntityId;
+    walletId: EntityId;
+    network: BlockchainNetwork;
+    requester: RequesterIdentity;
+    requestBody: BroadcastTransactionBody;
+    status: TransactionStatus;
+    txHash?: string;
+    fee?: Amount;
+    dateRequested: IsoDatetime;
+    datePolicyEvaluated?: IsoDatetime;
+    dateBroadcasted?: IsoDatetime;
+    dateConfirmed?: IsoDatetime;
+    reason?: string;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type PaginatedTransactionList = {
+    walletId: EntityId;
+    items: TransactionRequest[];
+    nextPageToken?: string;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type Signature = {
+    r: string;
+    s: string;
+    recid?: number;
+    encoded?: string;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type SignatureRequest = {
+    id: EntityId;
+    walletId: EntityId;
+    network: BlockchainNetwork;
+    requester: RequesterIdentity;
+    requestBody: GenerateSignatureBody;
+    signature?: Signature;
+    signatures?: Signature[];
+    signedData?: string;
+    status: SignatureStatus;
+    txHash?: string;
+    fee?: Amount;
+    dateRequested: IsoDatetime;
+    datePolicyEvaluated?: IsoDatetime;
+    dateSigned?: IsoDatetime;
+    dateConfirmed?: IsoDatetime;
+    reason?: string;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type PaginatedSignatureList = {
+    walletId: EntityId;
+    items: SignatureRequest[];
+    nextPageToken?: string;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type RequesterIdentity = {
+    userId: EntityId;
+    tokenId?: EntityId;
+    appId?: EntityId;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type TransferRequestMetadata = {
+    asset: AssetMetadata;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type AssetMetadata = {
+    symbol?: string;
+    decimals?: number;
+    verified?: boolean;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+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[];
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type DelegateWalletResult = {
+    walletId: EntityId;
+    status: string;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type CreateWalletBody = {
+    network: BlockchainNetwork;
+    /**
+     * If delayDelegation is true, the wallet will be marked as "delegable". Meaning that later, you will be able to "delegate" (transfer) this wallet's ownership to an end-user, by calling the "Delegated Wallet" endpoint .
+     */
+    delayDelegation?: string;
+    externalId?: string;
+    tags?: Tag[];
+    name?: string;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type ImportWalletBody = {
+    network: BlockchainNetwork;
+    externalId?: string;
+    tags?: Tag[];
+    name?: string;
+    minSigners: IntegerPositiveStrict;
+    protocol: KeyProtocol;
+    curve: KeyCurve;
+    encryptedKeyShares: EncryptedKeyShare[];
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+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[];
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type DelegateWalletBody = {
+    /**
+     * 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.
+     */
+    userId: EntityId;
+};
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type TransferAssetBody = TransferNativeAsset | TransferErc20Asset | TransferErc721Asset | TransferTrc10Asset | TransferTrc20Asset | TransferTrc721Asset;
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type BroadcastTransactionBody = BroadcastTransaction | BroadcastEvmTransaction | BroadcastEip1559Transaction | BroadcastEvmLegacyTransaction | BroadcastPsbt;
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type GenerateSignatureBody = SignHash | SignMessage | SignTransaction | SignEip712TypedData | SignPsbt;
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export type BlockchainEvent = NativeTransferEvent | Erc20TransferEvent | Erc721TransferEvent;
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export declare enum TransferKind {
+    Native = "Native",
+    Erc20 = "Erc20",
+    Erc721 = "Erc721",
+    Trc10 = "Trc10",
+    Trc20 = "Trc20",
+    Trc721 = "Trc721"
+}
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export declare enum TransactionKind {
+    Transaction = "Transaction",
+    Evm = "Evm",
+    Eip1559 = "Eip1559",
+    EvmLegacy = "EvmLegacy",
+    Psbt = "Psbt"
+}
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export declare enum SignatureKind {
+    Hash = "Hash",
+    Message = "Message",
+    Transaction = "Transaction",
+    Eip712 = "Eip712",
+    Psbt = "Psbt"
+}
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export declare enum WalletStatus {
+    Active = "Active",
+    Archived = "Archived"
+}
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export declare enum KeyScheme {
+    ECDSA = "ECDSA",
+    EdDSA = "EdDSA"
+}
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export declare enum KeyCurve {
+    ed25519 = "ed25519",
+    secp256k1 = "secp256k1",
+    stark = "stark"
+}
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export declare enum KeyProtocol {
+    CGGMP21 = "CGGMP21",
+    BINANCE_EDDSA = "BINANCE_EDDSA"
+}
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export declare enum BalanceKind {
+    Native = "Native",
+    Erc20 = "Erc20",
+    Erc721 = "Erc721"
+}
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export declare enum EventKind {
+    NativeTransfer = "NativeTransfer",
+    Erc20Transfer = "Erc20Transfer",
+    Erc721Transfer = "Erc721Transfer"
+}
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export declare enum TransferDirection {
+    In = "In",
+    Out = "Out"
+}
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export declare enum TransferStatus {
+    Pending = "Pending",
+    Executing = "Executing",
+    Broadcasted = "Broadcasted",
+    Confirmed = "Confirmed",
+    Failed = "Failed",
+    Rejected = "Rejected"
+}
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export declare enum TransactionStatus {
+    Pending = "Pending",
+    Executing = "Executing",
+    Broadcasted = "Broadcasted",
+    Confirmed = "Confirmed",
+    Failed = "Failed",
+    Rejected = "Rejected"
+}
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export declare enum SignatureStatus {
+    Pending = "Pending",
+    Executing = "Executing",
+    Signed = "Signed",
+    Confirmed = "Confirmed",
+    Failed = "Failed",
+    Rejected = "Rejected"
+}
+/**
+ * @deprecated import equivalent type from '@dfns/sdk/types/wallets' instead
+ */
+export declare enum BlockchainNetwork {
+    ArbitrumOne = "ArbitrumOne",
+    ArbitrumGoerli = "ArbitrumGoerli",
+    ArbitrumSepolia = "ArbitrumSepolia",
+    AvalancheC = "AvalancheC",
+    AvalancheCFuji = "AvalancheCFuji",
+    Base = "Base",
+    BaseGoerli = "BaseGoerli",
+    Bitcoin = "Bitcoin",
+    BitcoinTestnet3 = "BitcoinTestnet3",
+    Bsc = "Bsc",
+    BscTestnet = "BscTestnet",
+    Ethereum = "Ethereum",
+    EthereumGoerli = "EthereumGoerli",
+    EthereumSepolia = "EthereumSepolia",
+    FantomOpera = "FantomOpera",
+    FantomTestnet = "FantomTestnet",
+    Optimism = "Optimism",
+    OptimismGoerli = "OptimismGoerli",
+    Polygon = "Polygon",
+    PolygonMumbai = "PolygonMumbai",
+    Ripple = "Ripple",
+    RippleTestnet = "RippleTestnet",
+    Solana = "Solana",
+    SolanaDevnet = "SolanaDevnet",
+    Tezos = "Tezos",
+    TezosGhostnet = "TezosGhostnet",
+    Tron = "Tron",
+    TronNile = "TronNile",
+    KeyECDSA = "KeyECDSA",
+    KeyEdDSA = "KeyEdDSA",
+    KeyECDSAStark = "KeyECDSAStark"
+}