Access Scopes

import { Wallet } from 'ethers';
import {
  DeriveClient,
  OffchainScope,
  ProtocolScopeCode,
} from '@derivexyz/derive-ts';

const client = new DeriveClient({
  network: 'testnet',
  wallet: process.env.PRIVATE_KEY!,
});

// set_session_key is an action-signed private call: open and authenticate first.
await client.connect();
await client.login();

// Generate the key locally — only its address is registered.
const sessionKey = Wallet.createRandom();

const created = await client.sessionKeys.set({
  publicSessionKey: sessionKey,
  expirySec: Math.floor(Date.now() / 1000) + 30 * 24 * 3600, // the KEY's lifetime: 30 days
  protocolScopes: [
    ProtocolScopeCode.TradeOrderbookAll,
    ProtocolScopeCode.TradeRfqOption,
  ],
  offchainScopes: [OffchainScope.AccountInfo],
  label: 'trading-bot',
});

// The ack echoes exactly what the key holds — there is no implicit default:
console.log(created.protocol_scopes); // ['trade:orderbook:all', 'trade:rfq:option']
console.log(created.offchain_scopes); // ['account_info']

import asyncio
import time

from eth_account import Account

from derive_py import WebSocketClient
from derive_py.data_types import OffchainScope, ProtocolScope


async def main():
    client = WebSocketClient.from_env()
    # set_session_key is an action-signed private call: connect first.
    await client.connect()

    # Generate the key locally — only its address is registered.
    session_wallet = Account.create()

    created = await client.account.set_session_key(
        public_session_key=session_wallet.address,
        expiry_sec=int(time.time()) + 30 * 24 * 3600,  # the KEY's lifetime: 30 days
        protocol_scopes=[
            ProtocolScope.TRADE_ORDERBOOK_ALL,
            ProtocolScope.TRADE_RFQ_OPTION,
        ],
        offchain_scopes=[OffchainScope.ACCOUNT_INFO],
        label="trading-bot",
    )

    # The ack echoes exactly what the key holds — there is no implicit default:
    print(created.protocol_scopes)  # ['trade:orderbook:all', 'trade:rfq:option']
    print(created.offchain_scopes)  # ['account_info']

    await client.disconnect()


asyncio.run(main())

use alloy::signers::local::PrivateKeySigner;
use derive_rs::{
    Environment, WsClient,
    actions::session_key::{OffChainScope, ProtocolScope, SetSessionKeyArgs},
};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = WsClient::new(
        Environment::Testnet,
        Some(std::env::var("DERIVE_PRIVATE_KEY")?),
        Some(std::env::var("DERIVE_WALLET")?),
        Some(9),
    )
    .await?;
    // set_session_key is an action-signed private call: authenticate first.
    client.login().await?;

    // Generate the key locally — only its address is registered.
    let session_signer = PrivateKeySigner::random();
    let expiry_sec = chrono::Utc::now().timestamp() as u64 + 30 * 24 * 3600;

    let args = SetSessionKeyArgs::builder()
        .public_session_key(session_signer.address().to_string())
        .expiry_second(expiry_sec) // the KEY's lifetime: 30 days
        .protocol_scopes(vec![
            ProtocolScope::TradeOrderbookAll,
            ProtocolScope::TradeRfqOption,
        ])
        .off_chain_scopes(vec![OffChainScope::AccountInfo])
        .label("trading-bot".to_string())
        .subaccount_ids(vec![9])
        .build();

    let created = client.session_keys().create(args).await?;

    // The ack echoes exactly what the key holds — there is no implicit default:
    println!("{:?}", created.protocol_scopes); // ["trade:orderbook:all", "trade:rfq:option"]
    println!("{:?}", created.offchain_scopes); // ["account_info"]
    Ok(())
}

# Body nonce/signature: EIP-712 action signing under the set-session-key
# module (see /action-signing). X-Derive* headers: session auth (see /json-rpc).
curl -X POST https://api.derive.xyz/v3/private/set_session_key \
  -H "Content-Type: application/json" \
  -H "X-DeriveWallet: $WALLET_ADDRESS" \
  -H "X-DeriveTimestamp: $TS" \
  -H "X-DeriveSignature: $SIG" \
  -d '{
    "wallet": "0xYourWallet",
    "public_session_key": "0xSessionKeyAddress",
    "expiry_sec": 1733592000,
    "subaccount_ids": null,
    "nonce": "1730999700000123000",
    "signature_expiry_sec": 1731000600,
    "signer": "0xYourWallet",
    "signature": "0x…",
    "protocol_scopes": ["trade:orderbook:all", "trade:rfq:option"],
    "offchain_scopes": ["account_info"],
    "label": "trading-bot"
  }'