@ultrade/ultrade-js-sdk 0.2.3

package/dist/artifacts/master.d.ts

@@ -0,0 +1,14 @@
+export declare const MASTER_ABI: {
+    name: string;
+    methods: {
+        name: string;
+        args: {
+            type: string;
+            name: string;
+        }[];
+        returns: {
+            type: string;
+        };
+    }[];
+    networks: {};
+};

package/dist/artifacts/master.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MASTER_ABI = void 0;
+exports.MASTER_ABI = {
+    name: 'Master',
+    methods: [
+        {
+            name: 'bootstrap',
+            args: [
+                {
+                    type: 'application',
+                    name: 'tmp_pool'
+                },
+                {
+                    type: 'application',
+                    name: 'tmp_stable_pool'
+                }
+            ],
+            returns: {
+                type: 'void'
+            }
+        },
+        {
+            name: 'add_stable_coin',
+            args: [
+                {
+                    type: 'asset',
+                    name: 'token'
+                }
+            ],
+            returns: {
+                type: 'void'
+            }
+        },
+        {
+            name: 'remove_stable_coin',
+            args: [
+                {
+                    type: 'asset',
+                    name: 'token'
+                }
+            ],
+            returns: {
+                type: 'void'
+            }
+        },
+        {
+            name: 'create_pool',
+            args: [
+                {
+                    type: 'pay',
+                    name: 'seed'
+                },
+                {
+                    type: 'uint64',
+                    name: 'asset_a'
+                },
+                {
+                    type: 'uint64',
+                    name: 'asset_b'
+                }
+            ],
+            returns: {
+                type: 'void'
+            }
+        },
+        {
+            name: 'set_governor',
+            args: [
+                {
+                    type: 'uint64',
+                    name: 'asset_a'
+                },
+                {
+                    type: 'uint64',
+                    name: 'asset_b'
+                },
+                {
+                    type: 'account',
+                    name: 'governor'
+                }
+            ],
+            returns: {
+                type: 'void'
+            }
+        }
+    ],
+    networks: {}
+};

package/dist/artifacts/pool.d.ts

@@ -0,0 +1,25 @@
+export declare const POOL_ABI: {
+    name: string;
+    methods: ({
+        name: string;
+        args: {
+            type: string;
+            name: string;
+        }[];
+        returns: {
+            type: string;
+        };
+        desc: string;
+    } | {
+        name: string;
+        args: {
+            type: string;
+            name: string;
+        }[];
+        returns: {
+            type: string;
+        };
+        desc?: undefined;
+    })[];
+    networks: {};
+};

package/dist/artifacts/pool.js

@@ -0,0 +1,123 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.POOL_ABI = void 0;
+exports.POOL_ABI = {
+    name: 'Pool',
+    methods: [
+        {
+            name: 'set_governor',
+            args: [
+                {
+                    type: 'account',
+                    name: 'new_governor'
+                }
+            ],
+            returns: {
+                type: 'void'
+            },
+            desc: 'sets the governor of the contract, may only be called by the current governor'
+        },
+        {
+            name: 'bootstrap',
+            args: [
+                {
+                    type: 'uint64',
+                    name: 'asset_a'
+                },
+                {
+                    type: 'uint64',
+                    name: 'asset_b'
+                }
+            ],
+            returns: {
+                type: 'void'
+            },
+            desc: 'bootstraps the contract by opting into the assets and creating the pool token.'
+        },
+        {
+            name: 'fund',
+            args: [
+                {
+                    type: 'txn',
+                    name: 'txn_a'
+                },
+                {
+                    type: 'txn',
+                    name: 'txn_b'
+                }
+            ],
+            returns: {
+                type: 'void'
+            }
+        },
+        {
+            name: 'mint',
+            args: [
+                {
+                    type: 'txn',
+                    name: 'txn_a'
+                },
+                {
+                    type: 'txn',
+                    name: 'txn_b'
+                },
+                {
+                    type: 'uint64',
+                    name: 'min_out_amt'
+                }
+            ],
+            returns: {
+                type: 'void'
+            }
+        },
+        {
+            name: 'burn',
+            args: [
+                {
+                    type: 'axfer',
+                    name: 'txn'
+                },
+                {
+                    type: 'uint64',
+                    name: 'min_out_amt_a'
+                },
+                {
+                    type: 'uint64',
+                    name: 'min_out_amt_b'
+                }
+            ],
+            returns: {
+                type: 'void'
+            }
+        },
+        {
+            name: 'swap',
+            args: [
+                {
+                    type: 'txn',
+                    name: 'txn'
+                },
+                {
+                    type: 'uint64',
+                    name: 'min_swap_amt'
+                }
+            ],
+            returns: {
+                type: 'uint64'
+            }
+        },
+        {
+            name: 'redeem',
+            args: [
+                {
+                    type: 'uint64',
+                    name: 'amount'
+                }
+            ],
+            returns: {
+                type: 'void'
+            }
+        }
+    ],
+    networks: {}
+};

