@onekeyfe/hd-core 0.2.8 → 0.2.9

package/src/types/api/cardano.ts

@@ -0,0 +1,186 @@
+import type { PROTO } from '../../constants';
+
+export interface CardanoAddressParameters {
+  addressType: PROTO.CardanoAddressType;
+  path?: string | number[];
+  stakingPath?: string | number[];
+  stakingKeyHash?: string;
+  certificatePointer?: CardanoCertificatePointer;
+  paymentScriptHash?: string;
+  stakingScriptHash?: string;
+}
+
+export interface CardanoCertificatePointer {
+  blockIndex: number;
+  txIndex: number;
+  certificateIndex: number;
+}
+
+export interface CardanoToken {
+  assetNameBytes: string;
+  amount?: string;
+  mintAmount?: string;
+}
+
+export interface CardanoAssetGroup {
+  policyId: string;
+  tokenAmounts: CardanoToken[];
+}
+
+export type AssetGroupWithTokens = {
+  policyId: string;
+  tokens: PROTO.CardanoToken[];
+};
+
+export interface CardanoCertificate {
+  type: PROTO.CardanoCertificateType;
+  path?: string | number[];
+  pool?: string;
+  poolParameters?: CardanoPoolParameters;
+  scriptHash?: string;
+  keyHash?: string;
+}
+
+export type CertificateWithPoolOwnersAndRelays = {
+  certificate: PROTO.CardanoTxCertificate;
+  poolOwners: PROTO.CardanoPoolOwner[];
+  poolRelays: PROTO.CardanoPoolRelayParameters[];
+};
+
+export interface CardanoPoolOwner {
+  stakingKeyPath?: string | number[];
+  stakingKeyHash?: string;
+}
+
+export interface CardanoPoolRelay {
+  type: PROTO.CardanoPoolRelayType;
+  ipv4Address?: string;
+  ipv6Address?: string;
+  port?: number;
+  hostName?: string;
+}
+
+export interface CardanoPoolMetadata {
+  url: string;
+  hash: string;
+}
+
+export interface CardanoPoolMargin {
+  numerator: string;
+  denominator: string;
+}
+
+export interface CardanoPoolParameters {
+  poolId: string;
+  vrfKeyHash: string;
+  pledge: string;
+  cost: string;
+  margin: CardanoPoolMargin;
+  rewardAccount: string;
+  owners: CardanoPoolOwner[];
+  relays: CardanoPoolRelay[];
+  metadata: CardanoPoolMetadata;
+}
+
+export interface CardanoInput {
+  path?: string | number[];
+  prev_hash: string;
+  prev_index: number;
+}
+
+export type CardanoOutput = (
+  | {
+      addressParameters: CardanoAddressParameters;
+    }
+  | {
+      address: string;
+    }
+) & {
+  amount: string;
+  tokenBundle?: CardanoAssetGroup[];
+  datumHash?: string;
+  // @ts-expect-error
+  format?: PROTO.CardanoTxOutputSerializationFormat;
+  inlineDatum?: string;
+  referenceScript?: string;
+};
+
+export interface CardanoWithdrawal {
+  path?: string | number[];
+  amount: string;
+  scriptHash?: string;
+  keyHash?: string;
+}
+
+export type CardanoMint = CardanoAssetGroup[];
+
+export interface CardanoCollateralInput {
+  path?: string | number[];
+  prev_hash: string;
+  prev_index: number;
+}
+
+export interface CardanoRequiredSigner {
+  keyPath?: string | number[];
+  keyHash?: string;
+}
+
+export interface CardanoReferenceInput {
+  prev_hash: string;
+  prev_index: number;
+}
+
+export interface CardanoCatalystRegistrationParameters {
+  votingPublicKey: string;
+  stakingPath: string | number[];
+  rewardAddressParameters: CardanoAddressParameters;
+  nonce: string;
+}
+
+export interface CardanoAuxiliaryData {
+  hash?: string;
+  catalystRegistrationParameters?: CardanoCatalystRegistrationParameters;
+}
+
+export interface CardanoSignTransaction {
+  inputs: CardanoInput[];
+  outputs: CardanoOutput[];
+  fee: string;
+  ttl?: string;
+  certificates?: CardanoCertificate[];
+  withdrawals?: CardanoWithdrawal[];
+  validityIntervalStart?: string;
+  auxiliaryData?: CardanoAuxiliaryData;
+  mint?: CardanoMint;
+  scriptDataHash?: string;
+  collateralInputs?: CardanoCollateralInput[];
+  requiredSigners?: CardanoRequiredSigner[];
+  collateralReturn?: CardanoOutput;
+  totalCollateral?: string;
+  referenceInputs?: CardanoReferenceInput[];
+  additionalWitnessRequests?: (string | number[])[];
+  protocolMagic: number;
+  networkId: number;
+  signingMode: PROTO.CardanoTxSigningMode;
+  derivationType?: PROTO.CardanoDerivationType;
+  includeNetworkId?: boolean;
+}
+
+export interface CardanoSignedTxWitness {
+  type: PROTO.CardanoTxWitnessType;
+  pubKey: string;
+  signature: string;
+  chainCode?: string;
+}
+
+export interface CardanoAuxiliaryDataSupplement {
+  type: PROTO.CardanoTxAuxiliaryDataSupplementType;
+  auxiliaryDataHash: string;
+  catalystSignature?: string;
+}
+
+export interface CardanoSignedTxData {
+  hash: string;
+  witnesses: CardanoSignedTxWitness[];
+  auxiliaryDataSupplement?: CardanoAuxiliaryDataSupplement;
+}

