@fairmint/canton-node-sdk
Version:
Canton Node SDK
316 lines • 11.6 kB
TypeScript
/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
export interface paths {
"/registry/transfer-instruction/v1/transfer-factory": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Get the factory and choice context for executing a direct transfer. */
post: operations["getTransferFactory"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/registry/transfer-instruction/v1/{transferInstructionId}/choice-contexts/accept": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Get the choice context to accept a transfer instruction. */
post: operations["getTransferInstructionAcceptContext"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/registry/transfer-instruction/v1/{transferInstructionId}/choice-contexts/reject": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Get the choice context to reject a transfer instruction. */
post: operations["getTransferInstructionRejectContext"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/registry/transfer-instruction/v1/{transferInstructionId}/choice-contexts/withdraw": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Get the choice context to withdraw a transfer instruction. */
post: operations["getTransferInstructionWithdrawContext"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
}
export type webhooks = Record<string, never>;
export interface components {
schemas: {
GetFactoryRequest: {
/**
* @description The arguments that are intended to be passed to the choice provided by the factory.
* To avoid repeating the Daml type definitions, they are specified as JSON objects.
* However the concrete format is given by how the choice arguments are encoded using the Daml JSON API
* (with the `extraArgs.context` and `extraArgs.meta` fields set to the empty object).
*
* The choice arguments are provided so that the registry can also provide choice-argument
* specific contracts, e.g., the configuration for a specific instrument-id.
*/
choiceArguments: Record<string, never>;
/**
* @description If set to true, the response will not include debug fields.
* @default false
*/
excludeDebugFields: boolean;
};
/** @description A request to get the context for executing a choice on a contract. */
GetChoiceContextRequest: {
/**
* @description Metadata that will be passed to the choice, and should be incorporated
* into the choice context. Provided for extensibility.
*/
meta?: {
[key: string]: string;
};
};
/**
* @description The transfer factory contract together with the choice context required to exercise the choice
* provided by the factory. Typically used to implement the generic initiation of on-ledger workflows
* via a Daml interface.
*
* Clients SHOULD avoid reusing the same `FactoryWithChoiceContext` for exercising multiple choices,
* as the choice context MAY be specific to the choice being exercised.
*/
TransferFactoryWithChoiceContext: {
/** @description The contract ID of the contract implementing the factory interface. */
factoryId: string;
/**
* @description The kind of transfer workflow that will be used:
* * `offer`: offer a transfer to the receiver and only transfer if they accept
* * `direct`: transfer directly to the receiver without asking them for approval.
* Only chosen if the receiver has pre-approved direct transfers.
* * `self`: a self-transfer where the sender and receiver are the same party.
* No approval is required, and the transfer is typically immediate.
* @enum {string}
*/
transferKind: "self" | "direct" | "offer";
choiceContext: components["schemas"]["ChoiceContext"];
};
/**
* @description The context required to exercise a choice on a contract via an interface.
* Used to retrieve additional reference data that is passed in via disclosed contracts,
* which are in turn referred to via their contract ID in the `choiceContextData`.
*/
ChoiceContext: {
/** @description The additional data to use when exercising the choice. */
choiceContextData: Record<string, never>;
/**
* @description The contracts that are required to be disclosed to the participant node for exercising
* the choice.
*/
disclosedContracts: components["schemas"]["DisclosedContract"][];
};
DisclosedContract: {
templateId: string;
contractId: string;
createdEventBlob: string;
/**
* @description The synchronizer to which the contract is currently assigned.
* If the contract is in the process of being reassigned, then a "409" response is returned.
*/
synchronizerId: string;
/**
* @description The name of the Daml package that was used to create the contract.
* Use this data only if you trust the provider, as it might not match the data in the
* `createdEventBlob`.
*/
debugPackageName?: string;
/**
* @description The contract arguments that were used to create the contract.
* Use this data only if you trust the provider, as it might not match the data in the
* `createdEventBlob`.
*/
debugPayload?: Record<string, never>;
/**
* Format: date-time
* @description The ledger effective time at which the contract was created.
* Use this data only if you trust the provider, as it might not match the data in the
* `createdEventBlob`.
*/
debugCreatedAt?: string;
};
ErrorResponse: {
error: string;
};
};
responses: {
/** @description bad request */
400: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorResponse"];
};
};
/** @description not found */
404: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorResponse"];
};
};
};
parameters: never;
requestBodies: never;
headers: never;
pathItems: never;
}
export type $defs = Record<string, never>;
export interface operations {
getTransferFactory: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["GetFactoryRequest"];
};
};
responses: {
/** @description ok */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TransferFactoryWithChoiceContext"];
};
};
400: components["responses"]["400"];
404: components["responses"]["404"];
};
};
getTransferInstructionAcceptContext: {
parameters: {
query?: never;
header?: never;
path: {
/** @description The contract ID of the transfer instruction to accept. */
transferInstructionId: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["GetChoiceContextRequest"];
};
};
responses: {
/** @description ok */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ChoiceContext"];
};
};
400: components["responses"]["400"];
404: components["responses"]["404"];
};
};
getTransferInstructionRejectContext: {
parameters: {
query?: never;
header?: never;
path: {
/** @description The contract ID of the transfer instruction to reject. */
transferInstructionId: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["GetChoiceContextRequest"];
};
};
responses: {
/** @description ok */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ChoiceContext"];
};
};
400: components["responses"]["400"];
404: components["responses"]["404"];
};
};
getTransferInstructionWithdrawContext: {
parameters: {
query?: never;
header?: never;
path: {
/** @description The contract ID of the transfer instruction to withdraw. */
transferInstructionId: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["GetChoiceContextRequest"];
};
};
responses: {
/** @description ok */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ChoiceContext"];
};
};
400: components["responses"]["400"];
404: components["responses"]["404"];
};
};
}
//# sourceMappingURL=transfer-instruction-v1.d.ts.map