package/dist/artifacts/stable.d.ts

@@ -0,0 +1,25 @@
+export declare const STABLE_ABI: {
+    name: string;
+    methods: ({
+        name: string;
+        args: {
+            type: string;
+            name: string;
+        }[];
+        returns: {
+            type: string;
+        };
+        desc: string;
+    } | {
+        name: string;
+        args: {
+            type: string;
+            name: string;
+        }[];
+        returns: {
+            type: string;
+        };
+        desc?: undefined;
+    })[];
+    networks: {};
+};

package/dist/artifacts/stable.js

@@ -0,0 +1,155 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.STABLE_ABI = void 0;
+exports.STABLE_ABI = {
+    name: 'StablePool',
+    methods: [
+        {
+            name: 'set_governor',
+            args: [
+                {
+                    type: 'account',
+                    name: 'new_governor'
+                }
+            ],
+            returns: {
+                type: 'void'
+            },
+            desc: 'sets the governor of the contract, may only be called by the current governor'
+        },
+        {
+            name: 'bootstrap',
+            args: [
+                {
+                    type: 'uint64',
+                    name: 'asset_a'
+                },
+                {
+                    type: 'uint64',
+                    name: 'asset_b'
+                }
+            ],
+            returns: {
+                type: 'void'
+            },
+            desc: 'bootstraps the contract by opting into the assets and creating the pool token.'
+        },
+        {
+            name: 'fund',
+            args: [
+                {
+                    type: 'axfer',
+                    name: 'txn_a'
+                },
+                {
+                    type: 'axfer',
+                    name: 'txn_b'
+                }
+            ],
+            returns: {
+                type: 'void'
+            }
+        },
+        {
+            name: 'mint',
+            args: [
+                {
+                    type: 'uint64',
+                    name: 'a_amt'
+                },
+                {
+                    type: 'uint64',
+                    name: 'b_amt'
+                },
+                {
+                    type: 'uint64',
+                    name: 'min_out_amt'
+                },
+                {
+                    type: 'axfer',
+                    name: 'txn_a'
+                },
+                {
+                    type: 'axfer',
+                    name: 'txn_b'
+                }
+            ],
+            returns: {
+                type: 'void'
+            }
+        },
+        {
+            name: 'burn',
+            args: [
+                {
+                    type: 'axfer',
+                    name: 'txn'
+                },
+                {
+                    type: 'uint64',
+                    name: 'min_out_amt_a'
+                },
+                {
+                    type: 'uint64',
+                    name: 'min_out_amt_b'
+                }
+            ],
+            returns: {
+                type: 'void'
+            }
+        },
+        {
+            name: 'burn_imbalance',
+            args: [
+                {
+                    type: 'uint64',
+                    name: 'a_amt'
+                },
+                {
+                    type: 'uint64',
+                    name: 'b_amt'
+                },
+                {
+                    type: 'uint64',
+                    name: 'max_burn_amt'
+                },
+                {
+                    type: 'axfer',
+                    name: 'txn'
+                }
+            ],
+            returns: {
+                type: 'void'
+            }
+        },
+        {
+            name: 'swap',
+            args: [
+                {
+                    type: 'axfer',
+                    name: 'txn'
+                },
+                {
+                    type: 'uint64',
+                    name: 'min_swap_amt'
+                }
+            ],
+            returns: {
+                type: 'uint64'
+            }
+        },
+        {
+            name: 'redeem',
+            args: [
+                {
+                    type: 'uint64',
+                    name: 'amount'
+                }
+            ],
+            returns: {
+                type: 'void'
+            }
+        }
+    ],
+    networks: {}
+};

package/dist/constants.d.ts

@@ -0,0 +1,6 @@
+export declare const ALGO: {
+    id: number;
+    name: string;
+    unitName: string;
+    decimals: number;
+};

package/dist/constants.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ALGO = void 0;
+exports.ALGO = {
+    id: 0,
+    name: 'ALGO',
+    unitName: 'ALGO',
+    decimals: 6
+};

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './amm';
+export * from './constants';
+export * from './types';

package/dist/index.js

@@ -0,0 +1,19 @@
+"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("./amm"), exports);
+__exportStar(require("./constants"), exports);
+__exportStar(require("./types"), exports);

package/dist/types.d.ts