package/src/types/api/cardanoGetAddress.ts

@@ -0,0 +1,47 @@
+import type { CardanoAddressParametersType } from '@onekeyfe/hd-transport';
+import type { CommonParams, Response } from '../params';
+import type { CardanoAddressParameters } from './cardano';
+
+export type CardanoGetAddressMethodParams = {
+  addressParameters: CardanoAddressParameters;
+  networkId: number;
+  /**
+   * Testnet	cip34:0-1097911063
+   * Mainnet	cip34:1-764824073
+   */
+  protocolMagic: number;
+  derivationType: number;
+  address: string;
+  showOnOneKey: boolean;
+};
+
+export type CardanoGetAddressParams = {
+  address_parameters: CardanoAddressParametersType;
+  network_id: number;
+  protocol_magic: number;
+  derivation_type: number;
+  address: string;
+  show_display: boolean;
+};
+
+export type CardanoAddress = {
+  addressParameters: CardanoAddressParameters;
+  protocolMagic: number;
+  networkId: number;
+  serializedPath: string;
+  serializedStakingPath: string;
+  address: string;
+  xpub: string;
+};
+
+export declare function cardanoGetAddress(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & CardanoGetAddressMethodParams
+): Response<CardanoAddress>;
+
+export declare function cardanoGetAddress(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & { bundle?: CardanoGetAddressMethodParams[] }
+): Response<CardanoAddress[]>;

package/src/types/api/cardanoGetPublicKey.ts

@@ -0,0 +1,33 @@
+import type { CommonParams, Response } from '../params';
+import { PROTO } from '../../constants';
+
+export type CardanoPublicKey = {
+  path: number[];
+  serializedPath: string;
+  publicKey: string;
+  node: PROTO.HDNodeType;
+};
+
+export type CardanoPublicKeyParams = {
+  address_n: number[];
+  derivation_type: number;
+  show_display: boolean;
+};
+
+export type CardanoPublicKeyMethodParams = {
+  path: string | number[];
+  derivationType?: number;
+  showOnOneKey?: boolean;
+};
+
+export declare function cardanoGetPublicKey(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & CardanoPublicKeyMethodParams
+): Response<CardanoPublicKey>;
+
+export declare function cardanoGetPublicKey(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & { bundle?: CardanoPublicKeyMethodParams[] }
+): Response<CardanoPublicKey[]>;

package/src/types/api/cardanoSignTransaction.ts

@@ -0,0 +1,8 @@
+import type { CommonParams, Response } from '../params';
+import type { CardanoSignTransaction, CardanoSignedTxData } from './cardano';
+
+export declare function cardanoSignTransaction(
+  connectId: string,
+  deviceId: string,
+  params: CommonParams & CardanoSignTransaction
+): Response<CardanoSignedTxData>;

package/src/types/api/index.ts

@@ -90,6 +90,10 @@ import { suiGetAddress } from './suiGetAddress';
 import { suiGetPublicKey } from './suiGetPublicKey';
 import { suiSignTransaction } from './suiSignTransaction';
 
+import { cardanoGetAddress } from './cardanoGetAddress';
+import { cardanoGetPublicKey } from './cardanoGetPublicKey';
+import { cardanoSignTransaction } from './cardanoSignTransaction';
+
 export * from './export';
 
 export type CoreApi = {
@@ -240,4 +244,11 @@ export type CoreApi = {
   suiGetAddress: typeof suiGetAddress;
   suiGetPublicKey: typeof suiGetPublicKey;
   suiSignTransaction: typeof suiSignTransaction;
+
+  /**
+   * Cardano function
+   */
+  cardanoGetAddress: typeof cardanoGetAddress;
+  cardanoGetPublicKey: typeof cardanoGetPublicKey;
+  cardanoSignTransaction: typeof cardanoSignTransaction;
 };