@venly/venly-core-sdk
Version:
Javascrip/Typescript SDK for Venly's Web3 Services
2,530 lines • 203 kB
TypeScript
import { Any } from '../../helpers/json';
import * as enums from '../enums/index';
import * as shared from '../shared/index';
/**
*
*/
export declare class VyHealthCheckWalletResponse {
/**
* Indicates the status of API services as either `UP` or `DOWN`.
* @type {string}
*/
status?: string;
constructor(initializer?: VyHealthCheckWalletResponse);
}
export interface IVySigningMethodBaseProps {
/**
* The signing method `ID`
* @type {string}
*/
id?: string;
/**
* The number of incorrect signing method attempts
* @type {number}
*/
incorrectAttempts?: number;
/**
* The number of remaining signing method attempts left
* @type {number}
*/
remainingAttempts?: number;
/**
* Last time when signing method was used successfully
* @type {Date}
*/
lastUsedSuccess?: Date;
/**
* Indicates if the user has a master secret
* @type {boolean}
*/
hasMasterSecret?: boolean;
}
/**
*
*/
export declare class VySigningMethodBase {
/**
* The signing method `ID`
* @type {string}
*/
id?: string;
/**
* The type of signing method
* @type {VySigningMethodType}
*/
type: enums.VySigningMethodType;
/**
* The number of incorrect signing method attempts
* @type {number}
*/
incorrectAttempts?: number;
/**
* The number of remaining signing method attempts left
* @type {number}
*/
remainingAttempts?: number;
/**
* Last time when signing method was used successfully
* @type {Date}
*/
lastUsedSuccess?: Date;
/**
* Indicates if the user has a master secret
* @type {boolean}
*/
hasMasterSecret?: boolean;
constructor(_type?: enums.VySigningMethodType, initializer?: VySigningMethodBase);
}
/**
*
*/
export declare class VyUserDto {
/**
* The user `ID`
* @type {string}
*/
id?: string;
/**
* Reference description of the user
* @type {string}
*/
reference?: string;
/**
* The date and time when user was created
* @type {Date}
*/
createdAt?: Date;
/**
* Information about user's signing methods
* @type {VySigningMethodBase[]}
*/
signingMethods?: VySigningMethodBase[];
constructor(initializer?: VyUserDto);
}
/**
*
*/
export declare class VySigningMethodOneOf {
constructor(initializer?: VySigningMethodOneOf);
}
export interface IVyBiometricSigningMethodDtoProps extends IVySigningMethodBaseProps {
/**
*
* @type {string}
*/
physicalDeviceId?: string;
}
/**
*
*/
export declare class VyBiometricSigningMethodDto extends VySigningMethodBase {
/**
*
* @type {string}
*/
physicalDeviceId?: string;
constructor(initializer?: IVyBiometricSigningMethodDtoProps);
}
export interface IVyEmergencyCodeSigningMethodDtoProps extends IVySigningMethodBaseProps {
/**
*
* @type {string}
*/
value?: string;
}
/**
*
*/
export declare class VyEmergencyCodeSigningMethodDto extends VySigningMethodBase {
/**
*
* @type {string}
*/
value?: string;
constructor(initializer?: IVyEmergencyCodeSigningMethodDtoProps);
}
export interface IVyPinSigningMethodDtoProps extends IVySigningMethodBaseProps {
}
/**
*
*/
export declare class VyPinSigningMethodDto extends VySigningMethodBase {
constructor(initializer?: IVyPinSigningMethodDtoProps);
}
export interface IVyCreateSigningMethodRequestBaseProps {
}
/**
*
*/
export declare class VyCreateSigningMethodRequestBase {
/**
* The singing-method Type (PIN/BIOMETRIC/EMERGENCY_CODE)
* @type {VySigningMethodType}
*/
type: enums.VySigningMethodType;
constructor(_type?: enums.VySigningMethodType, initializer?: VyCreateSigningMethodRequestBase);
}
/**
*
*/
export declare class VyCreateUserDto {
/**
* A keyword to identify or group your users together. This can be used later to filter out specific users based on this reference
* @type {string}
*/
reference?: string;
/**
*
* @type {VyCreateSigningMethodRequestBase}
*/
signingMethod?: VyCreateSigningMethodRequestBase;
constructor(initializer?: VyCreateUserDto);
}
/**
*
*/
export declare class VyCreateSigningMethodRequestOneOf {
constructor(initializer?: VyCreateSigningMethodRequestOneOf);
}
export interface IVyCreatePinSigningMethodRequestProps extends IVyCreateSigningMethodRequestBaseProps {
/**
* The pincode value. (6 digits in case of `PIN`)
* @type {string}
*/
value?: string;
}
/**
*
*/
export declare class VyCreatePinSigningMethodRequest extends VyCreateSigningMethodRequestBase {
/**
* The pincode value. (6 digits in case of `PIN`)
* @type {string}
*/
value?: string;
constructor(initializer?: IVyCreatePinSigningMethodRequestProps);
}
export interface IVyCreateEmergencyCodeSigningMethodRequestProps extends IVyCreateSigningMethodRequestBaseProps {
/**
* The emergency code value. (25 characters in case of `EMERGENCY_CODE`) This field can be left empty for the system to auto-generate an emergecy code for you.
* @type {string}
*/
value?: string;
}
/**
*
*/
export declare class VyCreateEmergencyCodeSigningMethodRequest extends VyCreateSigningMethodRequestBase {
/**
* The emergency code value. (25 characters in case of `EMERGENCY_CODE`) This field can be left empty for the system to auto-generate an emergecy code for you.
* @type {string}
*/
value?: string;
constructor(initializer?: IVyCreateEmergencyCodeSigningMethodRequestProps);
}
export interface IVyCreateBiometricSigningMethodRequestProps extends IVyCreateSigningMethodRequestBaseProps {
/**
* The value of the biometrics you want to set up (for example, Face ID or Touch ID)
* @type {string}
*/
value?: string;
/**
* The unique ID of the user's device
* @type {number}
*/
physicalDeviceId?: number;
}
/**
*
*/
export declare class VyCreateBiometricSigningMethodRequest extends VyCreateSigningMethodRequestBase {
/**
* The value of the biometrics you want to set up (for example, Face ID or Touch ID)
* @type {string}
*/
value?: string;
/**
* The unique ID of the user's device
* @type {number}
*/
physicalDeviceId?: number;
constructor(initializer?: IVyCreateBiometricSigningMethodRequestProps);
}
/**
*
*/
export declare class VyUpdateUserReferenceDto {
/**
* The new `reference` of the user
* @type {string}
*/
reference?: string;
constructor(initializer?: VyUpdateUserReferenceDto);
}
/**
*
*/
export declare class VyUpdateSigningMethodRequest {
/**
* The new value for the signing method.
* @type {string}
*/
value?: string;
constructor(initializer?: VyUpdateSigningMethodRequest);
}
/**
*
*/
export declare class VyWalletNativeBalanceDto {
/**
* Indicates whether the balance check was successful or not
* @type {boolean}
*/
available?: boolean;
/**
* Type of blockchain
* @type {VyChain}
*/
chain?: enums.VyChain;
/**
* Normalized balance of the native token
* @type {number}
*/
balance?: number;
/**
* Normalized balance of the gas token (same as `balance` when the token for paying gas/fees is the same native token)
* @type {number}
*/
gasBalance?: number;
/**
* Symbol of the native token
* @type {string}
*/
symbol?: string;
/**
* Symbol of the gas token
* @type {string}
*/
gasSymbol?: string;
/**
* Raw balance of the native token
* @type {string}
*/
rawBalance?: string;
/**
* Raw balance of the gas token
* @type {string}
*/
rawGasBalance?: string;
/**
* Number of decimals of the native token
* @type {number}
*/
decimals?: number;
constructor(initializer?: VyWalletNativeBalanceDto);
}
/**
*
*/
export declare class VyWalletDto {
/**
*
* @type {string}
*/
id?: string;
/**
*
* @type {string}
*/
secretId?: string;
/**
*
* @type {string}
*/
address?: string;
/**
*
* @type {VyChain}
*/
chain: enums.VyChain;
/**
*
* @type {String}
*/
readonly walletType: String;
/**
*
* @type {string}
*/
userId?: string;
/**
*
* @type {Date}
*/
createdAt?: Date;
/**
*
* @type {string}
*/
createdBy?: string;
/**
*
* @type {boolean}
*/
archived?: boolean;
/**
*
* @type {boolean}
*/
primary?: boolean;
/**
*
* @type {string}
*/
description?: string;
/**
*
* @type {boolean}
*/
hasCustomPin?: boolean;
/**
*
* @type {string}
*/
pincode?: string;
/**
*
* @type {number}
*/
pincodeTries?: number;
/**
*
* @type {boolean}
*/
imported?: boolean;
/**
*
* @type {boolean}
*/
exported?: boolean;
/**
*
* @type {Date}
*/
importTimestamp?: Date;
/**
*
* @type {Date}
*/
lastExportTimestamp?: Date;
/**
*
* @type {string[]}
*/
clients?: string[];
/**
*
* @type {boolean}
*/
linkable?: boolean;
/**
*
* @type {string}
*/
identifier?: string;
/**
*
* @type {boolean}
*/
custodial?: boolean;
/**
*
* @type {VyWalletNativeBalanceDto}
*/
balance?: VyWalletNativeBalanceDto;
constructor(initializer?: VyWalletDto);
}
/**
*
*/
export declare class VyUpdateWalletDto {
/**
* Update the description of the wallet
* @type {string}
*/
description?: string;
/**
*
* @type {boolean}
*/
primary?: boolean;
/**
* Flag to indicate if the wallet is archived or not
* @type {boolean}
*/
archived?: boolean;
constructor(initializer?: VyUpdateWalletDto);
}
/**
*
*/
export declare class VyCreateApiWalletRequest {
/**
* The pin that will encrypt and decrypt the wallet
* @deprecated This property will be removed in a future release
* @type {string}
*/
pincode?: string;
/**
* A description to describe the wallet
* @type {string}
*/
description?: string;
/**
* The blockchain on which to create the wallet
* @type {VyChain}
*/
chain?: enums.VyChain;
/**
* The `ID` of the user who you want to link this wallet to
* @type {string}
*/
userId?: string;
/**
* Add a custom identifier to group wallets or to add a unique external id. This makes searching for wallets easier.
* @type {string}
*/
identifier?: string;
constructor(initializer?: VyCreateApiWalletRequest);
}
/**
*
*/
export declare class VyExportWalletDto {
/**
* The PINCODE of the wallet
* @deprecated This property will be removed in a future release
* @type {string}
*/
pincode?: string;
/**
* A custom password to secure the keystore
* @type {string}
*/
password?: string;
constructor(initializer?: VyExportWalletDto);
}
/**
*
*/
export declare class VyExportWalletResultDto {
/**
* JSON file that represents the wallet (warning: this is a string field so make sure the JSON body is escaped properly)
* @type {string}
*/
keystore?: string;
/**
* The password of the keystore
* @type {string}
*/
privateKey?: string;
constructor(initializer?: VyExportWalletResultDto);
}
/**
*
*/
export declare class VyWalletImportRequestOneOf {
constructor(initializer?: VyWalletImportRequestOneOf);
}
export interface IVyWalletImportRequestBaseProps {
/**
*
* @type {String}
*/
walletType: String;
/**
* The PINCODE of the wallet
* @deprecated This property will be removed in a future release
* @type {string}
*/
pincode?: string;
/**
*
* @type {string[]}
*/
clients?: string[];
/**
*
* @type {string}
*/
userId?: string;
/**
*
* @type {boolean}
*/
custodial?: boolean;
}
/**
*
*/
export declare class VyWalletImportRequestBase {
/**
* Type of import. [Click here to view all import types](https://docs.venly.io/docs/import-a-wallet#import-wallet-types).
* @type {VyImportWalletType}
*/
importWalletType: enums.VyImportWalletType;
/**
*
* @type {String}
*/
readonly walletType: String;
/**
* The PINCODE of the wallet
* @deprecated This property will be removed in a future release
* @type {string}
*/
pincode?: string;
/**
*
* @type {string[]}
*/
clients?: string[];
/**
*
* @type {string}
*/
userId?: string;
/**
*
* @type {boolean}
*/
custodial?: boolean;
constructor(_importWalletType?: enums.VyImportWalletType, initializer?: VyWalletImportRequestBase);
}
export interface IVyAeternityKeystoreImportDtoProps extends IVyWalletImportRequestBaseProps {
/**
*
* @type {string}
*/
keystore?: string;
/**
*
* @type {string}
*/
password?: string;
}
/**
*
*/
export declare class VyAeternityKeystoreImportDto extends VyWalletImportRequestBase {
/**
*
* @type {string}
*/
keystore?: string;
/**
*
* @type {string}
*/
password?: string;
constructor(initializer?: IVyAeternityKeystoreImportDtoProps);
}
export interface IVyAeternityPrivateKeyImportDtoProps extends IVyWalletImportRequestBaseProps {
/**
*
* @type {string}
*/
privateKey?: string;
}
/**
*
*/
export declare class VyAeternityPrivateKeyImportDto extends VyWalletImportRequestBase {
/**
*
* @type {string}
*/
privateKey?: string;
constructor(initializer?: IVyAeternityPrivateKeyImportDtoProps);
}
export interface IVyArbitrumKeystoreImportDtoProps extends IVyWalletImportRequestBaseProps {
/**
*
* @type {string}
*/
keystore?: string;
/**
*
* @type {string}
*/
password?: string;
}
/**
*
*/
export declare class VyArbitrumKeystoreImportDto extends VyWalletImportRequestBase {
/**
*
* @type {string}
*/
keystore?: string;
/**
*
* @type {string}
*/
password?: string;
constructor(initializer?: IVyArbitrumKeystoreImportDtoProps);
}
export interface IVyArbitrumPrivateKeyImportDtoProps extends IVyWalletImportRequestBaseProps {
/**
*
* @type {string}
*/
privateKey?: string;
}
/**
*
*/
export declare class VyArbitrumPrivateKeyImportDto extends VyWalletImportRequestBase {
/**
*
* @type {string}
*/
privateKey?: string;
constructor(initializer?: IVyArbitrumPrivateKeyImportDtoProps);
}
export interface IVyAvacKeystoreImportDtoProps extends IVyWalletImportRequestBaseProps {
/**
*
* @type {string}
*/
keystore?: string;
/**
*
* @type {string}
*/
password?: string;
}
/**
*
*/
export declare class VyAvacKeystoreImportDto extends VyWalletImportRequestBase {
/**
*
* @type {string}
*/
keystore?: string;
/**
*
* @type {string}
*/
password?: string;
constructor(initializer?: IVyAvacKeystoreImportDtoProps);
}
export interface IVyAvacPrivateKeyImportDtoProps extends IVyWalletImportRequestBaseProps {
/**
*
* @type {string}
*/
privateKey?: string;
}
/**
*
*/
export declare class VyAvacPrivateKeyImportDto extends VyWalletImportRequestBase {
/**
*
* @type {string}
*/
privateKey?: string;
constructor(initializer?: IVyAvacPrivateKeyImportDtoProps);
}
export interface IVyBaseKeystoreImportRequestProps extends IVyWalletImportRequestBaseProps {
/**
*
* @type {string}
*/
keystore?: string;
/**
*
* @type {string}
*/
password?: string;
}
/**
*
*/
export declare class VyBaseKeystoreImportRequest extends VyWalletImportRequestBase {
/**
*
* @type {string}
*/
keystore?: string;
/**
*
* @type {string}
*/
password?: string;
constructor(initializer?: IVyBaseKeystoreImportRequestProps);
}
export interface IVyBasePrivateKeyImportRequestProps extends IVyWalletImportRequestBaseProps {
/**
*
* @type {string}
*/
privateKey?: string;
}
/**
*
*/
export declare class VyBasePrivateKeyImportRequest extends VyWalletImportRequestBase {
/**
*
* @type {string}
*/
privateKey?: string;
constructor(initializer?: IVyBasePrivateKeyImportRequestProps);
}
export interface IVyBitcoinWifImportDtoProps extends IVyWalletImportRequestBaseProps {
/**
*
* @type {string}
*/
wif?: string;
}
/**
*
*/
export declare class VyBitcoinWifImportDto extends VyWalletImportRequestBase {
/**
*
* @type {string}
*/
wif?: string;
constructor(initializer?: IVyBitcoinWifImportDtoProps);
}
export interface IVyBitcoinWifPassphraseImportDtoProps extends IVyWalletImportRequestBaseProps {
/**
*
* @type {string}
*/
wif?: string;
/**
*
* @type {string}
*/
passphrase?: string;
}
/**
*
*/
export declare class VyBitcoinWifPassphraseImportDto extends VyWalletImportRequestBase {
/**
*
* @type {string}
*/
wif?: string;
/**
*
* @type {string}
*/
passphrase?: string;
constructor(initializer?: IVyBitcoinWifPassphraseImportDtoProps);
}
export interface IVyBscKeystoreImportDtoProps extends IVyWalletImportRequestBaseProps {
/**
*
* @type {string}
*/
keystore?: string;
/**
*
* @type {string}
*/
password?: string;
}
/**
*
*/
export declare class VyBscKeystoreImportDto extends VyWalletImportRequestBase {
/**
*
* @type {string}
*/
keystore?: string;
/**
*
* @type {string}
*/
password?: string;
constructor(initializer?: IVyBscKeystoreImportDtoProps);
}
export interface IVyBscPrivateKeyImportDtoProps extends IVyWalletImportRequestBaseProps {
/**
*
* @type {string}
*/
privateKey?: string;
}
/**
*
*/
export declare class VyBscPrivateKeyImportDto extends VyWalletImportRequestBase {
/**
*
* @type {string}
*/
privateKey?: string;
constructor(initializer?: IVyBscPrivateKeyImportDtoProps);
}
export interface IVyEthereumKeystoreImportDtoProps extends IVyWalletImportRequestBaseProps {
/**
*
* @type {string}
*/
keystore?: string;
/**
*
* @type {string}
*/
password?: string;
}
/**
*
*/
export declare class VyEthereumKeystoreImportDto extends VyWalletImportRequestBase {
/**
*
* @type {string}
*/
keystore?: string;
/**
*
* @type {string}
*/
password?: string;
constructor(initializer?: IVyEthereumKeystoreImportDtoProps);
}
export interface IVyEthereumPrivateKeyImportDtoProps extends IVyWalletImportRequestBaseProps {
/**
*
* @type {string}
*/
privateKey?: string;
}
/**
*
*/
export declare class VyEthereumPrivateKeyImportDto extends VyWalletImportRequestBase {
/**
*
* @type {string}
*/
privateKey?: string;
constructor(initializer?: IVyEthereumPrivateKeyImportDtoProps);
}
export interface IVyGochainKeystoreImportDtoProps extends IVyWalletImportRequestBaseProps {
/**
*
* @type {string}
*/
keystore?: string;
/**
*
* @type {string}
*/
password?: string;
}
/**
*
*/
export declare class VyGochainKeystoreImportDto extends VyWalletImportRequestBase {
/**
*
* @type {string}
*/
keystore?: string;
/**
*
* @type {string}
*/
password?: string;
constructor(initializer?: IVyGochainKeystoreImportDtoProps);
}
export interface IVyGochainPrivateKeyImportDtoProps extends IVyWalletImportRequestBaseProps {
/**
*
* @type {string}
*/
privateKey?: string;
}
/**
*
*/
export declare class VyGochainPrivateKeyImportDto extends VyWalletImportRequestBase {
/**
*
* @type {string}
*/
privateKey?: string;
constructor(initializer?: IVyGochainPrivateKeyImportDtoProps);
}
export interface IVyHederaKeystoreImportDtoProps extends IVyWalletImportRequestBaseProps {
/**
*
* @type {string}
*/
keystore?: string;
/**
*
* @type {string}
*/
password?: string;
}
/**
*
*/
export declare class VyHederaKeystoreImportDto extends VyWalletImportRequestBase {
/**
*
* @type {string}
*/
keystore?: string;
/**
*
* @type {string}
*/
password?: string;
constructor(initializer?: IVyHederaKeystoreImportDtoProps);
}
export interface IVyHederaPrivateKeyImportDtoProps extends IVyWalletImportRequestBaseProps {
/**
*
* @type {string}
*/
privateKey?: string;
}
/**
*
*/
export declare class VyHederaPrivateKeyImportDto extends VyWalletImportRequestBase {
/**
*
* @type {string}
*/
privateKey?: string;
constructor(initializer?: IVyHederaPrivateKeyImportDtoProps);
}
export interface IVyImxKeystoreImportDtoProps extends IVyWalletImportRequestBaseProps {
/**
*
* @type {string}
*/
keystore?: string;
/**
*
* @type {string}
*/
password?: string;
}
/**
*
*/
export declare class VyImxKeystoreImportDto extends VyWalletImportRequestBase {
/**
*
* @type {string}
*/
keystore?: string;
/**
*
* @type {string}
*/
password?: string;
constructor(initializer?: IVyImxKeystoreImportDtoProps);
}
export interface IVyImxPrivateKeyImportDtoProps extends IVyWalletImportRequestBaseProps {
/**
*
* @type {string}
*/
privateKey?: string;
}
/**
*
*/
export declare class VyImxPrivateKeyImportDto extends VyWalletImportRequestBase {
/**
*
* @type {string}
*/
privateKey?: string;
constructor(initializer?: IVyImxPrivateKeyImportDtoProps);
}
export interface IVyLitecoinWifImportDtoProps extends IVyWalletImportRequestBaseProps {
/**
*
* @type {string}
*/
wif?: string;
}
/**
*
*/
export declare class VyLitecoinWifImportDto extends VyWalletImportRequestBase {
/**
*
* @type {string}
*/
wif?: string;
constructor(initializer?: IVyLitecoinWifImportDtoProps);
}
export interface IVyMaticKeystoreImportDtoProps extends IVyWalletImportRequestBaseProps {
/**
*
* @type {string}
*/
keystore?: string;
/**
*
* @type {string}
*/
password?: string;
}
/**
*
*/
export declare class VyMaticKeystoreImportDto extends VyWalletImportRequestBase {
/**
*
* @type {string}
*/
keystore?: string;
/**
*
* @type {string}
*/
password?: string;
constructor(initializer?: IVyMaticKeystoreImportDtoProps);
}
export interface IVyMaticPrivateKeyImportDtoProps extends IVyWalletImportRequestBaseProps {
/**
*
* @type {string}
*/
privateKey?: string;
}
/**
*
*/
export declare class VyMaticPrivateKeyImportDto extends VyWalletImportRequestBase {
/**
*
* @type {string}
*/
privateKey?: string;
constructor(initializer?: IVyMaticPrivateKeyImportDtoProps);
}
export interface IVyNeoKeystoreImportDtoProps extends IVyWalletImportRequestBaseProps {
/**
*
* @type {string}
*/
keystore?: string;
/**
*
* @type {string}
*/
password?: string;
}
/**
*
*/
export declare class VyNeoKeystoreImportDto extends VyWalletImportRequestBase {
/**
*
* @type {string}
*/
keystore?: string;
/**
*
* @type {string}
*/
password?: string;
constructor(initializer?: IVyNeoKeystoreImportDtoProps);
}
export interface IVyNeoPrivateKeyImportDtoProps extends IVyWalletImportRequestBaseProps {
/**
*
* @type {string}
*/
privateKey?: string;
}
/**
*
*/
export declare class VyNeoPrivateKeyImportDto extends VyWalletImportRequestBase {
/**
*
* @type {string}
*/
privateKey?: string;
constructor(initializer?: IVyNeoPrivateKeyImportDtoProps);
}
export interface IVyNeoWifImportDtoProps extends IVyWalletImportRequestBaseProps {
/**
*
* @type {string}
*/
wif?: string;
}
/**
*
*/
export declare class VyNeoWifImportDto extends VyWalletImportRequestBase {
/**
*
* @type {string}
*/
wif?: string;
constructor(initializer?: IVyNeoWifImportDtoProps);
}
export interface IVyVechainKeystoreImportDtoProps extends IVyWalletImportRequestBaseProps {
/**
*
* @type {string}
*/
keystore?: string;
/**
*
* @type {string}
*/
password?: string;
}
/**
*
*/
export declare class VyVechainKeystoreImportDto extends VyWalletImportRequestBase {
/**
*
* @type {string}
*/
keystore?: string;
/**
*
* @type {string}
*/
password?: string;
constructor(initializer?: IVyVechainKeystoreImportDtoProps);
}
export interface IVyVechainPrivateKeyImportDtoProps extends IVyWalletImportRequestBaseProps {
/**
*
* @type {string}
*/
privateKey?: string;
}
/**
*
*/
export declare class VyVechainPrivateKeyImportDto extends VyWalletImportRequestBase {
/**
*
* @type {string}
*/
privateKey?: string;
constructor(initializer?: IVyVechainPrivateKeyImportDtoProps);
}
export interface IVyWalletMigrationImportDtoProps extends IVyWalletImportRequestBaseProps {
/**
*
* @type {string}
*/
walletId?: string;
/**
*
* @type {enums.VyChain}
*/
to?: enums.VyChain;
}
/**
*
*/
export declare class VyWalletMigrationImportDto extends VyWalletImportRequestBase {
/**
*
* @type {string}
*/
walletId?: string;
/**
*
* @type {VyChain}
*/
to?: enums.VyChain;
constructor(initializer?: IVyWalletMigrationImportDtoProps);
}
export interface IVyXplaKeystoreImportRequestProps extends IVyWalletImportRequestBaseProps {
/**
*
* @type {string}
*/
keystore?: string;
/**
*
* @type {string}
*/
password?: string;
}
/**
*
*/
export declare class VyXplaKeystoreImportRequest extends VyWalletImportRequestBase {
/**
*
* @type {string}
*/
keystore?: string;
/**
*
* @type {string}
*/
password?: string;
constructor(initializer?: IVyXplaKeystoreImportRequestProps);
}
export interface IVyXplaPrivateKeyImportRequestProps extends IVyWalletImportRequestBaseProps {
/**
*
* @type {string}
*/
privateKey?: string;
}
/**
*
*/
export declare class VyXplaPrivateKeyImportRequest extends VyWalletImportRequestBase {
/**
*
* @type {string}
*/
privateKey?: string;
constructor(initializer?: IVyXplaPrivateKeyImportRequestProps);
}
/**
*
*/
export declare class VyValidWalletAddressDto {
/**
* Indicates if the format of the wallet adress is correct or not
* @type {boolean}
*/
valid?: boolean;
constructor(initializer?: VyValidWalletAddressDto);
}
/**
*
*/
export declare class VyWalletEventDto {
/**
*
* @type {Date}
*/
eventTimestamp?: Date;
/**
*
* @type {string}
*/
client?: string;
/**
*
* @type {string}
*/
apiToken?: string;
/**
*
* @type {VyWalletEventType}
*/
type?: enums.VyWalletEventType;
/**
*
* @type {string}
*/
metadata?: string;
/**
*
* @type {string}
*/
walletId?: string;
constructor(initializer?: VyWalletEventDto);
}
/**
*
*/
export declare class VyTokenExchange {
/**
* The price in USD for one token
* @type {BigInt}
*/
usdPrice?: BigInt;
/**
* The total price of all tokens in USD
* @type {BigInt}
*/
usdBalanceValue?: BigInt;
constructor(initializer?: VyTokenExchange);
}
/**
*
*/
export declare class VyErc20TokenDto {
/**
* Address of the token
* @type {string}
*/
tokenAddress?: string;
/**
* Raw token balance
* @type {string}
*/
rawBalance?: string;
/**
* Normalized token balance
* @type {number}
*/
balance?: number;
/**
* Decimals of the token
* @type {number}
*/
decimals?: number;
/**
* The symbol of the token
* @type {string}
*/
symbol?: string;
/**
* Logo of the token(url)
* @type {string}
*/
logo?: string;
/**
* The type of token, which depends on the specific blockchain
* @type {string}
*/
type?: string;
/**
* Indicates whether or not the token can be transferred
* @type {boolean}
*/
transferable?: boolean;
/**
* Name of the token
* @type {string}
*/
name?: string;
/**
* Indicates if the token is possibly a spam
* @type {boolean}
*/
possibleSpam?: boolean;
/**
*
* @type {VyTokenExchange}
*/
exchange?: VyTokenExchange;
/**
* The categories under which the token falls.
* @type {string[]}
*/
categories?: string[];
/**
* Social links such as Website, Facebook, YouTube, etc.
* @type {Any}
*/
links?: Any;
/**
* The URL to the token's thumbnail image
* @type {string}
*/
thumbnail?: string;
/**
* The percentage of the token's value relative to the total portfolio value
* @type {number}
*/
portfolioPercentage?: number;
constructor(initializer?: VyErc20TokenDto);
}
/**
*
*/
export declare class VyHederaTokenAssociationDto {
/**
* The public wallet address
* @type {string}
*/
address?: string;
/**
* Number of max auto - associations. (Without needing to associate the token first)
* @type {BigInt}
*/
maxTokenAutoAssociations?: BigInt;
/**
* List of associated tokens with your wallet address
* @type {string[]}
*/
tokens?: string[];
constructor(initializer?: VyHederaTokenAssociationDto);
}
export interface IVyTransactionRequestBaseProps {
/**
* The transaction `ID`
* @type {string}
*/
id?: string;
/**
* The wallet `ID` that executed the tx
* @type {string}
*/
walletId?: string;
/**
*
* @deprecated This property will be removed in a future release
* @type {string}
*/
pincode?: string;
/**
* The status of transaction
* @type {enums.VyTransactionRequestState}
*/
status?: enums.VyTransactionRequestState;
}
/**
*
*/
export declare class VyTransactionRequestBase {
/**
* The transaction `ID`
* @type {string}
*/
id?: string;
/**
* The wallet `ID` that executed the tx
* @type {string}
*/
walletId?: string;
/**
*
* @deprecated This property will be removed in a future release
* @type {string}
*/
pincode?: string;
/**
* The type of transaction
* @type {VyTransactionRequestType}
*/
type: enums.VyTransactionRequestType;
/**
* The status of transaction
* @type {VyTransactionRequestState}
*/
status?: enums.VyTransactionRequestState;
constructor(_type?: enums.VyTransactionRequestType, initializer?: VyTransactionRequestBase);
}
/**
*
*/
export declare class VyGetAll1Response {
/**
*
* @type {Date}
*/
expiresAt?: Date;
/**
* The date-time when the transaction was created
* @type {Date}
*/
createdAt?: Date;
/**
*
* @type {VyTransactionRequestBase}
*/
transactionRequest?: VyTransactionRequestBase;
/**
* The transaction hash
* @type {string}
*/
transactionHash?: string;
/**
*
* @type {string}
*/
originId?: string;
/**
*
* @deprecated This property will be removed in a future release
* @type {string}
*/
resubmittedTransactionId?: string;
/**
*
* @type {string}
*/
replacedBy?: string;
constructor(initializer?: VyGetAll1Response);
}
export interface IVyBuildTransactionRequestBaseProps {
/**
* The wallet `ID`
* @type {string}
*/
walletFromId?: string;
/**
* The destination wallet address
* @type {string}
*/
toAddress?: string;
/**
* The blockchain of the transaction
* @type {enums.VyChain}
*/
chain?: enums.VyChain;
}
/**
*
*/
export declare class VyBuildTransactionRequestBase {
/**
* The wallet `ID`
* @type {string}
*/
walletFromId?: string;
/**
* The destination wallet address
* @type {string}
*/
toAddress?: string;
/**
* The blockchain of the transaction
* @type {VyChain}
*/
chain?: enums.VyChain;
/**
* The type of transfer.
* @type {VyBuildTransactionRequestType}
*/
type: enums.VyBuildTransactionRequestType;
constructor(_type?: enums.VyBuildTransactionRequestType, initializer?: VyBuildTransactionRequestBase);
}
/**
*
*/
export declare class VyBuildAndExecuteTransactionDto {
/**
* The **PINCODE** of the wallet
* @deprecated This property will be removed in a future release
* @type {string}
*/
pincode?: string;
/**
*
* @type {VyBuildTransactionRequestBase}
*/
transactionRequest?: VyBuildTransactionRequestBase;
constructor(initializer?: VyBuildAndExecuteTransactionDto);
}
/**
*
*/
export declare class VyBuildTransactionRequestOneOf {
constructor(initializer?: VyBuildTransactionRequestOneOf);
}
/**
*
*/
export declare class VyContractInputParamDto {
/**
* Type of the input parameter (ex. uint256)
* @type {string}
*/
type?: string;
/**
*
* @type {Any}
*/
value?: Any;
constructor(initializer?: VyContractInputParamDto);
}
/**
*
*/
export declare class VyChainSpecificFieldsBase {
constructor(initializer?: VyChainSpecificFieldsBase);
}
/**
*
*/
export declare class VyChainSpecificFieldsEvmChains extends VyChainSpecificFieldsBase {
/**
* Total units of gas (optional, will be calculated by the system if not supplied)
* @type {BigInt}
*/
gas?: BigInt;
/**
* The gas price in `wei` (optional, will be calculated by the system if not supplied)
* @type {BigInt}
*/
gasPrice?: BigInt;
constructor(initializer?: VyChainSpecificFieldsEvmChains);
}
export interface IVyBuildContractExecutionTransactionRequestProps extends IVyBuildTransactionRequestBaseProps {
/**
* The name of the function you want to call
* @type {string}
*/
functionName?: string;
/**
*
* @type {number}
*/
value?: number;
/**
* Array of inputs needed to call the function
* @type {VyContractInputParamDto[]}
*/
inputs?: VyContractInputParamDto[];
/**
*
* @type {VyChainSpecificFieldsEvmChains}
*/
chainSpecificFields?: VyChainSpecificFieldsEvmChains;
}
/**
*
*/
export declare class VyBuildContractExecutionTransactionRequest extends VyBuildTransactionRequestBase {
/**
* The name of the function you want to call
* @type {string}
*/
functionName?: string;
/**
*
* @type {number}
*/
value?: number;
/**
* Array of inputs needed to call the function
* @type {VyContractInputParamDto[]}
*/
inputs?: VyContractInputParamDto[];
/**
*
* @type {VyChainSpecificFieldsEvmChains}
*/
chainSpecificFields?: VyChainSpecificFieldsEvmChains;
constructor(initializer?: IVyBuildContractExecutionTransactionRequestProps);
}
export interface IVyBuildGasTransferTransactionRequestProps extends IVyBuildTransactionRequestBaseProps {
/**
* The amount of gas you want to transfer
* @type {number}
*/
value?: number;
/**
*
* @type {VyChainSpecificFieldsEvmChains}
*/
chainSpecificFields?: VyChainSpecificFieldsEvmChains;
}
/**
*
*/
export declare class VyBuildGasTransferTransactionRequest extends VyBuildTransactionRequestBase {
/**
* The amount of gas you want to transfer
* @type {number}
*/
value?: number;
/**
*
* @type {VyChainSpecificFieldsEvmChains}
*/
chainSpecificFields?: VyChainSpecificFieldsEvmChains;
constructor(initializer?: IVyBuildGasTransferTransactionRequestProps);
}
/**
*
*/
export declare class VyChainSpecificFieldsHedera extends VyChainSpecificFieldsBase {
/**
* A memo that can be used with a transaction
* @type {string}
*/
transactionMemo?: string;
constructor(initializer?: VyChainSpecificFieldsHedera);
}
export interface IVyBuildMultiTransferTransactionRequestProps extends IVyBuildTransactionRequestBaseProps {
/**
*
* @type {VyChainSpecificFieldsHedera}
*/
chainSpecificFields?: VyChainSpecificFieldsHedera;
/**
* Define multiple transfers here
* @type {VyBuildTransactionRequestBase[]}
*/
transfers?: VyBuildTransactionRequestBase[];
}
/**
*
*/
export declare class VyBuildMultiTransferTransactionRequest extends VyBuildTransactionRequestBase {
/**
*
* @type {VyChainSpecificFieldsHedera}
*/
chainSpecificFields?: VyChainSpecificFieldsHedera;
/**
* Define multiple transfers here
* @type {VyBuildTransactionRequestBase[]}
*/
transfers?: VyBuildTransactionRequestBase[];
constructor(initializer?: IVyBuildMultiTransferTransactionRequestProps);
}
/**
*
*/
export declare class VyWalletAnyOfBuildTransactionRequestBase1 {
constructor(initializer?: VyWalletAnyOfBuildTransactionRequestBase1);
}
export interface IVyBuildNftTransferTransactionRequestProps extends IVyBuildTransactionRequestBaseProps {
/**
* The `contract address` of the NFT
* @type {string}
*/
tokenContractAddress?: string;
/**
* The token `ID` of the NFT
* @type {number}
*/
tokenId?: number;
/**
*
* @type {VyChainSpecificFieldsEvmChains}
*/
chainSpecificFields?: VyChainSpecificFieldsEvmChains;
}
/**
*
*/
export declare class VyBuildNftTransferTransactionRequest extends VyBuildTransactionRequestBase {
/**
* The `contract address` of the NFT
* @type {string}
*/
tokenContractAddress?: string;
/**
* The token `ID` of the NFT
* @type {number}
*/
tokenId?: number;
/**
*
* @type {VyChainSpecificFieldsEvmChains}
*/
chainSpecificFields?: VyChainSpecificFieldsEvmChains;
constructor(initializer?: IVyBuildNftTransferTransactionRequestProps);
}
export interface IVyBuildTokenTransferTransactionRequestProps extends IVyBuildTransactionRequestBaseProps {
/**
* Token contract address of the token
* @type {string}
*/
tokenAddress?: string;
/**
* Amount you want to transfer
* @type {number}
*/
value?: number;
/**
*
* @type {VyChainSpecificFieldsEvmChains}
*/
chainSpecificFields?: VyChainSpecificFieldsEvmChains;
}
/**
*
*/
export declare class VyBuildTokenTransferTransactionRequest extends VyBuildTransactionRequestBase {
/**
* Token contract address of the token
* @type {string}
*/
tokenAddress?: string;
/**
* Amount you want to transfer
* @type {number}
*/
value?: number;
/**
*
* @type {VyChainSpecificFieldsEvmChains}
*/
chainSpecificFields?: VyChainSpecificFieldsEvmChains;
constructor(initializer?: IVyBuildTokenTransferTransactionRequestProps);
}
export interface IVyBuildTransferTransactionRequestProps extends IVyBuildTransactionRequestBaseProps {
/**
*
* @type {string}
*/
data?: string;
/**
* The amount of native coins you want to transfer
* @type {number}
*/
value?: number;
/**
*
* @type {VyChainSpecificFieldsBase}
*/
chainSpecificFields?: VyChainSpecificFieldsBase;
}
/**
*
*/
export declare class VyBuildTransferTransactionRequest extends VyBuildTransactionRequestBase {
/**
*
* @type {string}
*/
data?: string;
/**
* The amount of native coins you want to transfer
* @type {number}
*/
value?: number;
/**
*
* @type {VyChainSpecificFieldsBase}
*/
chainSpecificFields?: VyChainSpecificFieldsBase;
constructor(initializer?: IVyBuildTransferTransactionRequestProps);
}
/**
*
*/
export declare class VyChainSpecificFieldsOneOf {
constructor(initializer?: VyChainSpecificFieldsOneOf);
}
/**
*
*/
export declare class VyTransactionResultDto {
/**
* The transaction `ID`
* @type {string}
*/
id?: string;
/**
* The transaction hash
* @type {string}
*/
transactionHash?: string;
/**
* An object with additional transaction details
* @type {Any}
*/
transactionDetails?: Any;
constructor(initializer?: VyTransactionResultDto);
}
/**
*
*/
export declare class VyTransactionRequestOneOf {
constructor(initializer?: VyTransactionRequestOneOf);
}
/**
*
*/
export declare class VyValidateSigningMethodRequestDto {
/**
*
* @type {string}
*/
id?: string;
/**
*
* @type {string}
*/
value?: string;
constructor(initializer?: VyValidateSigningMethodRequestDto);
}
export interface IVyAeTransactionRequestProps extends IVyTransactionRequestBaseProps {
/**
*
* @type {VyValidateSigningMethodRequestDto}
*/
signingMethod?: VyValidateSigningMethodRequestDto;
/**
*
* @type {string}
*/
to?: string;
/**
*
* @type {number}
*/
value?: number;
/**
*
* @deprecated This property will be removed in a future release
* @type {number}
*/
fee?: number;
/**
*
* @type {number}
*/
ttl?: number;
/**
*
* @type {number}
*/
nonce?: number;
/**
*
* @type {string}
*/
data?: string;
}
/**
*
*/
export declare class VyAeTransactionRequest extends VyTransactionRequestBase {
/**
*
* @type {VyValidateSigningMethodRequestDto}
*/
signingMethod?: VyValidateSigningMethodRequestDto;
/**
*
* @type {string}
*/
to?: string;
/**
*
* @type {number}
*/
value?: number;
/**
*
* @deprecated This property will be removed in a future release
* @type {number}
*/
fee?: number;
/**
*
* @type {number}
*/
ttl?: number;
/**
*
* @type {number}
*/
nonce?: number;
/**
*
* @type {string}
*/
data?: string;
constructor(initializer?: IVyAeTransactionRequestProps);
}
/**
*
*/
export declare class VyNetworkDto {
/**
*
* @type {string}
*/
name?: string;
/**
*
* @type {string}
*/
nodeUrl?: string;
/**
*
* @type {number}
*/
chainId?: number;
constructor(initializer?: VyNetworkDto);
}
export interface IVyArbitrumContractExecutionRequestProps extends IVyTransactionRequestBaseProps {
/**
*
* @type {VyValidateSigningMethodRequestDto}
*/
signingMethod?: VyValidateSigningMethodRequestDto;
/**
*
* @type {number}
*/
gasPrice?: number;
/**
*
* @type {number}
*/
gas?: number;
/**
*
* @type {number}
*/
maxFeePerGas?: number;
/**
*
* @type {number}
*/
maxPriorityFeePerGas?: number;
/**
*
* @type {number}
*/
nonce?: number;
/**
*
* @type {number}
*/
value?: number;
/**
*
* @type {string}
*/
to?: string;
/**
*
* @type {VyNetworkDto}
*/
network?: VyNetworkDto;
/**
*
* @type {string}
*/
functionName?: string;
/**
*
* @type {Any[]}
*/
inputs?: Any[];
}
/**
*
*/
export declare class VyArbitrumContractExecutionRequest extends VyTransactionRequestBase {
/**
*
* @type {VyValidateSigningMethodRequestDto}
*/
signingMethod?: VyValidateSigningMethodRequestDto;
/**
*
* @type {number}
*/
gasPrice?: number;
/**
*
* @type {number}
*/
gas?: number;
/**
*
* @type {number}
*/
maxFeePerGas?: number;
/**
*
* @type {number}
*/
maxPriorityFeePerGas?: number;
/**
*
* @type {number}
*/
nonce?: number;
/**
*
* @type {number}
*/
value?: number;
/**
*
* @type {string}
*/
to?: string;
/**
*
* @type {VyNetworkDto}
*/
network?: VyNetworkDto;
/**
*
* @type {string}
*/
functionName?: string;
/**
*
* @type {Any[]}
*/
inputs?: Any[];
constructor(initializer?: IVyArbitrumContractExecutionRequestProps);
}
export interface IVyArbitrumErc20TransactionRequestProps extends IVyTransactionRequestBaseProps {
/**
*
* @type {VyValidateSigningMethodRequestDto}
*/
signingMethod?: VyValidateSigningMethodRequestDto;
/**
*
* @type {number}
*/
gasPrice?: number;
/**
*
* @type {number}
*/
gas?: number;
/**
*
* @type {number}
*/
maxFeePerGas?: number;
/**
*
* @type {number}
*/
maxPriorityFeePerGas?: number;
/**
*
* @type {number}
*/
nonce?: number;
/**
*
* @type {number}
*/
value?: number;
/**
*
* @type {string}
*/
to?: string;
/**
*
* @type {VyNetworkDto}
*/
network?: VyNetworkDto;
/**
*
* @type {string}
*/
tokenAddress?: string;
}
/**
*
*/
export declare class VyArbitrumErc20TransactionRequest extends VyTransactionRequestBase {
/**
*
* @type {VyValidateSigningMethodRequestDto}
*/
signingMethod?: VyValidateSigningMethodRequestDto;
/**
*
* @type {number}
*/
gasPrice?: number;
/**
*
* @type {number}
*/
gas?: number;
/**
*
* @type {number}
*/
maxFeePerGas?: number;
/**
*
* @type {number}
*/
maxPriorityFeePerGas?: number;
/**
*
* @type {number}
*/
nonce?: number;
/**
*
* @type {number}
*/
value?: number;
/**
*
* @type {string}
*/
to?: string;
/**
*
* @type {VyNetworkDto}
*/
network?: VyNetworkDto;
/**
*
* @type {string}
*/
tokenAddress?: string;
constructor(initializer?: IVyArbitrumErc20TransactionRequestProps);
}
export interface IVyArbitrumErc721TransactionRequestProps extends IVyTransactionRequestBaseProps {
/**
*
* @type {VyValidateSigningMethodRequestDto}
*/
signingMethod?: VyValidateSigningMethodRequestDto;
/**
*
* @type {number}
*/
gasPrice?: number;
/**
*
* @type {number}
*/
gas?: number;
/**
*
* @type {number}
*/
maxFeePerGas?: number;
/**
*
* @type {number}
*/
maxPriorityFeePerGas?: number;
/**
*
* @type {number}
*/
nonce?: number;
/**
*
* @type {number}
*/
value?: number;
/**
*
* @type {string}
*/
to?: string;
/**
*
* @type {VyNetworkDto}
*/
network?: VyNetworkDto;
/**
*
* @type {string}
*/
tokenAddress?: string;
/**
*
* @type {string}
*/
from?: string;
/**
*
* @type {number}
*/
amount?: number;
/**
*
* @type {number}
*/
tokenId?: number;
}
/**
*
*/
export declare class VyArbitrumErc721TransactionRequest extends VyTransactionRequestBase {
/**
*
* @type {VyValidateSigningMethodRequestDto}
*/
signingMethod?: VyValidateSigningMethodRequestDto;
/**
*
* @type {number}
*/
gasPrice?: number;
/**
*
* @type {number}
*/
gas?: number;
/**
*
* @type {number}
*/
maxFeePerGas?: number;
/**
*
* @type {number}
*/
maxPriorityFeePerGas?: number;
/**
*
* @type {number}
*/
nonce?: number;
/**
*
* @type {number}
*/
value?: number;
/**
*
* @type {string}
*/
to?: string;
/**
*
* @type {VyNetworkDto}
*/
network?: VyNetworkDto;
/**
*
* @type {string}
*/
tokenAddress?: string;
/**
*
* @type {string}
*/
from?: string;
/**
*
* @type {number}
*/
amount?: number;
/**
*
* @type {number}
*/
tokenId?: number;
constructor(initializer?: IVyArbitrumErc721TransactionRequestProps);
}
export interface IVyArbitrumTransactionRequestProps extends IVyTransactionRequestBaseProps {
/**
*
* @type {VyValidateSigningMethodRequestDto}
*/
signingMethod?: VyValidateSigningMethodRequestDto;
/**
*
* @type {number}
*/
gasPrice?: number;
/**
*
* @type {number}
*/
gas?: number;
/**
*
* @type {number}
*/
maxFeePerGas?: number;
/**
*
* @type {number}
*/
maxPriorityFeePerGas?: number;
/**
*
* @type {number}
*/
nonce?: number;
/**
*
* @type {number}
*/
value?: number;
/**
*
* @type {string}
*/
to?: string;
/**
*
* @type {VyNetworkDto}
*/
network?: VyNetworkDto;
/**
*
* @type {string}
*/
data?: string;
}
/**
*
*/
export declare class VyArbitrumTransactionRequest extends VyTransactionRequestBase {
/**
*
* @type {VyValidateSigningMethodRequestDto}
*/
signingMethod?: VyValidateSigningMethodRequestDto;
/**
*
* @type {number}
*/
gasPrice?: number;
/**
*
* @type {number}
*/
gas?: number;
/**
*
* @type {number}
*/
maxFeePerGas?: number;
/**
*
* @type {number}
*/
maxPriorityFeePerGas?: number;
/**
*
* @type {number}
*/
nonce?: number;
/**
*
* @type {number}
*/
value?: number;
/**
*
* @type {string}
*/
to?: string;
/**
*
* @type {VyNetworkDto}
*/
network?: VyNetworkDto;
/**
*
*