Merge pull request #2068 from vitorpamplona/claude/add-webrtc-calls-4kBSR
Add WebRTC-based peer-to-peer voice and video calling via NIP-AC
This commit is contained in:
Vitor Pamplona
@@ -0,0 +1,301 @@
|
||||
NIP-AC
|
||||
======
|
||||
|
||||
WebRTC Calls
|
||||
------------
|
||||
|
||||
`draft` `optional`
|
||||
|
||||
This NIP defines a protocol for establishing private peer-to-peer voice and video calls between Nostr
|
||||
users using WebRTC, with Nostr relays serving as the signaling transport and public STUN servers for
|
||||
NAT traversal — no custom server infrastructure is required.
|
||||
|
||||
## Overview
|
||||
|
||||
The protocol works as follows:
|
||||
|
||||
1. **Caller** creates a signed call offer event containing an SDP offer
|
||||
2. The event is **gift-wrapped** ([NIP-59](https://github.com/nostr-protocol/nips/blob/master/59.md)) and published to relays
|
||||
3. **Callee** unwraps the event, verifies the signature, and decides whether to accept
|
||||
4. If accepted, callee sends back a gift-wrapped call answer event containing an SDP answer
|
||||
5. Both parties exchange **ICE candidates** as gift-wrapped events for NAT traversal
|
||||
6. A **direct WebRTC peer connection** is established for audio/video
|
||||
|
||||
All signaling events MUST be gift-wrapped using [NIP-59](https://github.com/nostr-protocol/nips/blob/master/59.md) for metadata privacy.
|
||||
Events are signed by the sender's key and wrapped directly (without the seal layer) — the gift wrap's
|
||||
random ephemeral key already hides the sender from relay operators.
|
||||
|
||||
## Event Kinds
|
||||
|
||||
| Kind | Name | Description |
|
||||
|-------|---------------------|----------------------------------------------|
|
||||
| 25050 | Call Offer | SDP offer initiating a call |
|
||||
| 25051 | Call Answer | SDP answer accepting a call |
|
||||
| 25052 | ICE Candidate | ICE candidate for NAT traversal |
|
||||
| 25053 | Call Hangup | Terminates an active or pending call |
|
||||
| 25054 | Call Reject | Rejects an incoming call |
|
||||
| 25055 | Call Renegotiate | New SDP offer for mid-call changes |
|
||||
|
||||
## Tags
|
||||
|
||||
All signaling events MUST include:
|
||||
|
||||
| Tag | Description | Required |
|
||||
|---------------|-------------------------------------------------------|----------|
|
||||
| `p` | Hex pubkey of the recipient | YES |
|
||||
| `call-id` | UUID identifying the call session | YES |
|
||||
| `expiration` | Unix timestamp ([NIP-40](https://github.com/nostr-protocol/nips/blob/master/40.md)), SHOULD be `created_at + 20` seconds | YES |
|
||||
| `alt` | Human-readable description ([NIP-31](https://github.com/nostr-protocol/nips/blob/master/31.md)) | YES |
|
||||
|
||||
Additional tags for **Call Offer** (kind 25050):
|
||||
|
||||
| Tag | Description | Required |
|
||||
|---------------|-------------------------------------------------------|----------|
|
||||
| `call-type` | `"voice"` or `"video"` | YES |
|
||||
|
||||
## Event Structures
|
||||
|
||||
### Call Offer (kind 25050)
|
||||
|
||||
The `content` field contains the SDP offer string.
|
||||
|
||||
```json
|
||||
{
|
||||
"kind": 25050,
|
||||
"pubkey": "<caller-hex-pubkey>",
|
||||
"created_at": 1234567890,
|
||||
"content": "v=0\r\no=- 4611731400430051336 2 IN IP4 127.0.0.1\r\n...",
|
||||
"tags": [
|
||||
["p", "<callee-hex-pubkey>"],
|
||||
["call-id", "550e8400-e29b-41d4-a716-446655440000"],
|
||||
["call-type", "video"],
|
||||
["expiration", "1234567910"],
|
||||
["alt", "WebRTC call offer"]
|
||||
],
|
||||
"id": "<event-id>",
|
||||
"sig": "<signature>"
|
||||
}
|
||||
```
|
||||
|
||||
### Call Answer (kind 25051)
|
||||
|
||||
The `content` field contains the SDP answer string.
|
||||
|
||||
```json
|
||||
{
|
||||
"kind": 25051,
|
||||
"pubkey": "<callee-hex-pubkey>",
|
||||
"created_at": 1234567895,
|
||||
"content": "v=0\r\no=- 4611731400430051337 2 IN IP4 127.0.0.1\r\n...",
|
||||
"tags": [
|
||||
["p", "<caller-hex-pubkey>"],
|
||||
["call-id", "550e8400-e29b-41d4-a716-446655440000"],
|
||||
["expiration", "1234567915"],
|
||||
["alt", "WebRTC call answer"]
|
||||
],
|
||||
"id": "<event-id>",
|
||||
"sig": "<signature>"
|
||||
}
|
||||
```
|
||||
|
||||
### ICE Candidate (kind 25052)
|
||||
|
||||
The `content` field contains the ICE candidate as a JSON string with the fields `candidate`, `sdpMid`, and `sdpMLineIndex`. Special characters in the SDP string MUST be properly JSON-escaped.
|
||||
|
||||
```json
|
||||
{
|
||||
"kind": 25052,
|
||||
"pubkey": "<sender-hex-pubkey>",
|
||||
"created_at": 1234567896,
|
||||
"content": "{\"candidate\":\"candidate:842163049 1 udp 1677729535 203.0.113.1 44323 typ srflx raddr 0.0.0.0 rport 0 generation 0\",\"sdpMid\":\"0\",\"sdpMLineIndex\":0}",
|
||||
"tags": [
|
||||
["p", "<peer-hex-pubkey>"],
|
||||
["call-id", "550e8400-e29b-41d4-a716-446655440000"],
|
||||
["expiration", "1234567916"],
|
||||
["alt", "WebRTC ICE candidate"]
|
||||
],
|
||||
"id": "<event-id>",
|
||||
"sig": "<signature>"
|
||||
}
|
||||
```
|
||||
|
||||
### Call Hangup (kind 25053)
|
||||
|
||||
The `content` field MAY contain a human-readable reason or be empty.
|
||||
|
||||
```json
|
||||
{
|
||||
"kind": 25053,
|
||||
"pubkey": "<sender-hex-pubkey>",
|
||||
"created_at": 1234568000,
|
||||
"content": "",
|
||||
"tags": [
|
||||
["p", "<peer-hex-pubkey>"],
|
||||
["call-id", "550e8400-e29b-41d4-a716-446655440000"],
|
||||
["expiration", "1234568020"],
|
||||
["alt", "WebRTC call hangup"]
|
||||
],
|
||||
"id": "<event-id>",
|
||||
"sig": "<signature>"
|
||||
}
|
||||
```
|
||||
|
||||
### Call Reject (kind 25054)
|
||||
|
||||
The `content` field MAY contain a reason or be empty.
|
||||
|
||||
```json
|
||||
{
|
||||
"kind": 25054,
|
||||
"pubkey": "<callee-hex-pubkey>",
|
||||
"created_at": 1234567893,
|
||||
"content": "",
|
||||
"tags": [
|
||||
["p", "<caller-hex-pubkey>"],
|
||||
["call-id", "550e8400-e29b-41d4-a716-446655440000"],
|
||||
["expiration", "1234567913"],
|
||||
["alt", "WebRTC call rejection"]
|
||||
],
|
||||
"id": "<event-id>",
|
||||
"sig": "<signature>"
|
||||
}
|
||||
```
|
||||
|
||||
### Call Renegotiate (kind 25055)
|
||||
|
||||
Used for mid-call changes such as toggling video on/off. The `content` field contains a new SDP offer.
|
||||
|
||||
```json
|
||||
{
|
||||
"kind": 25055,
|
||||
"pubkey": "<sender-hex-pubkey>",
|
||||
"created_at": 1234568100,
|
||||
"content": "v=0\r\no=- 4611731400430051338 3 IN IP4 127.0.0.1\r\n...",
|
||||
"tags": [
|
||||
["p", "<peer-hex-pubkey>"],
|
||||
["call-id", "550e8400-e29b-41d4-a716-446655440000"],
|
||||
["expiration", "1234568120"],
|
||||
["alt", "WebRTC call renegotiation"]
|
||||
],
|
||||
"id": "<event-id>",
|
||||
"sig": "<signature>"
|
||||
}
|
||||
```
|
||||
|
||||
## Encryption and Delivery
|
||||
|
||||
All signaling events MUST be delivered using [NIP-59](https://github.com/nostr-protocol/nips/blob/master/59.md) Gift Wraps:
|
||||
|
||||
1. **Sign** the signaling event with the sender's key
|
||||
2. **Gift-wrap** the signed event directly using `GiftWrapEvent` (kind 1059) with NIP-44 encryption
|
||||
3. **Set expiration on the gift wrap** — the outer gift wrap MUST include an `expiration` tag matching the inner event's expiration (adjusted for the randomized `created_at`). This allows relays to garbage-collect ephemeral signaling data.
|
||||
4. **Publish** the gift wrap to the recipient's relay list
|
||||
|
||||
The seal layer (`SealedRumorEvent`) is NOT used. The gift wrap already provides:
|
||||
|
||||
- **NIP-44 encryption** — content is unreadable to relay operators
|
||||
- **Random ephemeral pubkey** — the relay cannot identify the sender
|
||||
- **`p` tag** — reveals only the recipient (necessary for delivery)
|
||||
- **`expiration` tag** — allows relays to delete the wrap after the signaling window
|
||||
|
||||
Recipients unwrap the gift, verify the inner event's signature against the sender's pubkey, and then process the signaling message.
|
||||
|
||||
## Protocol Flow
|
||||
|
||||
### Initiating a Call
|
||||
|
||||
```
|
||||
Caller Relay Callee
|
||||
| | |
|
||||
|-- GiftWrap(CallOffer) ------->| |
|
||||
| |-- GiftWrap(CallOffer) ------->|
|
||||
| | |
|
||||
| | [Callee unwraps, verifies signature]
|
||||
| | [Checks: is caller followed?]
|
||||
| | [YES → ring / NO → ignore]
|
||||
| | |
|
||||
|<-- GiftWrap(CallAnswer) ------|<-- GiftWrap(CallAnswer) ------|
|
||||
| | |
|
||||
|<-> GiftWrap(IceCandidate) <-->|<-> GiftWrap(IceCandidate) <-->|
|
||||
| | |
|
||||
|============= WebRTC P2P Connection Established ===============|
|
||||
| (relay no longer involved) |
|
||||
```
|
||||
|
||||
### ICE Candidate Buffering
|
||||
|
||||
ICE candidates may arrive before the WebRTC peer connection is ready (e.g., the callee is still ringing). Clients MUST buffer incoming ICE candidates and apply them after `setRemoteDescription()` succeeds. Candidates buffered while ringing MUST NOT be cleared when accepting the call.
|
||||
|
||||
### Ending a Call
|
||||
|
||||
Either party may send a `CallHangup` (kind 25053) at any time. The recipient SHOULD close the WebRTC peer connection and release media resources upon receiving it.
|
||||
|
||||
### Rejecting a Call
|
||||
|
||||
The callee may send a `CallReject` (kind 25054) instead of a `CallAnswer`. The caller SHOULD stop ringing and display a "call rejected" state.
|
||||
|
||||
## Spam Prevention
|
||||
|
||||
Clients SHOULD implement call filtering:
|
||||
|
||||
- **Follow-gated ringing**: Only display incoming call notifications for users in the recipient's follow list. Calls from non-followed users SHOULD be silently ignored.
|
||||
- **Staleness check**: Clients MUST discard signaling events older than the expiration window (20 seconds). This prevents old cached events from triggering phantom calls on app restart or relay reconnect.
|
||||
- **Deduplication**: Clients MUST track processed event IDs to prevent the same signaling event (delivered by multiple relays) from being processed twice.
|
||||
- **Rate limiting**: Clients SHOULD ignore duplicate call offers from the same pubkey within a short window.
|
||||
|
||||
## NAT Traversal
|
||||
|
||||
This NIP does not mandate specific STUN or TURN servers. Clients SHOULD:
|
||||
|
||||
- Ship with a default set of public STUN servers (e.g., `stun:stun.l.google.com:19302`)
|
||||
- Ship with default TURN servers for relay fallback when direct P2P fails (~20% of cases, including devices on the same WiFi network where hairpin NAT is not supported)
|
||||
- Allow users to configure custom TURN servers for restrictive network environments
|
||||
- Use trickle ICE (sending candidates as they are discovered) rather than waiting for all candidates before sending the offer/answer
|
||||
- Use `GATHER_CONTINUALLY` policy for ongoing ICE candidate discovery
|
||||
|
||||
## Implementation Notes
|
||||
|
||||
### Event Lifecycle
|
||||
|
||||
- The `call-id` tag MUST be a UUID that is unique per call session. All signaling events for the same call share the same `call-id`.
|
||||
- Both inner events and outer gift wraps SHOULD have short expiration times (~20 seconds) since signaling data is ephemeral and has no long-term value. This allows relays to garbage-collect call signaling events.
|
||||
- Clients SHOULD implement a ringing timeout (e.g., 60 seconds). If no answer is received, the call transitions to a "timed out" state.
|
||||
- After a call ends, the call state SHOULD auto-reset to idle after a brief display period (e.g., 2 seconds) to ensure the client is ready for subsequent calls.
|
||||
|
||||
### WebRTC Configuration
|
||||
|
||||
- The WebRTC `PeerConnection` SHOULD use Unified Plan SDP semantics.
|
||||
- Clients MAY support call renegotiation (kind 25055) for toggling video on/off mid-call without tearing down the connection.
|
||||
- ICE candidate JSON content MUST be properly escaped — SDP strings can contain quotes and backslashes that break naive string interpolation.
|
||||
|
||||
### Audio and Media
|
||||
|
||||
- Clients SHOULD switch `AudioManager` to `MODE_IN_COMMUNICATION` when a call connects and restore to `MODE_NORMAL` when the call ends.
|
||||
- Clients SHOULD support audio routing between earpiece, speaker, and Bluetooth SCO headsets. If a Bluetooth headset disconnects mid-call, the client SHOULD fall back to earpiece automatically.
|
||||
- Clients SHOULD play a ringback tone (e.g., `TONE_SUP_RINGTONE`) for the caller while waiting for the callee to answer.
|
||||
- Clients SHOULD play the device's default ringtone and vibrate when an incoming call arrives from a followed user.
|
||||
|
||||
### Platform Integration
|
||||
|
||||
- Clients SHOULD use a foreground service (type `microphone`) to keep calls alive when the app is backgrounded.
|
||||
- Clients SHOULD acquire a proximity wake lock during active calls to turn off the screen when held to the ear.
|
||||
- Clients SHOULD keep the screen on during active calls.
|
||||
- Clients MAY enter Picture-in-Picture mode when the user navigates away from the call screen during an active call.
|
||||
- Clients SHOULD request `RECORD_AUDIO` permission (and `CAMERA` for video calls) at runtime before initiating or accepting a call.
|
||||
|
||||
### Error Handling
|
||||
|
||||
- If WebRTC session creation fails, the client SHOULD display an error to the user and transition to an ended state.
|
||||
- If SDP offer/answer creation fails, the client SHOULD surface the error instead of hanging silently.
|
||||
- Clients SHOULD handle `ICE_CONNECTION_FAILED` state by ending the call and notifying the user of a connection failure.
|
||||
|
||||
## References
|
||||
|
||||
- [NIP-01: Basic Protocol](https://github.com/nostr-protocol/nips/blob/master/01.md) — Event structure
|
||||
- [NIP-31: Alt Tag](https://github.com/nostr-protocol/nips/blob/master/31.md) — Human-readable event descriptions
|
||||
- [NIP-40: Expiration](https://github.com/nostr-protocol/nips/blob/master/40.md) — Event expiration timestamps
|
||||
- [NIP-44: Encryption](https://github.com/nostr-protocol/nips/blob/master/44.md) — XChaCha20-Poly1305 encryption
|
||||
- [NIP-59: Gift Wraps](https://github.com/nostr-protocol/nips/blob/master/59.md) — Encrypted event delivery
|
||||
- [WebRTC Specification](https://www.w3.org/TR/webrtc/) — Peer-to-peer real-time communication
|
||||
- [RFC 8445: ICE](https://datatracker.ietf.org/doc/html/rfc8445) — Interactive Connectivity Establishment
|
||||
- [nostr-protocol/nips#771](https://github.com/nostr-protocol/nips/issues/771) — WebRTC signaling discussion
|
||||
+117
@@ -0,0 +1,117 @@
|
||||
/*
|
||||
* Copyright (c) 2025 Vitor Pamplona
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
* this software and associated documentation files (the "Software"), to deal in
|
||||
* the Software without restriction, including without limitation the rights to use,
|
||||
* copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
|
||||
* Software, and to permit persons to whom the Software is furnished to do so,
|
||||
* subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in all
|
||||
* copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
|
||||
* AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
*/
|
||||
package com.vitorpamplona.quartz.nipACWebRtcCalls
|
||||
|
||||
import com.vitorpamplona.quartz.nip01Core.core.Event
|
||||
import com.vitorpamplona.quartz.nip01Core.core.HexKey
|
||||
import com.vitorpamplona.quartz.nip01Core.signers.NostrSigner
|
||||
import com.vitorpamplona.quartz.nip59Giftwrap.wraps.GiftWrapEvent
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.events.CallAnswerEvent
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.events.CallHangupEvent
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.events.CallIceCandidateEvent
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.events.CallOfferEvent
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.events.CallRejectEvent
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.events.CallRenegotiateEvent
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.tags.CallType
|
||||
|
||||
class WebRtcCallFactory {
|
||||
data class Result(
|
||||
val msg: Event,
|
||||
val wrap: GiftWrapEvent,
|
||||
)
|
||||
|
||||
companion object {
|
||||
const val WRAP_EXPIRATION_SECONDS = 20L
|
||||
}
|
||||
|
||||
suspend fun createCallOffer(
|
||||
sdpOffer: String,
|
||||
calleePubKey: HexKey,
|
||||
callId: String,
|
||||
callType: CallType,
|
||||
signer: NostrSigner,
|
||||
): Result {
|
||||
val template = CallOfferEvent.build(sdpOffer, calleePubKey, callId, callType)
|
||||
val signed = signer.sign(template)
|
||||
val wrap = GiftWrapEvent.create(event = signed, recipientPubKey = calleePubKey, expirationDelta = WRAP_EXPIRATION_SECONDS)
|
||||
return Result(signed, wrap)
|
||||
}
|
||||
|
||||
suspend fun createCallAnswer(
|
||||
sdpAnswer: String,
|
||||
callerPubKey: HexKey,
|
||||
callId: String,
|
||||
signer: NostrSigner,
|
||||
): Result {
|
||||
val template = CallAnswerEvent.build(sdpAnswer, callerPubKey, callId)
|
||||
val signed = signer.sign(template)
|
||||
val wrap = GiftWrapEvent.create(event = signed, recipientPubKey = callerPubKey, expirationDelta = WRAP_EXPIRATION_SECONDS)
|
||||
return Result(signed, wrap)
|
||||
}
|
||||
|
||||
suspend fun createIceCandidate(
|
||||
candidateJson: String,
|
||||
peerPubKey: HexKey,
|
||||
callId: String,
|
||||
signer: NostrSigner,
|
||||
): Result {
|
||||
val template = CallIceCandidateEvent.build(candidateJson, peerPubKey, callId)
|
||||
val signed = signer.sign(template)
|
||||
val wrap = GiftWrapEvent.create(event = signed, recipientPubKey = peerPubKey, expirationDelta = WRAP_EXPIRATION_SECONDS)
|
||||
return Result(signed, wrap)
|
||||
}
|
||||
|
||||
suspend fun createHangup(
|
||||
peerPubKey: HexKey,
|
||||
callId: String,
|
||||
reason: String = "",
|
||||
signer: NostrSigner,
|
||||
): Result {
|
||||
val template = CallHangupEvent.build(peerPubKey, callId, reason)
|
||||
val signed = signer.sign(template)
|
||||
val wrap = GiftWrapEvent.create(event = signed, recipientPubKey = peerPubKey, expirationDelta = WRAP_EXPIRATION_SECONDS)
|
||||
return Result(signed, wrap)
|
||||
}
|
||||
|
||||
suspend fun createReject(
|
||||
callerPubKey: HexKey,
|
||||
callId: String,
|
||||
reason: String = "",
|
||||
signer: NostrSigner,
|
||||
): Result {
|
||||
val template = CallRejectEvent.build(callerPubKey, callId, reason)
|
||||
val signed = signer.sign(template)
|
||||
val wrap = GiftWrapEvent.create(event = signed, recipientPubKey = callerPubKey, expirationDelta = WRAP_EXPIRATION_SECONDS)
|
||||
return Result(signed, wrap)
|
||||
}
|
||||
|
||||
suspend fun createRenegotiate(
|
||||
sdpOffer: String,
|
||||
peerPubKey: HexKey,
|
||||
callId: String,
|
||||
signer: NostrSigner,
|
||||
): Result {
|
||||
val template = CallRenegotiateEvent.build(sdpOffer, peerPubKey, callId)
|
||||
val signed = signer.sign(template)
|
||||
val wrap = GiftWrapEvent.create(event = signed, recipientPubKey = peerPubKey, expirationDelta = WRAP_EXPIRATION_SECONDS)
|
||||
return Result(signed, wrap)
|
||||
}
|
||||
}
|
||||
+67
@@ -0,0 +1,67 @@
|
||||
/*
|
||||
* Copyright (c) 2025 Vitor Pamplona
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
* this software and associated documentation files (the "Software"), to deal in
|
||||
* the Software without restriction, including without limitation the rights to use,
|
||||
* copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
|
||||
* Software, and to permit persons to whom the Software is furnished to do so,
|
||||
* subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in all
|
||||
* copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
|
||||
* AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
*/
|
||||
package com.vitorpamplona.quartz.nipACWebRtcCalls.events
|
||||
|
||||
import androidx.compose.runtime.Immutable
|
||||
import com.vitorpamplona.quartz.nip01Core.core.Event
|
||||
import com.vitorpamplona.quartz.nip01Core.core.HexKey
|
||||
import com.vitorpamplona.quartz.nip01Core.core.TagArrayBuilder
|
||||
import com.vitorpamplona.quartz.nip01Core.signers.eventTemplate
|
||||
import com.vitorpamplona.quartz.nip01Core.tags.people.pTag
|
||||
import com.vitorpamplona.quartz.nip31Alts.alt
|
||||
import com.vitorpamplona.quartz.nip40Expiration.expiration
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.tags.CallIdTag
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.tags.callId
|
||||
import com.vitorpamplona.quartz.utils.TimeUtils
|
||||
|
||||
@Immutable
|
||||
class CallAnswerEvent(
|
||||
id: HexKey,
|
||||
pubKey: HexKey,
|
||||
createdAt: Long,
|
||||
tags: Array<Array<String>>,
|
||||
content: String,
|
||||
sig: HexKey,
|
||||
) : Event(id, pubKey, createdAt, KIND, tags, content, sig) {
|
||||
fun callId() = tags.firstNotNullOfOrNull(CallIdTag::parse)
|
||||
|
||||
fun sdpAnswer() = content
|
||||
|
||||
companion object {
|
||||
const val KIND = 25051
|
||||
const val ALT_DESCRIPTION = "WebRTC call answer"
|
||||
const val EXPIRATION_SECONDS = 20L
|
||||
|
||||
fun build(
|
||||
sdpAnswer: String,
|
||||
callerPubKey: HexKey,
|
||||
callId: String,
|
||||
createdAt: Long = TimeUtils.now(),
|
||||
initializer: TagArrayBuilder<CallAnswerEvent>.() -> Unit = {},
|
||||
) = eventTemplate(KIND, sdpAnswer, createdAt) {
|
||||
alt(ALT_DESCRIPTION)
|
||||
pTag(callerPubKey)
|
||||
callId(callId)
|
||||
expiration(createdAt + EXPIRATION_SECONDS)
|
||||
initializer()
|
||||
}
|
||||
}
|
||||
}
|
||||
+67
@@ -0,0 +1,67 @@
|
||||
/*
|
||||
* Copyright (c) 2025 Vitor Pamplona
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
* this software and associated documentation files (the "Software"), to deal in
|
||||
* the Software without restriction, including without limitation the rights to use,
|
||||
* copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
|
||||
* Software, and to permit persons to whom the Software is furnished to do so,
|
||||
* subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in all
|
||||
* copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
|
||||
* AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
*/
|
||||
package com.vitorpamplona.quartz.nipACWebRtcCalls.events
|
||||
|
||||
import androidx.compose.runtime.Immutable
|
||||
import com.vitorpamplona.quartz.nip01Core.core.Event
|
||||
import com.vitorpamplona.quartz.nip01Core.core.HexKey
|
||||
import com.vitorpamplona.quartz.nip01Core.core.TagArrayBuilder
|
||||
import com.vitorpamplona.quartz.nip01Core.signers.eventTemplate
|
||||
import com.vitorpamplona.quartz.nip01Core.tags.people.pTag
|
||||
import com.vitorpamplona.quartz.nip31Alts.alt
|
||||
import com.vitorpamplona.quartz.nip40Expiration.expiration
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.tags.CallIdTag
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.tags.callId
|
||||
import com.vitorpamplona.quartz.utils.TimeUtils
|
||||
|
||||
@Immutable
|
||||
class CallHangupEvent(
|
||||
id: HexKey,
|
||||
pubKey: HexKey,
|
||||
createdAt: Long,
|
||||
tags: Array<Array<String>>,
|
||||
content: String,
|
||||
sig: HexKey,
|
||||
) : Event(id, pubKey, createdAt, KIND, tags, content, sig) {
|
||||
fun callId() = tags.firstNotNullOfOrNull(CallIdTag::parse)
|
||||
|
||||
fun reason() = content.ifEmpty { null }
|
||||
|
||||
companion object {
|
||||
const val KIND = 25053
|
||||
const val ALT_DESCRIPTION = "WebRTC call hangup"
|
||||
const val EXPIRATION_SECONDS = 20L
|
||||
|
||||
fun build(
|
||||
peerPubKey: HexKey,
|
||||
callId: String,
|
||||
reason: String = "",
|
||||
createdAt: Long = TimeUtils.now(),
|
||||
initializer: TagArrayBuilder<CallHangupEvent>.() -> Unit = {},
|
||||
) = eventTemplate(KIND, reason, createdAt) {
|
||||
alt(ALT_DESCRIPTION)
|
||||
pTag(peerPubKey)
|
||||
callId(callId)
|
||||
expiration(createdAt + EXPIRATION_SECONDS)
|
||||
initializer()
|
||||
}
|
||||
}
|
||||
}
|
||||
+92
@@ -0,0 +1,92 @@
|
||||
/*
|
||||
* Copyright (c) 2025 Vitor Pamplona
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
* this software and associated documentation files (the "Software"), to deal in
|
||||
* the Software without restriction, including without limitation the rights to use,
|
||||
* copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
|
||||
* Software, and to permit persons to whom the Software is furnished to do so,
|
||||
* subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in all
|
||||
* copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
|
||||
* AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
*/
|
||||
package com.vitorpamplona.quartz.nipACWebRtcCalls.events
|
||||
|
||||
import androidx.compose.runtime.Immutable
|
||||
import com.vitorpamplona.quartz.nip01Core.core.Event
|
||||
import com.vitorpamplona.quartz.nip01Core.core.HexKey
|
||||
import com.vitorpamplona.quartz.nip01Core.core.TagArrayBuilder
|
||||
import com.vitorpamplona.quartz.nip01Core.signers.eventTemplate
|
||||
import com.vitorpamplona.quartz.nip01Core.tags.people.pTag
|
||||
import com.vitorpamplona.quartz.nip31Alts.alt
|
||||
import com.vitorpamplona.quartz.nip40Expiration.expiration
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.tags.CallIdTag
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.tags.callId
|
||||
import com.vitorpamplona.quartz.utils.TimeUtils
|
||||
|
||||
@Immutable
|
||||
class CallIceCandidateEvent(
|
||||
id: HexKey,
|
||||
pubKey: HexKey,
|
||||
createdAt: Long,
|
||||
tags: Array<Array<String>>,
|
||||
content: String,
|
||||
sig: HexKey,
|
||||
) : Event(id, pubKey, createdAt, KIND, tags, content, sig) {
|
||||
fun callId() = tags.firstNotNullOfOrNull(CallIdTag::parse)
|
||||
|
||||
fun candidateJson() = content
|
||||
|
||||
fun candidateSdp(): String = CANDIDATE_REGEX.find(content)?.groupValues?.get(1) ?: ""
|
||||
|
||||
fun sdpMid(): String = SDP_MID_REGEX.find(content)?.groupValues?.get(1) ?: "0"
|
||||
|
||||
fun sdpMLineIndex(): Int =
|
||||
SDP_MLINE_INDEX_REGEX
|
||||
.find(content)
|
||||
?.groupValues
|
||||
?.get(1)
|
||||
?.toIntOrNull() ?: 0
|
||||
|
||||
companion object {
|
||||
const val KIND = 25052
|
||||
const val ALT_DESCRIPTION = "WebRTC ICE candidate"
|
||||
const val EXPIRATION_SECONDS = 20L
|
||||
|
||||
private val CANDIDATE_REGEX = """"candidate"\s*:\s*"([^"]*)"""".toRegex()
|
||||
private val SDP_MID_REGEX = """"sdpMid"\s*:\s*"([^"]*)"""".toRegex()
|
||||
private val SDP_MLINE_INDEX_REGEX = """"sdpMLineIndex"\s*:\s*(\d+)""".toRegex()
|
||||
|
||||
fun serializeCandidate(
|
||||
sdp: String,
|
||||
sdpMid: String,
|
||||
sdpMLineIndex: Int,
|
||||
): String {
|
||||
val escapedSdp = sdp.replace("\\", "\\\\").replace("\"", "\\\"")
|
||||
val escapedMid = sdpMid.replace("\\", "\\\\").replace("\"", "\\\"")
|
||||
return """{"candidate":"$escapedSdp","sdpMid":"$escapedMid","sdpMLineIndex":$sdpMLineIndex}"""
|
||||
}
|
||||
|
||||
fun build(
|
||||
candidateJson: String,
|
||||
peerPubKey: HexKey,
|
||||
callId: String,
|
||||
createdAt: Long = TimeUtils.now(),
|
||||
initializer: TagArrayBuilder<CallIceCandidateEvent>.() -> Unit = {},
|
||||
) = eventTemplate(KIND, candidateJson, createdAt) {
|
||||
alt(ALT_DESCRIPTION)
|
||||
pTag(peerPubKey)
|
||||
callId(callId)
|
||||
expiration(createdAt + EXPIRATION_SECONDS)
|
||||
initializer()
|
||||
}
|
||||
}
|
||||
}
|
||||
+74
@@ -0,0 +1,74 @@
|
||||
/*
|
||||
* Copyright (c) 2025 Vitor Pamplona
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
* this software and associated documentation files (the "Software"), to deal in
|
||||
* the Software without restriction, including without limitation the rights to use,
|
||||
* copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
|
||||
* Software, and to permit persons to whom the Software is furnished to do so,
|
||||
* subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in all
|
||||
* copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
|
||||
* AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
*/
|
||||
package com.vitorpamplona.quartz.nipACWebRtcCalls.events
|
||||
|
||||
import androidx.compose.runtime.Immutable
|
||||
import com.vitorpamplona.quartz.nip01Core.core.Event
|
||||
import com.vitorpamplona.quartz.nip01Core.core.HexKey
|
||||
import com.vitorpamplona.quartz.nip01Core.core.TagArrayBuilder
|
||||
import com.vitorpamplona.quartz.nip01Core.signers.eventTemplate
|
||||
import com.vitorpamplona.quartz.nip01Core.tags.people.pTag
|
||||
import com.vitorpamplona.quartz.nip31Alts.alt
|
||||
import com.vitorpamplona.quartz.nip40Expiration.expiration
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.tags.CallIdTag
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.tags.CallType
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.tags.CallTypeTag
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.tags.callId
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.tags.callType
|
||||
import com.vitorpamplona.quartz.utils.TimeUtils
|
||||
|
||||
@Immutable
|
||||
class CallOfferEvent(
|
||||
id: HexKey,
|
||||
pubKey: HexKey,
|
||||
createdAt: Long,
|
||||
tags: Array<Array<String>>,
|
||||
content: String,
|
||||
sig: HexKey,
|
||||
) : Event(id, pubKey, createdAt, KIND, tags, content, sig) {
|
||||
fun callId() = tags.firstNotNullOfOrNull(CallIdTag::parse)
|
||||
|
||||
fun callType() = tags.firstNotNullOfOrNull(CallTypeTag::parse)
|
||||
|
||||
fun sdpOffer() = content
|
||||
|
||||
companion object {
|
||||
const val KIND = 25050
|
||||
const val ALT_DESCRIPTION = "WebRTC call offer"
|
||||
const val EXPIRATION_SECONDS = 20L
|
||||
|
||||
fun build(
|
||||
sdpOffer: String,
|
||||
calleePubKey: HexKey,
|
||||
callId: String,
|
||||
type: CallType,
|
||||
createdAt: Long = TimeUtils.now(),
|
||||
initializer: TagArrayBuilder<CallOfferEvent>.() -> Unit = {},
|
||||
) = eventTemplate(KIND, sdpOffer, createdAt) {
|
||||
alt(ALT_DESCRIPTION)
|
||||
pTag(calleePubKey)
|
||||
callId(callId)
|
||||
callType(type)
|
||||
expiration(createdAt + EXPIRATION_SECONDS)
|
||||
initializer()
|
||||
}
|
||||
}
|
||||
}
|
||||
+67
@@ -0,0 +1,67 @@
|
||||
/*
|
||||
* Copyright (c) 2025 Vitor Pamplona
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
* this software and associated documentation files (the "Software"), to deal in
|
||||
* the Software without restriction, including without limitation the rights to use,
|
||||
* copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
|
||||
* Software, and to permit persons to whom the Software is furnished to do so,
|
||||
* subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in all
|
||||
* copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
|
||||
* AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
*/
|
||||
package com.vitorpamplona.quartz.nipACWebRtcCalls.events
|
||||
|
||||
import androidx.compose.runtime.Immutable
|
||||
import com.vitorpamplona.quartz.nip01Core.core.Event
|
||||
import com.vitorpamplona.quartz.nip01Core.core.HexKey
|
||||
import com.vitorpamplona.quartz.nip01Core.core.TagArrayBuilder
|
||||
import com.vitorpamplona.quartz.nip01Core.signers.eventTemplate
|
||||
import com.vitorpamplona.quartz.nip01Core.tags.people.pTag
|
||||
import com.vitorpamplona.quartz.nip31Alts.alt
|
||||
import com.vitorpamplona.quartz.nip40Expiration.expiration
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.tags.CallIdTag
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.tags.callId
|
||||
import com.vitorpamplona.quartz.utils.TimeUtils
|
||||
|
||||
@Immutable
|
||||
class CallRejectEvent(
|
||||
id: HexKey,
|
||||
pubKey: HexKey,
|
||||
createdAt: Long,
|
||||
tags: Array<Array<String>>,
|
||||
content: String,
|
||||
sig: HexKey,
|
||||
) : Event(id, pubKey, createdAt, KIND, tags, content, sig) {
|
||||
fun callId() = tags.firstNotNullOfOrNull(CallIdTag::parse)
|
||||
|
||||
fun reason() = content.ifEmpty { null }
|
||||
|
||||
companion object {
|
||||
const val KIND = 25054
|
||||
const val ALT_DESCRIPTION = "WebRTC call rejection"
|
||||
const val EXPIRATION_SECONDS = 20L
|
||||
|
||||
fun build(
|
||||
callerPubKey: HexKey,
|
||||
callId: String,
|
||||
reason: String = "",
|
||||
createdAt: Long = TimeUtils.now(),
|
||||
initializer: TagArrayBuilder<CallRejectEvent>.() -> Unit = {},
|
||||
) = eventTemplate(KIND, reason, createdAt) {
|
||||
alt(ALT_DESCRIPTION)
|
||||
pTag(callerPubKey)
|
||||
callId(callId)
|
||||
expiration(createdAt + EXPIRATION_SECONDS)
|
||||
initializer()
|
||||
}
|
||||
}
|
||||
}
|
||||
+67
@@ -0,0 +1,67 @@
|
||||
/*
|
||||
* Copyright (c) 2025 Vitor Pamplona
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
* this software and associated documentation files (the "Software"), to deal in
|
||||
* the Software without restriction, including without limitation the rights to use,
|
||||
* copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
|
||||
* Software, and to permit persons to whom the Software is furnished to do so,
|
||||
* subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in all
|
||||
* copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
|
||||
* AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
*/
|
||||
package com.vitorpamplona.quartz.nipACWebRtcCalls.events
|
||||
|
||||
import androidx.compose.runtime.Immutable
|
||||
import com.vitorpamplona.quartz.nip01Core.core.Event
|
||||
import com.vitorpamplona.quartz.nip01Core.core.HexKey
|
||||
import com.vitorpamplona.quartz.nip01Core.core.TagArrayBuilder
|
||||
import com.vitorpamplona.quartz.nip01Core.signers.eventTemplate
|
||||
import com.vitorpamplona.quartz.nip01Core.tags.people.pTag
|
||||
import com.vitorpamplona.quartz.nip31Alts.alt
|
||||
import com.vitorpamplona.quartz.nip40Expiration.expiration
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.tags.CallIdTag
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.tags.callId
|
||||
import com.vitorpamplona.quartz.utils.TimeUtils
|
||||
|
||||
@Immutable
|
||||
class CallRenegotiateEvent(
|
||||
id: HexKey,
|
||||
pubKey: HexKey,
|
||||
createdAt: Long,
|
||||
tags: Array<Array<String>>,
|
||||
content: String,
|
||||
sig: HexKey,
|
||||
) : Event(id, pubKey, createdAt, KIND, tags, content, sig) {
|
||||
fun callId() = tags.firstNotNullOfOrNull(CallIdTag::parse)
|
||||
|
||||
fun sdpOffer() = content
|
||||
|
||||
companion object {
|
||||
const val KIND = 25055
|
||||
const val ALT_DESCRIPTION = "WebRTC call renegotiation"
|
||||
const val EXPIRATION_SECONDS = 20L
|
||||
|
||||
fun build(
|
||||
sdpOffer: String,
|
||||
peerPubKey: HexKey,
|
||||
callId: String,
|
||||
createdAt: Long = TimeUtils.now(),
|
||||
initializer: TagArrayBuilder<CallRenegotiateEvent>.() -> Unit = {},
|
||||
) = eventTemplate(KIND, sdpOffer, createdAt) {
|
||||
alt(ALT_DESCRIPTION)
|
||||
pTag(peerPubKey)
|
||||
callId(callId)
|
||||
expiration(createdAt + EXPIRATION_SECONDS)
|
||||
initializer()
|
||||
}
|
||||
}
|
||||
}
|
||||
+39
@@ -0,0 +1,39 @@
|
||||
/*
|
||||
* Copyright (c) 2025 Vitor Pamplona
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
* this software and associated documentation files (the "Software"), to deal in
|
||||
* the Software without restriction, including without limitation the rights to use,
|
||||
* copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
|
||||
* Software, and to permit persons to whom the Software is furnished to do so,
|
||||
* subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in all
|
||||
* copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
|
||||
* AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
*/
|
||||
package com.vitorpamplona.quartz.nipACWebRtcCalls.tags
|
||||
|
||||
import com.vitorpamplona.quartz.nip01Core.core.has
|
||||
import com.vitorpamplona.quartz.utils.ensure
|
||||
|
||||
class CallIdTag {
|
||||
companion object {
|
||||
const val TAG_NAME = "call-id"
|
||||
|
||||
fun parse(tag: Array<String>): String? {
|
||||
ensure(tag.has(1)) { return null }
|
||||
ensure(tag[0] == TAG_NAME) { return null }
|
||||
ensure(tag[1].isNotEmpty()) { return null }
|
||||
return tag[1]
|
||||
}
|
||||
|
||||
fun assemble(callId: String) = arrayOf(TAG_NAME, callId)
|
||||
}
|
||||
}
|
||||
+55
@@ -0,0 +1,55 @@
|
||||
/*
|
||||
* Copyright (c) 2025 Vitor Pamplona
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
* this software and associated documentation files (the "Software"), to deal in
|
||||
* the Software without restriction, including without limitation the rights to use,
|
||||
* copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
|
||||
* Software, and to permit persons to whom the Software is furnished to do so,
|
||||
* subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in all
|
||||
* copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
|
||||
* AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
*/
|
||||
package com.vitorpamplona.quartz.nipACWebRtcCalls.tags
|
||||
|
||||
import com.vitorpamplona.quartz.nip01Core.core.has
|
||||
import com.vitorpamplona.quartz.utils.ensure
|
||||
|
||||
enum class CallType(
|
||||
val value: String,
|
||||
) {
|
||||
VOICE("voice"),
|
||||
VIDEO("video"),
|
||||
;
|
||||
|
||||
companion object {
|
||||
fun fromString(value: String): CallType? =
|
||||
when (value) {
|
||||
"voice" -> VOICE
|
||||
"video" -> VIDEO
|
||||
else -> null
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
class CallTypeTag {
|
||||
companion object {
|
||||
const val TAG_NAME = "call-type"
|
||||
|
||||
fun parse(tag: Array<String>): CallType? {
|
||||
ensure(tag.has(1)) { return null }
|
||||
ensure(tag[0] == TAG_NAME) { return null }
|
||||
return CallType.fromString(tag[1])
|
||||
}
|
||||
|
||||
fun assemble(callType: CallType) = arrayOf(TAG_NAME, callType.value)
|
||||
}
|
||||
}
|
||||
+28
@@ -0,0 +1,28 @@
|
||||
/*
|
||||
* Copyright (c) 2025 Vitor Pamplona
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
* this software and associated documentation files (the "Software"), to deal in
|
||||
* the Software without restriction, including without limitation the rights to use,
|
||||
* copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
|
||||
* Software, and to permit persons to whom the Software is furnished to do so,
|
||||
* subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in all
|
||||
* copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
|
||||
* AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
*/
|
||||
package com.vitorpamplona.quartz.nipACWebRtcCalls.tags
|
||||
|
||||
import com.vitorpamplona.quartz.nip01Core.core.Event
|
||||
import com.vitorpamplona.quartz.nip01Core.core.TagArrayBuilder
|
||||
|
||||
fun <T : Event> TagArrayBuilder<T>.callId(callId: String) = addUnique(CallIdTag.assemble(callId))
|
||||
|
||||
fun <T : Event> TagArrayBuilder<T>.callType(callType: CallType) = addUnique(CallTypeTag.assemble(callType))
|
||||
@@ -252,6 +252,12 @@ import com.vitorpamplona.quartz.nip99Classifieds.ClassifiedsEvent
|
||||
import com.vitorpamplona.quartz.nipA0VoiceMessages.VoiceEvent
|
||||
import com.vitorpamplona.quartz.nipA0VoiceMessages.VoiceReplyEvent
|
||||
import com.vitorpamplona.quartz.nipA4PublicMessages.PublicMessageEvent
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.events.CallAnswerEvent
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.events.CallHangupEvent
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.events.CallIceCandidateEvent
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.events.CallOfferEvent
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.events.CallRejectEvent
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.events.CallRenegotiateEvent
|
||||
import com.vitorpamplona.quartz.nipB0WebBookmarks.WebBookmarkEvent
|
||||
import com.vitorpamplona.quartz.nipB7Blossom.BlossomAuthorizationEvent
|
||||
import com.vitorpamplona.quartz.nipB7Blossom.BlossomServersEvent
|
||||
@@ -311,6 +317,12 @@ class EventFactory {
|
||||
CalendarEvent.KIND -> CalendarEvent(id, pubKey, createdAt, tags, content, sig)
|
||||
CalendarTimeSlotEvent.KIND -> CalendarTimeSlotEvent(id, pubKey, createdAt, tags, content, sig)
|
||||
CalendarRSVPEvent.KIND -> CalendarRSVPEvent(id, pubKey, createdAt, tags, content, sig)
|
||||
CallAnswerEvent.KIND -> CallAnswerEvent(id, pubKey, createdAt, tags, content, sig)
|
||||
CallHangupEvent.KIND -> CallHangupEvent(id, pubKey, createdAt, tags, content, sig)
|
||||
CallIceCandidateEvent.KIND -> CallIceCandidateEvent(id, pubKey, createdAt, tags, content, sig)
|
||||
CallOfferEvent.KIND -> CallOfferEvent(id, pubKey, createdAt, tags, content, sig)
|
||||
CallRejectEvent.KIND -> CallRejectEvent(id, pubKey, createdAt, tags, content, sig)
|
||||
CallRenegotiateEvent.KIND -> CallRenegotiateEvent(id, pubKey, createdAt, tags, content, sig)
|
||||
CashuMintEvent.KIND -> CashuMintEvent(id, pubKey, createdAt, tags, content, sig)
|
||||
CashuMintQuoteEvent.KIND -> CashuMintQuoteEvent(id, pubKey, createdAt, tags, content, sig)
|
||||
CashuTokenEvent.KIND -> CashuTokenEvent(id, pubKey, createdAt, tags, content, sig)
|
||||
|
||||
+191
@@ -0,0 +1,191 @@
|
||||
/*
|
||||
* Copyright (c) 2025 Vitor Pamplona
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
* this software and associated documentation files (the "Software"), to deal in
|
||||
* the Software without restriction, including without limitation the rights to use,
|
||||
* copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
|
||||
* Software, and to permit persons to whom the Software is furnished to do so,
|
||||
* subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in all
|
||||
* copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
|
||||
* AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
*/
|
||||
package com.vitorpamplona.quartz.nipACWebRtcCalls
|
||||
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.events.CallAnswerEvent
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.events.CallHangupEvent
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.events.CallIceCandidateEvent
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.events.CallOfferEvent
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.events.CallRejectEvent
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.events.CallRenegotiateEvent
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.tags.CallType
|
||||
import kotlin.test.Test
|
||||
import kotlin.test.assertEquals
|
||||
|
||||
class CallEventsTest {
|
||||
@Test
|
||||
fun callOfferEventHasCorrectKind() {
|
||||
assertEquals(25050, CallOfferEvent.KIND)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun callAnswerEventHasCorrectKind() {
|
||||
assertEquals(25051, CallAnswerEvent.KIND)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun callIceCandidateEventHasCorrectKind() {
|
||||
assertEquals(25052, CallIceCandidateEvent.KIND)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun callHangupEventHasCorrectKind() {
|
||||
assertEquals(25053, CallHangupEvent.KIND)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun callRejectEventHasCorrectKind() {
|
||||
assertEquals(25054, CallRejectEvent.KIND)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun callRenegotiateEventHasCorrectKind() {
|
||||
assertEquals(25055, CallRenegotiateEvent.KIND)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun callOfferBuildIncludesCallIdTag() {
|
||||
val template =
|
||||
CallOfferEvent.build(
|
||||
sdpOffer = "v=0\r\n...",
|
||||
calleePubKey = "abc123",
|
||||
callId = "test-call-id",
|
||||
type = CallType.VOICE,
|
||||
)
|
||||
assertEquals(CallOfferEvent.KIND, template.kind)
|
||||
assertEquals("v=0\r\n...", template.content)
|
||||
|
||||
val callIdTag = template.tags.firstOrNull { it[0] == "call-id" }
|
||||
assertEquals("test-call-id", callIdTag?.get(1))
|
||||
}
|
||||
|
||||
@Test
|
||||
fun callOfferBuildIncludesCallTypeTag() {
|
||||
val template =
|
||||
CallOfferEvent.build(
|
||||
sdpOffer = "sdp",
|
||||
calleePubKey = "abc123",
|
||||
callId = "id",
|
||||
type = CallType.VIDEO,
|
||||
)
|
||||
val callTypeTag = template.tags.firstOrNull { it[0] == "call-type" }
|
||||
assertEquals("video", callTypeTag?.get(1))
|
||||
}
|
||||
|
||||
@Test
|
||||
fun callOfferBuildIncludesPTag() {
|
||||
val template =
|
||||
CallOfferEvent.build(
|
||||
sdpOffer = "sdp",
|
||||
calleePubKey = "recipient-hex-key",
|
||||
callId = "id",
|
||||
type = CallType.VOICE,
|
||||
)
|
||||
val pTag = template.tags.firstOrNull { it[0] == "p" }
|
||||
assertEquals("recipient-hex-key", pTag?.get(1))
|
||||
}
|
||||
|
||||
@Test
|
||||
fun callOfferBuildIncludesExpirationTag() {
|
||||
val template =
|
||||
CallOfferEvent.build(
|
||||
sdpOffer = "sdp",
|
||||
calleePubKey = "abc",
|
||||
callId = "id",
|
||||
type = CallType.VOICE,
|
||||
createdAt = 1000L,
|
||||
)
|
||||
val expirationTag = template.tags.firstOrNull { it[0] == "expiration" }
|
||||
assertEquals((1000L + CallOfferEvent.EXPIRATION_SECONDS).toString(), expirationTag?.get(1))
|
||||
}
|
||||
|
||||
@Test
|
||||
fun callOfferExpirationIs20Seconds() {
|
||||
assertEquals(20L, CallOfferEvent.EXPIRATION_SECONDS)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun callAnswerBuildContainsSdp() {
|
||||
val template =
|
||||
CallAnswerEvent.build(
|
||||
sdpAnswer = "answer-sdp",
|
||||
callerPubKey = "caller",
|
||||
callId = "call-1",
|
||||
)
|
||||
assertEquals("answer-sdp", template.content)
|
||||
assertEquals(CallAnswerEvent.KIND, template.kind)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun callIceCandidateBuildContainsJson() {
|
||||
val candidateJson = """{"candidate":"candidate:1","sdpMid":"0","sdpMLineIndex":0}"""
|
||||
val template =
|
||||
CallIceCandidateEvent.build(
|
||||
candidateJson = candidateJson,
|
||||
peerPubKey = "peer",
|
||||
callId = "call-1",
|
||||
)
|
||||
assertEquals(candidateJson, template.content)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun callHangupBuildAllowsEmptyReason() {
|
||||
val template =
|
||||
CallHangupEvent.build(
|
||||
peerPubKey = "peer",
|
||||
callId = "call-1",
|
||||
)
|
||||
assertEquals("", template.content)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun callHangupBuildAllowsCustomReason() {
|
||||
val template =
|
||||
CallHangupEvent.build(
|
||||
peerPubKey = "peer",
|
||||
callId = "call-1",
|
||||
reason = "busy",
|
||||
)
|
||||
assertEquals("busy", template.content)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun callRejectBuildHasCorrectKind() {
|
||||
val template =
|
||||
CallRejectEvent.build(
|
||||
callerPubKey = "caller",
|
||||
callId = "call-1",
|
||||
)
|
||||
assertEquals(CallRejectEvent.KIND, template.kind)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun callRenegotiateBuildContainsSdp() {
|
||||
val template =
|
||||
CallRenegotiateEvent.build(
|
||||
sdpOffer = "new-sdp-offer",
|
||||
peerPubKey = "peer",
|
||||
callId = "call-1",
|
||||
)
|
||||
assertEquals("new-sdp-offer", template.content)
|
||||
assertEquals(CallRenegotiateEvent.KIND, template.kind)
|
||||
}
|
||||
}
|
||||
+131
@@ -0,0 +1,131 @@
|
||||
/*
|
||||
* Copyright (c) 2025 Vitor Pamplona
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
* this software and associated documentation files (the "Software"), to deal in
|
||||
* the Software without restriction, including without limitation the rights to use,
|
||||
* copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
|
||||
* Software, and to permit persons to whom the Software is furnished to do so,
|
||||
* subject to the following conditions:
|
||||
*
|
||||
* The above copyright notice and this permission notice shall be included in all
|
||||
* copies or substantial portions of the Software.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
|
||||
* AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
*/
|
||||
package com.vitorpamplona.quartz.nipACWebRtcCalls
|
||||
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.tags.CallIdTag
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.tags.CallType
|
||||
import com.vitorpamplona.quartz.nipACWebRtcCalls.tags.CallTypeTag
|
||||
import kotlin.test.Test
|
||||
import kotlin.test.assertEquals
|
||||
import kotlin.test.assertNotNull
|
||||
import kotlin.test.assertNull
|
||||
|
||||
class CallTagsTest {
|
||||
@Test
|
||||
fun parseCallIdTag() {
|
||||
val tag = arrayOf("call-id", "550e8400-e29b-41d4-a716-446655440000")
|
||||
val result = CallIdTag.parse(tag)
|
||||
assertNotNull(result)
|
||||
assertEquals("550e8400-e29b-41d4-a716-446655440000", result)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun parseCallIdTagRejectsEmpty() {
|
||||
val tag = arrayOf("call-id", "")
|
||||
assertNull(CallIdTag.parse(tag))
|
||||
}
|
||||
|
||||
@Test
|
||||
fun parseCallIdTagRejectsMissingValue() {
|
||||
val tag = arrayOf("call-id")
|
||||
assertNull(CallIdTag.parse(tag))
|
||||
}
|
||||
|
||||
@Test
|
||||
fun parseCallIdTagRejectsWrongName() {
|
||||
val tag = arrayOf("other", "some-id")
|
||||
assertNull(CallIdTag.parse(tag))
|
||||
}
|
||||
|
||||
@Test
|
||||
fun assembleCallIdTag() {
|
||||
val tag = CallIdTag.assemble("test-id-123")
|
||||
assertEquals("call-id", tag[0])
|
||||
assertEquals("test-id-123", tag[1])
|
||||
}
|
||||
|
||||
@Test
|
||||
fun roundTripCallIdTag() {
|
||||
val original = "550e8400-e29b-41d4-a716-446655440000"
|
||||
val assembled = CallIdTag.assemble(original)
|
||||
val parsed = CallIdTag.parse(assembled)
|
||||
assertEquals(original, parsed)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun parseCallTypeVoice() {
|
||||
val tag = arrayOf("call-type", "voice")
|
||||
val result = CallTypeTag.parse(tag)
|
||||
assertNotNull(result)
|
||||
assertEquals(CallType.VOICE, result)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun parseCallTypeVideo() {
|
||||
val tag = arrayOf("call-type", "video")
|
||||
val result = CallTypeTag.parse(tag)
|
||||
assertNotNull(result)
|
||||
assertEquals(CallType.VIDEO, result)
|
||||
}
|
||||
|
||||
@Test
|
||||
fun parseCallTypeRejectsUnknown() {
|
||||
val tag = arrayOf("call-type", "screenshare")
|
||||
assertNull(CallTypeTag.parse(tag))
|
||||
}
|
||||
|
||||
@Test
|
||||
fun parseCallTypeRejectsMissing() {
|
||||
val tag = arrayOf("call-type")
|
||||
assertNull(CallTypeTag.parse(tag))
|
||||
}
|
||||
|
||||
@Test
|
||||
fun assembleCallTypeVoice() {
|
||||
val tag = CallTypeTag.assemble(CallType.VOICE)
|
||||
assertEquals("call-type", tag[0])
|
||||
assertEquals("voice", tag[1])
|
||||
}
|
||||
|
||||
@Test
|
||||
fun assembleCallTypeVideo() {
|
||||
val tag = CallTypeTag.assemble(CallType.VIDEO)
|
||||
assertEquals("call-type", tag[0])
|
||||
assertEquals("video", tag[1])
|
||||
}
|
||||
|
||||
@Test
|
||||
fun roundTripCallType() {
|
||||
for (type in CallType.entries) {
|
||||
val assembled = CallTypeTag.assemble(type)
|
||||
val parsed = CallTypeTag.parse(assembled)
|
||||
assertEquals(type, parsed)
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
fun callTypeFromString() {
|
||||
assertEquals(CallType.VOICE, CallType.fromString("voice"))
|
||||
assertEquals(CallType.VIDEO, CallType.fromString("video"))
|
||||
assertNull(CallType.fromString("audio"))
|
||||
assertNull(CallType.fromString(""))
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user