feat: add OAS (json) and generate types See merge request atixlabs/multisig-coordination-server!1
export interface Block {
hash: string;
number: number;
createdAt: number;
previousBlockHash: string;
previousBlockNumber: number;
transactionsCount: number;
createdBy: string;
size: number;
epochNo: number;
slotNo: number;
}
export interface GenesisBlock {
hash: string;
number: number;
}
export type WalletId = Components.Schemas.WalletId;
export type WalletState = Components.Schemas.WalletState;
export interface BlockIdentifier {
index: number;
hash: string;
}
export interface Utxo {
value: string;
transactionHash: string;
index: number;
}
export type PubKey = Components.Schemas.PubKey;
export type CoSignerAlias = Components.Schemas.CoSignerAlias;
export interface TransactionInput {
address: string;
value: string;
sourceTransactionHash: string;
sourceTransactionIndex: number;
export type TransactionId = Components.Schemas.TransactionId;
export type TransactionState = Components.Schemas.TransactionState;
export type UnsignedTransaction = string;
export interface CoSigner {
alias: CoSignerAlias;
pubKey: PubKey;
}
export interface TransactionOutput {
address: string;
value: string;
index: number;
export interface Wallet {
walletId: WalletId;
walletState: WalletState;
m: number;
n: number;
createDate: string;
pendingTxs: number;
cosigners: CoSigner[];
}
export interface Transaction {
hash: string;
blockHash: string;
fee: string;
size: number;
}
export interface TransactionWithInputsAndOutputs extends Transaction {
inputs: TransactionInput[];
outputs: TransactionOutput[];
}
export interface Network {
networkName: string;
}
export interface BlockUtxos {
block: Block;
utxos: Utxo[];
txId: TransactionId;
unsignedTransaction: UnsignedTransaction;
transactionState: TransactionState;
creationDate: string;
updateDate: string;
}
{
"openapi": "3.0.2",
"info": {
"version": "1.4.4",
"title": "Sample",
"description": "Sample!",
"title": "Multisig Coordination Server",
"description": "Multisig Coordination Server",
"version": "1.0",
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
}
},
"components": {
"schemas": {
"PubKey": {
"type": "string"
},
"CoSignerAlias": {
"type": "string"
},
"WalletId": {
"type": "string"
},
"TransactionId": {
"type": "string"
},
"TransactionState": {
"type": "string",
"enum": ["WaitingForSignatures", "Signed"]
},
"CoSigner": {
"type": "object",
"required": ["cosignerAlias", "pubKey"],
"properties": {
"cosignerAlias": {
"$ref": "#/components/schemas/CoSignerAlias"
},
"pubKey": {
"$ref": "#/components/schemas/PubKey"
}
}
},
"WalletState": {
"type": "string",
"enum": ["WaitingForCosigners", "Ready", "Expired"]
},
"Wallet": {
"type": "object",
"required": ["walletId", "walletState", "cosigners", "pendingTxs", "creationDate"],
"properties": {
"walletId": {
"$ref": "#/components/schemas/WalletId"
},
"walletState": {
"$ref": "#/components/schemas/WalletState"
},
"cosigners": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CoSigner"
}
},
"pendingTxs": {
"type": "integer"
},
"creationDate": {
"type": "string",
"format": "date"
}
}
},
"WalletCreation": {
"type": "object",
"required": ["walletName", "m", "n", "cosigner"],
"properties": {
"walletName": {
"type": "string"
},
"m": {
"type": "integer"
},
"n": {
"type": "integer"
},
"cosigner": {
"$ref": "#/components/schemas/CoSigner"
}
}
},
"UnsignedTransaction": {
"type": "string"
},
"Transaction": {
"type": "object",
"required": ["transactionId", "unsignedTransaction", "transactionState", "creationDate", "updateDate"],
"properties": {
"transactionId": {
"$ref": "#/components/schemas/TransactionId"
},
"unsignedTransaction": {
"$ref": "#/components/schemas/UnsignedTransaction"
},
"transactionState": {
"type": "string",
"enum": ["WaitingForSignatures", "Signed"]
},
"creationDate": {
"type": "string",
"format": "date"
},
"updateDate": {
"type": "string",
"format": "date"
}
}
},
"ErrorResponse": {
"type": "object",
"required": ["error"],
"properties": {
"error": {
"type": "string"
}
}
}
},
"requestBodies": {
"createWallet": {
"description": "m-of-n wallet to create",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WalletCreation"
}
}
}
},
"joinWallet": {
"description": "cosigner who wants to join",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CoSigner"
}
}
}
},
"transactionProposal": {
"description": "new transaction proposal",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": ["issuer", "tx"],
"properties": {
"issuer": {
"$ref": "#/components/schemas/PubKey"
},
"tx": {
"$ref": "#/components/schemas/UnsignedTransaction"
}
}
}
}
}
},
"signProposal": {
"description": "new transaction proposal",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": ["issuer"],
"properties": {
"issuer": {
"$ref": "#/components/schemas/PubKey"
}
}
}
}
}
}
},
"responses": {
"createWallet": {
"description": "Create wallet response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": ["walletId"],
"properties": {
"walletId": {
declare namespace Components {
namespace RequestBodies {
export type CreateWallet = Schemas.WalletCreation;
export type JoinWallet = Schemas.CoSigner;
export interface SignProposal {
issuer: Schemas.PubKey;
}
export interface TransactionProposal {
issuer: Schemas.PubKey;
tx: Schemas.UnsignedTransaction;
}
}
namespace Responses {
export interface CreateWallet {
walletId: Schemas.WalletId;
}
export interface JoinWallet {
walletState: Schemas.WalletState;
}
export type SignTransaction = Schemas.Transaction;
export type TransactionProposal = Schemas.Transaction;
export type TransactionProposals = Schemas.Transaction[];
export type WalletState = Schemas.Wallet;
}
namespace Schemas {
/**
* Sample request
*/
export interface SampleRequest {
param: string;
}
/**
* Sample response object.
*/
export interface SampleResponse {
msg: string;
}
/**
* Sample response error object.
*/
export interface SampleResponseError {
export interface CoSigner {
cosignerAlias: CoSignerAlias;
pubKey: PubKey;
}
export type CoSignerAlias = string;
export interface ErrorResponse {
error: string;
}
export type PubKey = string;
export interface Transaction {
transactionId: TransactionId;
unsignedTransaction: UnsignedTransaction;
transactionState: 'WaitingForSignatures' | 'Signed';
creationDate: string; // date
updateDate: string; // date
}
export type TransactionId = string;
export type TransactionState = 'WaitingForSignatures' | 'Signed';
export type UnsignedTransaction = string;
export interface Wallet {
walletId: WalletId;
walletState: WalletState;
cosigners: CoSigner[];
pendingTxs: number;
creationDate: string; // date
}
export interface WalletCreation {
walletName: string;
m: number;
n: number;
cosigner: CoSigner;
}
export type WalletId = string;
export type WalletState = 'WaitingForCosigners' | 'Ready' | 'Expired';
}
}
declare namespace Paths {
namespace SampleMethod {
export type RequestBody = /* Sample request */ Components.Schemas.SampleRequest;
namespace CreateWallet {
export type RequestBody = Components.RequestBodies.CreateWallet;
namespace Responses {
export type $200 = Components.Responses.CreateWallet;
export type $400 = Components.Schemas.ErrorResponse;
export type $500 = Components.Schemas.ErrorResponse;
}
}
namespace GetTransactionProposals {
namespace Parameters {
export type From = string; // date
export type WalletId = string;
}
export interface PathParameters {
walletId: Parameters.WalletId;
}
export interface QueryParameters {
from: Parameters.From /* date */;
}
namespace Responses {
export type $200 = Components.Responses.TransactionProposals;
export type $404 = Components.Schemas.ErrorResponse;
export type $500 = Components.Schemas.ErrorResponse;
}
}
namespace GetWalletState {
namespace Parameters {
export type WalletId = string;
}
export interface PathParameters {
walletId: Parameters.WalletId;
}
namespace Responses {
export type $200 = Components.Responses.WalletState;
export type $404 = Components.Schemas.ErrorResponse;
export type $500 = Components.Schemas.ErrorResponse;
}
}
namespace JoinWallet {
namespace Parameters {
export type WalletId = string;
}
export interface PathParameters {
walletId: Parameters.WalletId;
}
export type RequestBody = Components.RequestBodies.JoinWallet;
namespace Responses {
export type $200 = Components.Responses.JoinWallet;
export type $400 = Components.Schemas.ErrorResponse;
export type $404 = Components.Schemas.ErrorResponse;
export type $500 = Components.Schemas.ErrorResponse;
}
}
namespace NewTransactionProposal {
namespace Parameters {
export type WalletId = string;
}
export interface PathParameters {
walletId: Parameters.WalletId;
}
export type RequestBody = Components.RequestBodies.TransactionProposal;
namespace Responses {
export type $200 = Components.Responses.TransactionProposal;
export type $400 = Components.Schemas.ErrorResponse;
export type $404 = Components.Schemas.ErrorResponse;
export type $500 = Components.Schemas.ErrorResponse;
}
}
namespace SignTransaction {
namespace Parameters {
export type TxId = string;
}
export interface PathParameters {
txId: Parameters.TxId;
}
export type RequestBody = Components.RequestBodies.SignProposal;
namespace Responses {
export type $200 = /* Sample response object. */ Components.Schemas.SampleResponse;
export type $500 = /* Sample response error object. */ Components.Schemas.SampleResponseError;
export type $200 = Components.Responses.SignTransaction;
export type $400 = Components.Schemas.ErrorResponse;
export type $404 = Components.Schemas.ErrorResponse;
export type $500 = Components.Schemas.ErrorResponse;
}
}
}
In response to review feedback: https://github.com/input-output-hk/cardano-wallet/pull/2451#discussion_r561029734
In response to review feedback: https://github.com/input-output-hk/cardano-wallet/pull/2451#discussion_r560856424
https://github.com/input-output-hk/cardano-haskell/pull/38
Needs latest prettyprinter version.
Needs latest prettyprinter version.
https://github.com/input-output-hk/cardano-haskell/pull/38
In response to review feedback: https://github.com/input-output-hk/cardano-wallet/pull/2451#discussion_r561029734
Three changes that the hydra eval faster. In order of importance: 1) Split `native` jobs into `linux` and `darwin` Reduces the number of times hydra restarts the eval process because memory is running low. When both linux and darwin versions are in the same attribute the evaluation runs out of memory more often as it alternates between evaluating linux and darwin jobs. Grouping all the linux and darwin jobs together reduces the number of times the memory limit is reached. This is makes the "no change" eval more than 4x faster (270s vs 1300s). 2) Avoid duplicate `cabal configure` To get a list of package names in the project we call `cabalProject`, before using those names to provide the overrides for another call to `cabalProject`. `cabalProjectLocal` is not the same for the two calls and as a result `cabal configure` is run twice (and it is very slow for this project. Passing the same `cabalProjectLocal` value to both calls should improve evaluation greatly when changes are made to the `cabal.project` or `.cabal` files. 3) Include jobs to pin plan-nix Pinning the `plan-nix` output means it is copied to the hydra cache. This may not improve eval on the hydra machine itself, it will make testing evaluation on other machines faster (since they will have access to the cached plans).
In response to review feedback: https://github.com/input-output-hk/cardano-wallet/pull/2451#discussion_r560856424