@@ -0,0 +1,57 @@
+export type PoolTypes = 'STABLE' | 'CONSTANT_PRODUCT';
+export type IAssetAmt = {
+    assetA: bigint;
+    assetB: bigint;
+};
+export interface TokenPair {
+    aId: number;
+    aName: string;
+    aUnitName: string;
+    aDecimals: number;
+    bId: number;
+    bName: string;
+    bUnitName: string;
+    bDecimals: number;
+    poolId: number;
+    poolToken: number;
+    poolState: PoolState;
+    fee: number;
+    type: PoolTypes;
+}
+export interface IndexerAssetParams {
+    creator: string;
+    decimals: number;
+    'default-frozen': boolean;
+    name: string;
+    'name-b64': string;
+    total: number;
+    'unit-name': string;
+    'unit-name-b64': string;
+}
+export interface IndexerAsset {
+    index: number;
+    params: IndexerAssetParams;
+}
+export interface AssetList {
+    [key: number]: IndexerAsset;
+}
+export interface PoolList {
+    [key: string]: TokenPair;
+}
+export interface PoolState {
+    a: number;
+    b: number;
+    set: number;
+    ra: number;
+    rb: number;
+    ma: number;
+    f?: number;
+    p: number;
+    pt?: PoolTypes;
+    gov: string;
+}
+export interface StablePoolState extends PoolState {
+    ad: number;
+    bd: number;
+    amp: number;
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils.d.ts

@@ -0,0 +1,4 @@
+import { ABIContract, ABIMethod } from 'algosdk';
+export declare function sqrt(value: bigint): bigint;
+export declare function getMethodByName(contract: ABIContract, name: string): ABIMethod;
+export declare function decodeStateArray(stateArray: any[]): any;

package/dist/utils.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decodeStateArray = exports.getMethodByName = exports.sqrt = void 0;
+const algosdk_1 = require("algosdk");
+function sqrt(value) {
+    if (value < BigInt(0)) {
+        throw 'square root of negative numbers is not supported';
+    }
+    if (value < BigInt(2)) {
+        return value;
+    }
+    function newtonIteration(n, x0) {
+        const x1 = (BigInt(n / x0) + x0) >> BigInt(1);
+        if (x0 === x1 || x0 === x1 - BigInt(1)) {
+            return x0;
+        }
+        return newtonIteration(n, x1);
+    }
+    return newtonIteration(value, BigInt(1));
+}
+exports.sqrt = sqrt;
+function getMethodByName(contract, name) {
+    const m = contract.methods.find((mt) => {
+        return mt.name == name;
+    });
+    if (m === undefined)
+        throw Error('Method undefined: ' + name);
+    return m;
+}
+exports.getMethodByName = getMethodByName;
+function decodeStateArray(stateArray) {
+    const state = {};
+    stateArray.forEach((pair) => {
+        const key = Buffer.from(pair['key'], 'base64');
+        let value = pair['value'];
+        const valueType = value['type'];
+        if (valueType == 2)
+            value = value['uint'];
+        if (valueType == 1)
+            value = Buffer.from(value['bytes']);
+        if (key.toString() == 'gov') {
+            state['gov'] = (0, algosdk_1.encodeAddress)(value);
+        }
+        else {
+            state[key.toString()] = value;
+        }
+    });
+    return state;
+}
+exports.decodeStateArray = decodeStateArray;

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@ultrade/ultrade-js-sdk",
+  "version": "0.2.3",
+  "description": "Javascript SDK for interaction with the Ultrade AMM system",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "/dist"
+  ],
+  "directories": {
+    "test": "tests"
+  },
+  "scripts": {
+    "build": "npm run clean && tsc",
+    "test": "ts-mocha -p ./tsconfig.json -t 1000000 tests/**/*.spec.ts",
+    "lint:fix": "prettier */*.js \"*/**/*{.js,.ts}\" -w",
+    "lint": "prettier */*.js \"*/**/*{.js,.ts}\" --check",
+    "prepack": "npm run build",
+    "clean": "rm -rf ./dist"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ultrade-org/JS-SDK.git"
+  },
+  "author": "",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/ultrade-org/JS-SDK/issues"
+  },
+  "homepage": "https://github.com/ultrade-org/JS-SDK#readme",
+  "devDependencies": {
+    "@types/chai": "^4.3.1",
+    "@types/mocha": "^9.1.1",
+    "@types/node": "^18.0.6",
+    "chai": "^4.3.6",
+    "dotenv": "^16.0.1",
+    "mocha": "^10.0.0",
+    "prettier": "^2.7.1",
+    "ts-mocha": "^10.0.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.7.4"
+  },
+  "dependencies": {
+    "algosdk": "^2.1.0"
+  },
+  "keywords": ["Ultrade", "DEX", "AMM", "SDK"]
+}