> For the complete documentation index, see [llms.txt](https://doc.m-safe.io/sui/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.m-safe.io/sui/developers/mpay/mpay-sdk.md).

# MPay SDK

### Installation

```
yarn add @msafe/mpay-sdk-sui
```

### Use SDK

For SDK integration code example, please check out Github repository [mpay-example](https://github.com/Momentum-Safe/mpay-example).

#### Initialize mpay client

```
import {MPayClient} from "@msafe/mpay-sdk-sui";

// Env.prod refer to mainnet environment
// Env.dev refer to testnet environment
const client = new MPayClient(Env.prod)
```

#### Connect a wallet

```
client.connectSingleWallet(window.wallet);
```

#### Create a stream or a stream group

```
const txb = await client.createStreams(info);
const res = await wallet.signAndExecuteTransactionBlock(txb);
const streamIds = client.helper.getStreamIdsFromCreateStreamResponse(res);
if (streamIds === 1) {
    const streams = Stream.new(client.globals, streamIds[0]);
} else {
    const streamGroup = StreamGroup.new(client.globals, streamIds);
    const streams = streamGroup.streams;
}
```

#### View stream detail

```
const info = await stream.info;
console.log(info);

const progress = await stream.progress;
console.log(progress);
```

#### Stream operation

```
// Cancel stream
const txb = await stream.cancel();
const res = await wallet.signAndExecuteTransactionBlock(txb);

// Claim stream
const txb = await stream.claim();
const res = await wallet.signAndExecuteTransactionBlock(txb);

// Set auto claim
const txb = await stream.setAutoClaim(true);
const res = await wallet.signAndExecuteTransactionBlock(txb);

// Claim by proxy
const txb = await stream.claimByProxy();
const res = await wallet.signAndExecuteTransactionBlock(txb);
```

For detailed explanation of these operations, please check [Key Concepts](/sui/developers/mpay/key-concepts.md).

#### Get stream list as recipient

```
const it = await client.getIncomingStreams({
    status: 'STREAMING' | 'STREAMED',
    sender: someSender,
});

while (await it.hasNext()) {
    const sts = await it.next();
    sts.forEach((st) => {
        if (st.type === 'Stream') {
            console.log((st as Stream).info);
        } else if (st.type === 'StreamGroup') {
            console.log((st as StreamGroup).info);
        }
    })
}
```

#### Get stream list as sender

```
const it = await client.getOutgoingStreams({
    status: 'STREAMING' | 'STREAMED',
    recipient: someAddress,
});

while (await it.hasNext()) {
    const sts = await it.next();
    sts.forEach((st) => {
        if (st.type === 'Stream') {
            console.log((st as Stream).info);
        } else if (st.type === 'StreamGroup') {
            console.log((st as StreamGroup).info);
        }
    })
}
```

### Deployed contracts and objects

#### Mainnet

<table><thead><tr><th width="188">Field</th><th>ID</th></tr></thead><tbody><tr><td>Package</td><td>0xc357c3985e8fb875d6b37141497af660779aa1bab0ec489b2213efd74067d1fa</td></tr><tr><td>Role object ID</td><td>0x5ab49bdf9fd1413e328ef242b3f8d83dde791b38a0b627bfc87fb25c010d34f1</td></tr><tr><td>Vault object ID</td><td>0xb483558770d8eb26007f193b75db40f0a45f2e36863a687625885d4de6993378</td></tr><tr><td>Fee object ID</td><td>0x48453fc4d7cde3fe35aad89e5dfb496608a6a55ea529a1c0274681a808627f94</td></tr><tr><td>Upgrade cap ID</td><td>0x34279779a0d0d36bd5044b04830d607fa1b0ecf316548c8ac3a44151e4f1a42a</td></tr></tbody></table>

#### Testnet

<table><thead><tr><th width="188">Field</th><th>ID</th></tr></thead><tbody><tr><td>Package</td><td>0x81c960dc653975fbd0072deca8afb92d322898c911622898ba1b2e3ad0c4bd8d</td></tr><tr><td>Role object ID</td><td>0xc6ec0bdee0bb59a72077e9acd2f42457043cf47080b3d3fad4d39abf28bba63a</td></tr><tr><td>Vault object ID</td><td>0xbc4021387fbac149119fd24e92be9e58f745774292f3a2a12e2ac6daf5363e1d</td></tr><tr><td>Fee object ID</td><td>0x4178f63970fe2daeb256dc5730ad172e82b3e8eb45f31b33e0daae72cd35e1e1</td></tr><tr><td>Upgrade cap ID</td><td>0xe1e9aa7d222d151bfe6dd83358b0d7fdcb11260f710800cfaf7ccc1b1e245115</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://doc.m-safe.io/sui/developers/mpay/mpay-sdk.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.