@ibearua/bitmask-core-dev 1.0.0-beta.11 → 1.0.0-beta.13

package/rgb.d.ts

@@ -0,0 +1,363 @@
+export declare const getVersion: () => string;
+export declare const getContract: (nostrHexSk: string, request: string) => Promise<ContractResponse>;
+export declare const listContracts: (nostrHexSk: string, hidden: boolean) => Promise<ContractResponse[]>;
+export declare const importContract: (nostrHexSk: string, request: string) => Promise<ContractResponse>;
+export declare const issueContract: (nostrHexSk: string, request: IssueRequest) => Promise<IssueResponse>;
+export declare const createInvoice: (nostrHexSk: string, request: RgbInvoiceRequest) => Promise<RgbInvoiceResponse>;
+export declare const canCreateTransfer: (nostrHexSk: string, request: RgbTransferRequest) => Promise<RgbValidationResponse>;
+export declare const createTransfer: (nostrHexSk: string, request: RgbTransferRequest) => Promise<RgbTransferResponse>;
+export declare const createAndPublishTransfer: (nostrHexSk: string, request: RgbTransferRequest, secrets: string[]) => Promise<RgbTransferResponse>;
+export declare const acceptTransfer: (nostrHexSk: string, request: AcceptRequest) => Promise<AcceptResponse>;
+export declare const removeInvoice: (nostrHexSk: string, request: string) => Promise<void>;
+export declare const listInvoices: (nostrHexSk: string) => Promise<RgbInvoiceStatusResponse[]>;
+export declare const saveTransfer: (nostrHexSk: string, request: SaveTransferRequest) => Promise<RgbTransferItem>;
+export declare const listTransfers: (nostrHexSk: string) => Promise<RgbTransferItem[]>;
+export declare const verifyTransfers: (nostrHexSk: string) => Promise<RgbTransferItem[]>;
+export declare const listOffers: (nostrHexSk: string) => Promise<RgbOfferResponse[]>;
+export declare const offers: (nostrHexSk: string) => Promise<RgbOfferResponse[]>;
+export declare const bids: (nostrHexSk: string) => Promise<WatcherWalletResponse>;
+export declare const offerSwapSuppl: (nostrHexSk: string, offerId: string) => Promise<SwapSupplement>;
+export declare const bidSwapSuppl: (nostrHexSk: string, bidId: string) => Promise<SwapSupplement>;
+export declare const canCreateOffer: (nostrHexSk: string, request: RgbOfferRequest, secrets: string[]) => Promise<RgbValidationResponse>;
+export declare const createOffer: (nostrHexSk: string, request: RgbOfferRequest, secrets: string[]) => Promise<RgbOfferResponse>;
+export declare const cancelOffer: (nostrHexSk: string, request: RgbCancelOffersRequest) => Promise<RgbSwapCancelResponse>;
+export declare const canCreateBid: (nostrHexSk: string, request: RgbBidRequest, secrets: string[]) => Promise<RgbValidationResponse>;
+export declare const createBid: (nostrHexSk: string, request: RgbBidRequest, secrets: string[]) => Promise<RgbBidResponse>;
+export declare const cancelBid: (nostrHexSk: string, request: RgbCancelBidsRequest) => Promise<RgbSwapCancelResponse>;
+export declare const backupWallet: (nostrHexSk: string) => Promise<boolean>;
+export declare const restoreWallet: (nostrHexSk: string) => Promise<boolean>;
+export declare const getRgbWallet: (nostrHexSk: string) => Promise<WatcherWalletResponse>;
+export declare const decodeInvoice: (invoice: string) => Promise<RgbInvoiceDecoded>;
+export declare const psbtPublishFile: (request: PublishPsbtRequest) => Promise<SignedPsbtResponse>;
+export declare const psbtSignAndPublishFile: (_nostrHexSk: string, request: SignPsbtRequest) => Promise<PublishedPsbtResponse>;
+export declare const toContractAmountRaw: (decimal: string, precision: number) => string;
+export declare const toContractAmountStr: (amount: bigint, precision: number) => string;
+export declare const toContractAmount: (amount: string) => ContractAmount;
+export declare const toContractPrecision: (amount: string, precision: number) => string;
+export interface RgbContainer {
+    rgbStock?: string;
+    rgbAccount?: string;
+    rgbTransfers?: string;
+}
+export interface IssueRequest {
+    ticker: string;
+    name: string;
+    iface: string;
+    description: string;
+    supply: string;
+    precision: number;
+    seal: string;
+    chain: string;
+    meta?: IssueMedia;
+}
+export type ChainFee = {
+    value?: bigint;
+    feeRate?: number;
+    none?: string;
+};
+export interface IssueMedia {
+    preview?: MediaData;
+    media?: MediaData;
+    attachments: MediaData[];
+}
+export interface MediaData {
+    type: string;
+    uri: string;
+}
+export type ContractResponse = IssueResponse;
+export interface IssueResponse {
+    contractId: string;
+    iface: string;
+    issueUtxo: string;
+    ticker: string;
+    name: string;
+    created: bigint;
+    description: string;
+    supply: bigint;
+    precision: number;
+    balance: ContractValue;
+    contract: string;
+    allocations: ContractAllocation[];
+    meta?: UDAItem;
+}
+export type ContractValue = {
+    value?: bigint;
+    uda?: UDAValue;
+};
+export interface UDAValue {
+    tokenIndex: number;
+    fraction: bigint;
+}
+export interface ContractAllocation {
+    utxo: string;
+    value: ContractValue;
+    derivation: string;
+    isMine: boolean;
+    isSpent: boolean;
+}
+export interface UDAItem {
+    tokenIndex: number;
+    media: IssueMedia;
+}
+export interface RgbInvoiceRequest {
+    contractId?: string;
+    iface?: string;
+    amount: RgbInvoiceValue;
+    seal: RgbSelection;
+    expireAt?: number;
+}
+export interface RgbSelection {
+    next_utxo?: string;
+    next_address?: string;
+    utxo?: string;
+    address?: string;
+}
+export interface RgbInvoiceValue {
+    value?: string;
+    uda?: UDAValue;
+}
+export interface RgbInvoiceResponse {
+    invoice: string;
+}
+export interface RgbInvoiceStatusResponse {
+    assetName: String;
+    assetTicker: String;
+    contractId: String;
+    amount: RgbInvoiceValue;
+    status: RgbInvoiceStatus;
+    invoice: String;
+}
+export type RgbInvoiceStatusItem = RgbInvoiceStatusResponse;
+export interface RgbInvoiceStatus {
+    opened?: string;
+    payed?: string;
+    canceled?: string;
+}
+export interface RgbTransferRequest {
+    contractId: string;
+    iface: string;
+    invoice: string;
+    senderAmount?: RgbInvoiceValue;
+    chain: string;
+    chainFee: ChainFee;
+}
+export interface RgbTransferResponse {
+    consigId: string;
+    consig: string;
+    txid: string;
+    psbt: string;
+    commit?: string;
+}
+export interface AcceptRequest {
+    consignment: string;
+    force: boolean;
+}
+export interface SaveTransferRequest {
+    consignment: string;
+}
+export interface AcceptResponse {
+    transferId: string;
+    contractId: string;
+    valid: boolean;
+    txid: string;
+}
+export interface RgbTransferItem {
+    contractId: String;
+    iface: String;
+    direction: Direction;
+}
+export interface Direction {
+    in?: TransferIn;
+    out?: TransferOut;
+}
+export interface TransferIn {
+    txId: String;
+    txStatus: TxStatus;
+    invoice: String;
+    transfer?: TransferItem;
+    amount?: ContractAmount;
+    uda?: UDAValue;
+}
+export interface TransferOut {
+    txId: String;
+    txStatus: TxStatus;
+    invoice: String;
+    transfer: TransferItem;
+    amount?: ContractAmount;
+    uda?: UDAValue;
+}
+export interface TransferItem {
+    transferId: String;
+    transfer: String;
+    isAccept: boolean;
+}
+export interface SignPsbtRequest {
+    psbt: string;
+    descriptors: string[];
+}
+export interface SignedPsbtResponse {
+    sign: boolean;
+    psbt: string;
+}
+export interface PublishPsbtRequest {
+    psbt: string;
+}
+export interface PublishedPsbtResponse {
+    sign: boolean;
+    txid: string;
+}
+export interface WatcherRequest {
+    name: string;
+    btcXpub: string;
+    rgbXpub: string;
+    recover: boolean;
+}
+export interface WatcherResponse {
+    name: string;
+    network: string;
+    migrate: boolean;
+}
+export interface WatcherStatusResponse {
+    name: string;
+    created: boolean;
+}
+export interface WatcherStatusResponse {
+    name: string;
+    created: boolean;
+}
+export interface WatcherWalletResponse {
+    nextUtxo?: string;
+    nextUtxoValue?: number;
+    nextAddress?: string;
+    listContracts: ContractResponse[];
+    transfers: RgbTransferItem[];
+    invoices: RgbInvoiceStatusItem[];
+}
+export interface NextUtxoResponse {
+    utxo?: string;
+    value?: number;
+}
+export interface NextAddressResponse {
+    address: string;
+    network: string;
+}
+export interface TxStatus {
+    notFound?: any;
+    error?: string;
+    mempool?: any;
+    block?: {
+        height: number;
+        timestamp: number;
+    };
+    confirmed?: string;
+}
+export interface RgbInvoiceDecoded {
+    contractId: string;
+    amount: RgbInvoiceValue;
+    expiry?: number;
+    endpoints?: string[];
+}
+export interface ContractAmount {
+    int: number;
+    fract: number;
+    precision: number;
+}
+export interface RgbOfferRequest {
+    strategy: RgbSwap;
+    offers: RgbOfferItem[];
+}
+export declare enum RgbSwap {
+    auction = "auction",
+    p2p = "p2p",
+    hotSwap = "hotswap",
+    airdrop = "airdrop"
+}
+export interface RgbOfferItem {
+    contractId: string;
+    contractAmount: string;
+    counterParty: OrderValue;
+    expireAt?: number;
+}
+export interface RgbOfferResponse {
+    id: string;
+    status: string;
+    contract: ContractKit;
+    amount: ContractAmount;
+    counterParty: OrderValue;
+}
+export interface RgbBidRequest {
+    offerId: string;
+    assetPrice: OrderValue;
+    fee: ChainFee;
+    bundle?: string;
+}
+export interface RgbBidResponse {
+    id: string;
+    offerId: string;
+    status: string;
+    asset: AssetKit;
+    amount: ContractAmount;
+    counterParty: OrderValue;
+    txid: string;
+}
+export interface RgbAuctionCloseRequest {
+    bundleId: string;
+}
+export interface RgbSwapRequest {
+    offerId: string;
+    bidId: string;
+    sharedKey: string;
+}
+export interface RgbSwapResponse {
+    consigId: string;
+    consig: string;
+    txid: string;
+    psbt: string;
+}
+export interface RgbCancelOffersRequest {
+    offers: string[];
+}
+export interface RgbCancelBidsRequest {
+    bids: string[];
+}
+export interface RgbSwapCancelResponse {
+    records: number;
+    offers: string[];
+    bids: string[];
+}
+export interface RgbValidationResponse {
+    valid: boolean;
+    message: string;
+    warnings: string[];
+    failures: string[];
+}
+export interface ContractKit {
+    info: ContractInfo;
+    armored: string;
+}
+export interface ContractInfo {
+    contractId: string;
+    contractType: string;
+    name: string;
+    ticker: string;
+    precision: number;
+}
+export interface AssetKit {
+    bitcoin?: string;
+    contract?: ContractKit;
+}
+export interface OrderValue {
+    bitcoin?: BigInt;
+    contract?: ContractCounterParty;
+}
+export interface ContractCounterParty {
+    kit: ContractKit;
+    amount: ContractAmount;
+}
+export interface SwapSupplement {
+    transferId: string;
+    transfer: string;
+    tapret: string;
+    psbt: string;
+}
+//# sourceMappingURL=rgb.d.ts.map

