rarible-protocol-mcp
Advanced tools
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *rarible-protocol-mcp* API.
Developer-friendly & type-safe Typescript SDK specifically catered to leverage rarible-protocol-mcp API.
[!IMPORTANT] This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.
OpenAPI definition: # Exciting News
Hey there, amazing developers! 👋
We've got some fantastic news to share that will make your experience with our product even better. We're thrilled to announce the implementation of API-Keys, which brings a new level of control and convenience to your development process. So, let's dive right into the details! ✨
Starting now, we have introduced API-Keys to streamline your interactions with our methods. You might have noticed a slight change while making requests – now, all you need to do is include the parameter X-API-KEY in the Header of your request. Simple as that!
Securing your API-Key is a breeze. We've made the process super user-friendly to ensure you can get started quickly. Just head over to our website and fill out a simple form. Once you've done that, your shiny new API-Key will be delivered straight to your email inbox. Easy peasy! 📧
Get Your API-Key Here Configure SDK with API-key
As passionate developers, we know you're always hungry for knowledge and eager to explore new frontiers. That's why we invite you to discover the incredible world of the Rarible Protocol. By visiting our dedicated protocol page, you'll gain access to a treasure trove of useful information, tips, and insights that will elevate your development skills to new heights. 🚀
So, buckle up and get ready for an enhanced development journey with our API-Keys. We're excited to see what you'll create using our revamped system! 💪🚀
Stay curious, keep innovating, and happy coding! ✨
P.S. Join our Discord Server to stay up to date and ask questions
[!TIP] To finish publishing your SDK to npm and others you must run your first generation action.
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
npm add <UNSET>
pnpm add <UNSET>
bun add <UNSET>
yarn add <UNSET> zod
# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.
[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.
This SDK is also an installable MCP server where the various SDK methods are exposed as tools that can be invoked by AI applications.
Node.js v20 or greater is required to run the MCP server from npm.
Add the following server definition to your claude_desktop_config.json file:
{
"mcpServers": {
"RaribleProtocol": {
"command": "npx",
"args": [
"-y", "--package", "rarible-protocol-mcp",
"--",
"mcp", "start",
"--api-key-auth", "..."
]
}
}
}
Create a .cursor/mcp.json file in your project root with the following content:
{
"mcpServers": {
"RaribleProtocol": {
"command": "npx",
"args": [
"-y", "--package", "rarible-protocol-mcp",
"--",
"mcp", "start",
"--api-key-auth", "..."
]
}
}
}
You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:
curl -L -o mcp-server \
https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
chmod +x mcp-server
If the repo is a private repo you must add your Github PAT to download a release -H "Authorization: Bearer {GITHUB_PAT}".
{
"mcpServers": {
"Todos": {
"command": "./DOWNLOAD/PATH/mcp-server",
"args": [
"start"
]
}
}
}
For a full list of server arguments, run:
npx -y --package rarible-protocol-mcp -- mcp start --help
For supported JavaScript runtimes, please consult RUNTIMES.md.
import { RaribleProtocol } from "rarible-protocol-mcp";
const raribleProtocol = new RaribleProtocol({
apiKeyAuth: process.env["RARIBLEPROTOCOL_API_KEY_AUTH"] ?? "",
});
async function run() {
const result = await raribleProtocol.gatewayController
.createGatewayPendingTransactions({
hash: "<value>",
from: "0x60f80121c31a0d46b5279700f9df786054aa5ee5",
nonce: 527347,
to: "0x60f80121c31a0d46b5279700f9df786054aa5ee5",
input: "<value>",
});
// Handle the result
console.log(result);
}
run();
This SDK supports the following security scheme globally:
| Name | Type | Scheme | Environment Variable |
|---|---|---|---|
apiKeyAuth | apiKey | API key | RARIBLEPROTOCOL_API_KEY_AUTH |
To authenticate with the API the apiKeyAuth parameter must be set when initializing the SDK client instance. For example:
import { RaribleProtocol } from "rarible-protocol-mcp";
const raribleProtocol = new RaribleProtocol({
apiKeyAuth: process.env["RARIBLEPROTOCOL_API_KEY_AUTH"] ?? "",
});
async function run() {
const result = await raribleProtocol.gatewayController
.createGatewayPendingTransactions({
hash: "<value>",
from: "0x60f80121c31a0d46b5279700f9df786054aa5ee5",
nonce: 527347,
to: "0x60f80121c31a0d46b5279700f9df786054aa5ee5",
input: "<value>",
});
// Handle the result
console.log(result);
}
run();
All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.
To read more about standalone functions, check FUNCTIONS.md.
balanceControllerGetErc20Allowance - Return ERC20 token allowancebalanceControllerGetErc20Balance - Return ERC20 token balancebalanceControllerGetEthBalance - Return ETH balanceerc20TokenControllerGetErc20TokenById - Return ERC20 token balance by IDgatewayControllerCreateGatewayPendingTransactionsnftActivityControllerGetNftActivitiesByIdnftActivityControllerGetNftActivitiesSyncnftBlockControllerGetLatestIndexedBlock - Get latest indexed blocknftCollectionControllerGenerateNftTokenId - Returns next available tokenId for minternftCollectionControllerGetCollectionMeta - Returns collection by addressnftCollectionControllerGetNftCollectionById - Returns collection by addressnftCollectionControllerGetNftCollectionsByIds - Returns collections by idsnftCollectionControllerSearchNftAllCollections - Returns all NFT collectionsnftCollectionControllerSearchNftCollectionsByOwner - Returns collection by ownernftDomainControllerGetDomainById - Get domain by idnftDomainControllerResolveDomainByName - Resolve domain by namenftItemControllerDeleteLazyMintNftAsset - Delete Lazy mint of NFTnftItemControllerGetNftAllItems - Returns all NFT itemsnftItemControllerGetNftItemById - Returns the NFT item by identifiernftItemControllerGetNftItemMetaById - Returns metadata of specified NFT itemnftItemControllerGetNftItemRoyaltyById - Returns item royalty by identifiernftItemControllerGetNftItemsByCollection - Returns the NFT items by collectionnftItemControllerGetNftItemsByCreator - Returns the NFT item by creatornftItemControllerGetNftItemsByIds - Returns the NFT item by identifiernftItemControllerGetNftItemsByOwner - Returns the NFT item by ownernftItemControllerGetNftLazyItemById - Returns the NFT lazy item by identifiernftLazyMintControllerMintNftAsset - Lazy mint of NFTnftOwnershipControllerGetNftAllOwnershipsnftOwnershipControllerGetNftOwnershipByIdnftOwnershipControllerGetNftOwnershipsByIds - Returns ownerships by idsnftOwnershipControllerGetNftOwnershipsByItemnftOwnershipControllerGetNftOwnershipsByOwnernftTransactionControllerCreateNftPendingTransaction - Create pending transaction for NFTorderActivityControllerGetOrderActivitiesByIdorderActivityControllerGetOrderActivitiesSync - Returns event history with orderorderActivityControllerGetOrderRevertedActivitiesSync - Returns reverted event history with orderorderControllerBuyerFeeSignature - Buyer's signature for a feeorderControllerGetAllSync - Returns all orders with dbUpdatedAt sortingorderControllerGetByIds - Returns all orders by order hashorderControllerGetCurrenciesByBidOrdersOfItem - Returns currencies made as payment in all bid orders of the itemorderControllerGetCurrenciesBySellOrdersOfItem - Returns currencies taken as payment in all sell orders of the itemorderControllerGetOrderBidsByItemAndByStatus - Returns all order bids by item and order statusorderControllerGetOrderBidsByMakerAndByStatus - Returns all order bids by maker and order statusorderControllerGetOrderByHash - Returns the order by order hashorderControllerGetOrdersAllByStatus - Returns all orders with status sortingorderControllerGetSellOrdersByCollectionAndByStatus - Returns all orders for sale by collection and order statusorderControllerGetSellOrdersByItemAndByStatus - Returns all orders for sale by item and order statusorderControllerGetSellOrdersByMakerAndByStatus - Returns all orders for sale by maker and order statusorderControllerGetSellOrdersByStatus - Returns all orders for sale by order statusorderControllerGetValidatedOrderByHash - Returns validated order by order hashorderControllerPrepareOrderCancelTransaction - Prepare order for cancel transactionorderControllerPrepareOrderTransaction - Prepare order transaction.orderControllerReportOrder - Report not working orderorderControllerUpdateOrderMakeStock - Update stock of the order by order hashorderControllerUpsertOrder - Create or update orderorderSettingsControllerGetFees - Returns set fees for different order typesorderSignatureControllerGetSeaportOrderSignature - Fetch Seaport order signatureorderSignatureControllerValidate - Validation of the order signatureorderTransactionControllerCreateOrderPendingTransaction - Create pending transaction for ordernftItemControllerResetNftItemMetaByIdorderBidControllerGetBidsByItemorderControllerGetOrderBidsByItemorderControllerGetOrdersAllorderControllerGetOrdersByIdsorderControllerGetSellOrdersorderControllerGetSellOrdersByCollectionorderControllerGetSellOrdersByItemorderEncodeControllerEncodeOrderorderEncodeControllerEncodeOrderAssetTypeorderEncodeControllerEncodeOrderDataSome of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
import { RaribleProtocol } from "rarible-protocol-mcp";
const raribleProtocol = new RaribleProtocol({
apiKeyAuth: process.env["RARIBLEPROTOCOL_API_KEY_AUTH"] ?? "",
});
async function run() {
const result = await raribleProtocol.gatewayController
.createGatewayPendingTransactions({
hash: "<value>",
from: "0x60f80121c31a0d46b5279700f9df786054aa5ee5",
nonce: 527347,
to: "0x60f80121c31a0d46b5279700f9df786054aa5ee5",
input: "<value>",
}, {
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});
// Handle the result
console.log(result);
}
run();
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
import { RaribleProtocol } from "rarible-protocol-mcp";
const raribleProtocol = new RaribleProtocol({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
apiKeyAuth: process.env["RARIBLEPROTOCOL_API_KEY_AUTH"] ?? "",
});
async function run() {
const result = await raribleProtocol.gatewayController
.createGatewayPendingTransactions({
hash: "<value>",
from: "0x60f80121c31a0d46b5279700f9df786054aa5ee5",
nonce: 527347,
to: "0x60f80121c31a0d46b5279700f9df786054aa5ee5",
input: "<value>",
});
// Handle the result
console.log(result);
}
run();
Some methods specify known errors which can be thrown. All the known errors are enumerated in the models/errors/errors.ts module. The known errors for a method are documented under the Errors tables in SDK docs. For example, the createGatewayPendingTransactions method may throw the following errors:
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.GatewayApiError | 500 | application/json |
| errors.APIError | 4XX, 5XX | */* |
If the method throws an error and it is not captured by the known errors, it will default to throwing a APIError.
import { RaribleProtocol } from "rarible-protocol-mcp";
import {
GatewayApiError,
SDKValidationError,
} from "rarible-protocol-mcp/models/errors";
const raribleProtocol = new RaribleProtocol({
apiKeyAuth: process.env["RARIBLEPROTOCOL_API_KEY_AUTH"] ?? "",
});
async function run() {
let result;
try {
result = await raribleProtocol.gatewayController
.createGatewayPendingTransactions({
hash: "<value>",
from: "0x60f80121c31a0d46b5279700f9df786054aa5ee5",
nonce: 527347,
to: "0x60f80121c31a0d46b5279700f9df786054aa5ee5",
input: "<value>",
});
// Handle the result
console.log(result);
} catch (err) {
switch (true) {
// The server response does not match the expected SDK schema
case (err instanceof SDKValidationError): {
// Pretty-print will provide a human-readable multi-line error message
console.error(err.pretty());
// Raw value may also be inspected
console.error(err.rawValue);
return;
}
case (err instanceof GatewayApiError): {
// Handle err.data$: GatewayApiErrorData
console.error(err);
return;
}
default: {
// Other errors such as network errors, see HTTPClientErrors for more details
throw err;
}
}
}
}
run();
Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.
In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the models/errors/httpclienterrors.ts module:
| HTTP Client Error | Description |
|---|---|
| RequestAbortedError | HTTP request was aborted by the client |
| RequestTimeoutError | HTTP request timed out due to an AbortSignal signal |
| ConnectionError | HTTP client was unable to make a request to a server |
| InvalidRequestError | Any input used to create a request is invalid |
| UnexpectedClientError | Unrecognised or unexpected error |
The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:
import { RaribleProtocol } from "rarible-protocol-mcp";
const raribleProtocol = new RaribleProtocol({
serverURL: "https://ethereum-api.rarible.org",
apiKeyAuth: process.env["RARIBLEPROTOCOL_API_KEY_AUTH"] ?? "",
});
async function run() {
const result = await raribleProtocol.gatewayController
.createGatewayPendingTransactions({
hash: "<value>",
from: "0x60f80121c31a0d46b5279700f9df786054aa5ee5",
nonce: 527347,
to: "0x60f80121c31a0d46b5279700f9df786054aa5ee5",
input: "<value>",
});
// Handle the result
console.log(result);
}
run();
The TypeScript SDK makes API calls using an HTTPClient that wraps the native
Fetch API. This
client is a thin wrapper around fetch and provides the ability to attach hooks
around the request lifecycle that can be used to modify the request or handle
errors and response.
The HTTPClient constructor takes an optional fetcher argument that can be
used to integrate a third-party HTTP client or when writing tests to mock out
the HTTP client and feed in fixtures.
The following example shows how to use the "beforeRequest" hook to to add a
custom header and a timeout to requests and how to use the "requestError" hook
to log errors:
import { RaribleProtocol } from "rarible-protocol-mcp";
import { HTTPClient } from "rarible-protocol-mcp/lib/http";
const httpClient = new HTTPClient({
// fetcher takes a function that has the same signature as native `fetch`.
fetcher: (request) => {
return fetch(request);
}
});
httpClient.addHook("beforeRequest", (request) => {
const nextRequest = new Request(request, {
signal: request.signal || AbortSignal.timeout(5000)
});
nextRequest.headers.set("x-custom-header", "custom value");
return nextRequest;
});
httpClient.addHook("requestError", (error, request) => {
console.group("Request Error");
console.log("Reason:", `${error}`);
console.log("Endpoint:", `${request.method} ${request.url}`);
console.groupEnd();
});
const sdk = new RaribleProtocol({ httpClient });
You can setup your SDK to emit debug logs for SDK requests and responses.
You can pass a logger that matches console's interface as an SDK option.
[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
import { RaribleProtocol } from "rarible-protocol-mcp";
const sdk = new RaribleProtocol({ debugLogger: console });
You can also enable a default debug logger by setting an environment variable RARIBLEPROTOCOL_DEBUG to true.
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.
FAQs
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *rarible-protocol-mcp* API.
We found that rarible-protocol-mcp demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Fake “Phantom Shuttle” VPN Chrome extensions (active since 2017) hijack proxy auth to intercept traffic and continuously exfiltrate user credentials to attacker infrastructure.
Security News
/Product
Socket Firewall Free is now bundled into Docker Hardened Images, adding build-time and dependency-install supply chain protection on top of hardened base images for Node.js, Python, and Rust.
Security News
Season’s greetings from Socket, and here’s to a calm end of year: clean dependencies, boring pipelines, no surprises.