@mimicprotocol/sdk 0.0.1-rc.0

package/README.md

@@ -0,0 +1,58 @@
+<h1 align="center">
+  <a href="https://mimic.fi"><img src="https://www.mimic.fi/logo.png" alt="Mimic Protocol" width="200"></a> 
+</h1>
+
+<h4 align="center">Blockchain automation protocol</h4>
+
+<p align="center">
+  <a href="https://github.com/mimic-protocol/tooling/actions/workflows/ci.yml">
+    <img src="https://github.com/mimic-protocol/tooling/actions/workflows/ci.yml/badge.svg" alt="Build">
+  </a>
+  <a href="https://discord.mimic.fi">
+    <img alt="Discord" src="https://img.shields.io/discord/989984112397922325">
+  </a>
+</p>
+
+<p align="center">
+  <a href="#content">Content</a> •
+  <a href="#setup">Setup</a> •
+  <a href="#security">Security</a> •
+  <a href="#license">License</a>
+</p>
+
+---
+
+## Content 
+
+This package provides a TypeScript SDK to interact with Mimic Protocol.  
+It wraps the protocol’s API to offer developers a more ergonomic interface when building integrations and automations.
+
+## Setup
+
+To set up this project you'll need [git](https://git-scm.com) and [yarn](https://classic.yarnpkg.com) installed. 
+
+Install the library from npm:
+
+```bash
+yarn add @mimicprotocol/sdk
+```
+
+## Security
+
+To read more about our auditing and related security processes please refer to the [security section](https://docs.mimic.fi/miscellaneous/security) of our docs site.
+
+However, if you found any potential issue in any of our smart contracts or in any piece of code you consider critical
+for the safety of the protocol, please contact us through <a href="mailto:security@mimic.fi">security@mimic.fi</a>.
+
+## License
+
+This project is licensed under the GNU General Public License v3.0.  
+See the [LICENSE](./LICENSE) file for details.
+
+---
+
+> Website [mimic.fi](https://mimic.fi) &nbsp;&middot;&nbsp;
+> Docs [docs.mimic.fi](https://docs.mimic.fi) &nbsp;&middot;&nbsp;
+> GitHub [@mimic-fi](https://github.com/mimic-fi) &nbsp;&middot;&nbsp;
+> Twitter [@mimicfi](https://twitter.com/mimicfi) &nbsp;&middot;&nbsp;
+> Discord [mimic](https://discord.mimic.fi)

package/dist/axia/constants.d.ts

@@ -0,0 +1,16 @@
+export declare enum IntentStatus {
+    enqueued = "enqueued",
+    discarded = "discarded",
+    submitted = "submitted",
+    succeeded = "succeeded",
+    failed = "failed",
+    expired = "expired"
+}
+export declare enum ProposalStatus {
+    received = "received",
+    discarded = "discarded",
+    submitted = "submitted",
+    succeeded = "succeeded",
+    failed = "failed"
+}
+//# sourceMappingURL=constants.d.ts.map

package/dist/axia/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/axia/constants.ts"],"names":[],"mappings":"AAAA,oBAAY,YAAY;IACtB,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,SAAS,cAAc;IACvB,SAAS,cAAc;IACvB,MAAM,WAAW;IACjB,OAAO,YAAY;CACpB;AAED,oBAAY,cAAc;IACxB,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,SAAS,cAAc;IACvB,SAAS,cAAc;IACvB,MAAM,WAAW;CAClB"}

package/dist/axia/constants.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProposalStatus = exports.IntentStatus = void 0;
+var IntentStatus;
+(function (IntentStatus) {
+    IntentStatus["enqueued"] = "enqueued";
+    IntentStatus["discarded"] = "discarded";
+    IntentStatus["submitted"] = "submitted";
+    IntentStatus["succeeded"] = "succeeded";
+    IntentStatus["failed"] = "failed";
+    IntentStatus["expired"] = "expired";
+})(IntentStatus || (exports.IntentStatus = IntentStatus = {}));
+var ProposalStatus;
+(function (ProposalStatus) {
+    ProposalStatus["received"] = "received";
+    ProposalStatus["discarded"] = "discarded";
+    ProposalStatus["submitted"] = "submitted";
+    ProposalStatus["succeeded"] = "succeeded";
+    ProposalStatus["failed"] = "failed";
+})(ProposalStatus || (exports.ProposalStatus = ProposalStatus = {}));
+//# sourceMappingURL=constants.js.map

package/dist/axia/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/axia/constants.ts"],"names":[],"mappings":";;;AAAA,IAAY,YAOX;AAPD,WAAY,YAAY;IACtB,qCAAqB,CAAA;IACrB,uCAAuB,CAAA;IACvB,uCAAuB,CAAA;IACvB,uCAAuB,CAAA;IACvB,iCAAiB,CAAA;IACjB,mCAAmB,CAAA;AACrB,CAAC,EAPW,YAAY,4BAAZ,YAAY,QAOvB;AAED,IAAY,cAMX;AAND,WAAY,cAAc;IACxB,uCAAqB,CAAA;IACrB,yCAAuB,CAAA;IACvB,yCAAuB,CAAA;IACvB,yCAAuB,CAAA;IACvB,mCAAiB,CAAA;AACnB,CAAC,EANW,cAAc,8BAAd,cAAc,QAMzB"}

package/dist/axia/index.d.ts

@@ -0,0 +1,4 @@
+export * from './constants';
+export * from './types';
+export * from './validators';
+//# sourceMappingURL=index.d.ts.map

package/dist/axia/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/axia/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,SAAS,CAAA;AACvB,cAAc,cAAc,CAAA"}

package/dist/axia/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./constants"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./validators"), exports);
+//# sourceMappingURL=index.js.map

package/dist/axia/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/axia/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA2B;AAC3B,0CAAuB;AACvB,+CAA4B"}

package/dist/axia/types.d.ts

@@ -0,0 +1,18 @@
+import { z } from 'zod';
+import { AxiaIntentsValidator, AxiaIntentValidator, ExecutionCreateRequestValidator, ExecutionFeeValidator, ExecutionIntentValidator, ExecutionResponseValidator, ExecutionsGetRequestValidator, ExecutionsResponseValidator, IntentQuoteRequestValidator, IntentQuoteValidator, IntentsGetRequestValidator, IntentSubmitRequestValidator, IntentSubmitValidator, SettlersValidator, SettlerValidator } from './validators';
+export type IntentQuoteRequest = z.infer<typeof IntentQuoteRequestValidator>;
+export type IntentQuote = z.infer<typeof IntentQuoteValidator>;
+export type IntentSubmitRequest = z.infer<typeof IntentSubmitRequestValidator>;
+export type IntentSubmit = z.infer<typeof IntentSubmitValidator>;
+export type IntentsGetRequest = z.infer<typeof IntentsGetRequestValidator>;
+export type AxiaIntents = z.infer<typeof AxiaIntentsValidator>;
+export type AxiaIntent = z.infer<typeof AxiaIntentValidator>;
+export type Settler = z.infer<typeof SettlerValidator>;
+export type Settlers = z.infer<typeof SettlersValidator>;
+export type ExecutionCreateRequest = z.infer<typeof ExecutionCreateRequestValidator>;
+export type ExecutionsGetRequest = z.infer<typeof ExecutionsGetRequestValidator>;
+export type ExecutionResponse = z.infer<typeof ExecutionResponseValidator>;
+export type ExecutionFee = z.infer<typeof ExecutionFeeValidator>;
+export type ExecutionsResponse = z.infer<typeof ExecutionsResponseValidator>;
+export type ExecutionIntent = z.infer<typeof ExecutionIntentValidator>;
+//# sourceMappingURL=types.d.ts.map

package/dist/axia/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/axia/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EACL,oBAAoB,EACpB,mBAAmB,EACnB,+BAA+B,EAC/B,qBAAqB,EACrB,wBAAwB,EACxB,0BAA0B,EAC1B,6BAA6B,EAC7B,2BAA2B,EAC3B,2BAA2B,EAC3B,oBAAoB,EACpB,0BAA0B,EAC1B,4BAA4B,EAC5B,qBAAqB,EACrB,iBAAiB,EACjB,gBAAgB,EACjB,MAAM,cAAc,CAAA;AAErB,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAA;AAE5E,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAE9D,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA;AAE9E,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEhE,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAE1E,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAE9D,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAE5D,MAAM,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAA;AAEtD,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AAExD,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAA;AAEpF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAA;AAEhF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAE1E,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEhE,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAA;AAE5E,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA"}

package/dist/axia/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/axia/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/axia/types.ts"],"names":[],"mappings":""}