package/rgb.js

@@ -0,0 +1,120 @@
+"use strict";
+// Methods meant to work with RGB contracts defined within the web::rgb module from bitmask-core:
+// https://github.com/diba-io/bitmask-core/blob/development/src/web.rs
+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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RgbSwap = exports.toContractPrecision = exports.toContractAmount = exports.toContractAmountStr = exports.toContractAmountRaw = exports.psbtSignAndPublishFile = exports.psbtPublishFile = exports.decodeInvoice = exports.getRgbWallet = exports.restoreWallet = exports.backupWallet = exports.cancelBid = exports.createBid = exports.canCreateBid = exports.cancelOffer = exports.createOffer = exports.canCreateOffer = exports.bidSwapSuppl = exports.offerSwapSuppl = exports.bids = exports.offers = exports.listOffers = exports.verifyTransfers = exports.listTransfers = exports.saveTransfer = exports.listInvoices = exports.removeInvoice = exports.acceptTransfer = exports.createAndPublishTransfer = exports.createTransfer = exports.canCreateTransfer = exports.createInvoice = exports.issueContract = exports.importContract = exports.listContracts = exports.getContract = exports.getVersion = void 0;
+const BMC = __importStar(require("./bitmask_core"));
+const getVersion = () => JSON.parse(BMC.get_rgb_version());
+exports.getVersion = getVersion;
+const getContract = (nostrHexSk, request) => __awaiter(void 0, void 0, void 0, function* () { return JSON.parse(yield BMC.get_contract(nostrHexSk, request)); });
+exports.getContract = getContract;
+const listContracts = (nostrHexSk, hidden) => __awaiter(void 0, void 0, void 0, function* () { return JSON.parse(yield BMC.list_contracts(nostrHexSk, hidden)); });
+exports.listContracts = listContracts;
+const importContract = (nostrHexSk, request) => __awaiter(void 0, void 0, void 0, function* () { return JSON.parse(yield BMC.import_contract(nostrHexSk, request)); });
+exports.importContract = importContract;
+const issueContract = (nostrHexSk, request) => __awaiter(void 0, void 0, void 0, function* () { return JSON.parse(yield BMC.issue_contract_proxy(nostrHexSk, request)); });
+exports.issueContract = issueContract;
+const createInvoice = (nostrHexSk, request) => __awaiter(void 0, void 0, void 0, function* () { return JSON.parse(yield BMC.create_rgb_invoice(nostrHexSk, request)); });
+exports.createInvoice = createInvoice;
+const canCreateTransfer = (nostrHexSk, request) => __awaiter(void 0, void 0, void 0, function* () { return JSON.parse(yield BMC.can_create_transfer_contract(nostrHexSk, request)); });
+exports.canCreateTransfer = canCreateTransfer;
+const createTransfer = (nostrHexSk, request) => __awaiter(void 0, void 0, void 0, function* () { return JSON.parse(yield BMC.create_rgb_transfer(nostrHexSk, request)); });
+exports.createTransfer = createTransfer;
+const createAndPublishTransfer = (nostrHexSk, request, secrets) => __awaiter(void 0, void 0, void 0, function* () { return JSON.parse(yield BMC.create_and_publish_rgb_transfer(nostrHexSk, request, secrets)); });
+exports.createAndPublishTransfer = createAndPublishTransfer;
+const acceptTransfer = (nostrHexSk, request) => __awaiter(void 0, void 0, void 0, function* () { return JSON.parse(yield BMC.accept_transfer(nostrHexSk, request)); });
+exports.acceptTransfer = acceptTransfer;
+const removeInvoice = (nostrHexSk, request) => __awaiter(void 0, void 0, void 0, function* () {
+    yield BMC.remove_rgb_invoice(nostrHexSk, request);
+});
+exports.removeInvoice = removeInvoice;
+const listInvoices = (nostrHexSk) => __awaiter(void 0, void 0, void 0, function* () { return JSON.parse(yield BMC.list_rgb_invoices(nostrHexSk)); });
+exports.listInvoices = listInvoices;
+const saveTransfer = (nostrHexSk, request) => __awaiter(void 0, void 0, void 0, function* () { return JSON.parse(yield BMC.save_transfer(nostrHexSk, request)); });
+exports.saveTransfer = saveTransfer;
+const listTransfers = (nostrHexSk) => __awaiter(void 0, void 0, void 0, function* () { return JSON.parse(yield BMC.list_transfers(nostrHexSk)); });
+exports.listTransfers = listTransfers;
+const verifyTransfers = (nostrHexSk) => __awaiter(void 0, void 0, void 0, function* () { return JSON.parse(yield BMC.verify_transfers(nostrHexSk)); });
+exports.verifyTransfers = verifyTransfers;
+const listOffers = (nostrHexSk) => __awaiter(void 0, void 0, void 0, function* () { return JSON.parse(yield BMC.list_offers(nostrHexSk)); });
+exports.listOffers = listOffers;
+const offers = (nostrHexSk) => __awaiter(void 0, void 0, void 0, function* () { return JSON.parse(yield BMC.offers(nostrHexSk)); });
+exports.offers = offers;
+const bids = (nostrHexSk) => __awaiter(void 0, void 0, void 0, function* () { return JSON.parse(yield BMC.bids(nostrHexSk)); });
+exports.bids = bids;
+const offerSwapSuppl = (nostrHexSk, offerId) => __awaiter(void 0, void 0, void 0, function* () { return JSON.parse(yield BMC.offer_swap_suppl(nostrHexSk, offerId)); });
+exports.offerSwapSuppl = offerSwapSuppl;
+const bidSwapSuppl = (nostrHexSk, bidId) => __awaiter(void 0, void 0, void 0, function* () { return JSON.parse(yield BMC.bid_swap_suppl(nostrHexSk, bidId)); });
+exports.bidSwapSuppl = bidSwapSuppl;
+const canCreateOffer = (nostrHexSk, request, secrets) => __awaiter(void 0, void 0, void 0, function* () { return JSON.parse(yield BMC.can_create_offer(nostrHexSk, request, secrets)); });
+exports.canCreateOffer = canCreateOffer;
+const createOffer = (nostrHexSk, request, secrets) => __awaiter(void 0, void 0, void 0, function* () { return JSON.parse(yield BMC.create_offer(nostrHexSk, request, secrets)); });
+exports.createOffer = createOffer;
+const cancelOffer = (nostrHexSk, request) => __awaiter(void 0, void 0, void 0, function* () { return JSON.parse(yield BMC.cancel_offer(nostrHexSk, request)); });
+exports.cancelOffer = cancelOffer;
+const canCreateBid = (nostrHexSk, request, secrets) => __awaiter(void 0, void 0, void 0, function* () { return JSON.parse(yield BMC.can_create_bid(nostrHexSk, request, secrets)); });
+exports.canCreateBid = canCreateBid;
+const createBid = (nostrHexSk, request, secrets) => __awaiter(void 0, void 0, void 0, function* () { return JSON.parse(yield BMC.create_bid(nostrHexSk, request, secrets)); });
+exports.createBid = createBid;
+const cancelBid = (nostrHexSk, request) => __awaiter(void 0, void 0, void 0, function* () { return JSON.parse(yield BMC.cancel_bid(nostrHexSk, request)); });
+exports.cancelBid = cancelBid;
+// BITCOIN
+const backupWallet = (nostrHexSk) => __awaiter(void 0, void 0, void 0, function* () { return JSON.parse(yield BMC.backup_rgb_data(nostrHexSk)); });
+exports.backupWallet = backupWallet;
+const restoreWallet = (nostrHexSk) => __awaiter(void 0, void 0, void 0, function* () { return JSON.parse(yield BMC.restore_rgb_data(nostrHexSk)); });
+exports.restoreWallet = restoreWallet;
+const getRgbWallet = (nostrHexSk) => __awaiter(void 0, void 0, void 0, function* () { return JSON.parse(yield BMC.get_rgb_wallet(nostrHexSk)); });
+exports.getRgbWallet = getRgbWallet;
+const decodeInvoice = (invoice) => __awaiter(void 0, void 0, void 0, function* () { return JSON.parse(yield BMC.decode_rgb_invoice(invoice)); });
+exports.decodeInvoice = decodeInvoice;
+const psbtPublishFile = (request) => __awaiter(void 0, void 0, void 0, function* () { return JSON.parse(yield BMC.psbt_publish_file(request)); });
+exports.psbtPublishFile = psbtPublishFile;
+const psbtSignAndPublishFile = (_nostrHexSk, request) => __awaiter(void 0, void 0, void 0, function* () { return JSON.parse(yield BMC.psbt_sign_and_publish_file(request)); });
+exports.psbtSignAndPublishFile = psbtSignAndPublishFile;
+const toContractAmountRaw = (decimal, precision) => JSON.parse(BMC.convert_contract_amount_raw(decimal, precision));
+exports.toContractAmountRaw = toContractAmountRaw;
+const toContractAmountStr = (amount, precision) => JSON.parse(BMC.convert_contract_amount_string(amount, precision));
+exports.toContractAmountStr = toContractAmountStr;
+const toContractAmount = (amount) => JSON.parse(BMC.parse_contract_amount(amount));
+exports.toContractAmount = toContractAmount;
+const toContractPrecision = (amount, precision) => JSON.parse(BMC.parse_contract_amount_precision(amount, precision));
+exports.toContractPrecision = toContractPrecision;
+var RgbSwap;
+(function (RgbSwap) {
+    RgbSwap["auction"] = "auction";
+    RgbSwap["p2p"] = "p2p";
+    RgbSwap["hotSwap"] = "hotswap";
+    RgbSwap["airdrop"] = "airdrop";
+})(RgbSwap || (exports.RgbSwap = RgbSwap = {}));