ordinalsbot
Advanced tools
Comparing version 0.1.1 to 0.1.2
@@ -16,2 +16,5 @@ export interface InscriptionTransaction { | ||
tx?: InscriptionTransaction; | ||
metadataDataURL?: string; | ||
metadataUrl?: string; | ||
metadataSize?: number; | ||
} | ||
@@ -28,2 +31,3 @@ export interface InscriptionOrderRequest { | ||
webhookUrl?: string; | ||
compress?: boolean; | ||
} | ||
@@ -30,0 +34,0 @@ export interface InscriptionCharge { |
{ | ||
"name": "ordinalsbot", | ||
"version": "0.1.1", | ||
"version": "0.1.2", | ||
"description": "Node.js library for OrdinalsBot API", | ||
@@ -5,0 +5,0 @@ "main": "dist/index.js", |
@@ -108,4 +108,6 @@ # OrdinalsBot Node.js Library | ||
For client-side applications, the methods `marketplace.createListing()`, `marketplace.createOffer()`, and `marketplace.setupPaddingOutputs()` support the `walletProvider` parameter. This optional string parameter allows for specifying the wallet name, with current support for the Xverse wallet and plans to include additional wallets soon. When the `walletProvider` parameter is specified it triggers the invocation of the specified wallet, prompting the user to sign the transaction. This integration significantly streamlines the process by reducing the need for multiple API calls and simplifies the structuring of data required for wallet invocation and transaction signing. Upon successful signing, the method also calls savelisting api with the correct data and returns the saved listing as the response. | ||
For client-side applications, the methods `marketplace.createListing()`, `marketplace.createOffer()`, and `marketplace.setupPaddingOutputs()` support the `walletProvider` parameter. This optional string parameter allows for specifying the wallet name, with current support for the Xverse wallet and plans to include additional wallets soon. When the `walletProvider` parameter is specified it triggers the invocation of the specified wallet, prompting the user to sign the transaction. This integration significantly streamlines the process by reducing the need for multiple API calls and simplifies the structuring of data required for wallet invocation and transaction signing. | ||
The following example demonstrates how to create a listing for sale. When you invoke `marketplace.createListing()` and specify `"xverse"` as the `walletProvider`, it initiates an API call to generate a listing transaction. The method processes the response, formatting the data according to the requirements of the Xverse wallet. Subsequently, the Xverse wallet is activated to prompt the user to sign the transaction. Once the user successfully signs, this method additionally triggers the `save-listing` API, using the appropriately formatted data. Finally, it returns the confirmed listing information as the response. | ||
```js | ||
@@ -133,2 +135,2 @@ | ||
```js | ||
``` |
@@ -31,2 +31,3 @@ export interface InscriptionTransaction { | ||
// only 1 of dataURL or url should be present. not both! | ||
/** Base64 encoded file contents */ | ||
@@ -40,2 +41,10 @@ dataURL?: string; | ||
tx?: InscriptionTransaction; | ||
// only 1 of metadataDataURL or metadataUrl should be present. not both! | ||
/* metadata json to be stored on chain */ | ||
metadataDataURL?: string; | ||
metadataUrl?: string; | ||
metadataSize?: number; | ||
} | ||
@@ -75,2 +84,7 @@ | ||
webhookUrl?: string; | ||
/** Use brotli compression to reduce file sizes on chain | ||
* default=false | ||
*/ | ||
compress?: boolean; | ||
} | ||
@@ -77,0 +91,0 @@ |
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
102064
1839
134