Add subnet routing and source binding

Author: bitprecipice

api_sn.go

@@ -93,6 +93,7 @@ func (self *Api) VerifyKeysSync() (*VerifyKeysResult, error) {
 
 type SnSetWalletArgs struct {
 	ColdkeySs58 string `json:"coldkey_ss58"`
+	ClientId    *Id    `json:"client_id,omitempty"`
 }
 
 type SnSetWalletError struct {
@@ -131,6 +132,10 @@ type SnPoolClaimArgs struct {
 	Epoch int64 `json:"epoch"`
 }
 
+type SnPoolClaimError struct {
+	Message string `json:"message"`
+}
+
 // SnPoolClaimResult is a merkle claim against the payout pool.
 //
 // The epoch/chain/block numbers are int64 rather than uint64 so they bind:
@@ -145,11 +150,15 @@ type SnPoolClaimResult struct {
 	// Must stay [][]byte: each element marshals to a base64 json string, so
 	// retyping would change the wire format. Bound via GetProof() below.
 	//gomobile:noexport [][]byte — bound via GetProof()
-	Proof           [][]byte `json:"proof"`
-	PayoutRoot      []byte   `json:"payout_root"`
-	ContractAddress string   `json:"contract_address"`
-	ChainId         int64    `json:"chain_id"`
-	ClaimOpenBlock  int64    `json:"claim_open_block"`
+	Proof                  [][]byte          `json:"proof"`
+	PayoutRoot             []byte            `json:"payout_root"`
+	ContractAddress        string            `json:"contract_address"`
+	ChainId                int64             `json:"chain_id"`
+	ClaimOpenBlock         int64             `json:"claim_open_block"`
+	ArtifactHash           string            `json:"artifact_hash,omitempty"`
+	ArtifactUri            string            `json:"artifact_uri,omitempty"`
+	SettlementVaultAddress string            `json:"settlement_vault_address,omitempty"`
+	Error                  *SnPoolClaimError `json:"error,omitempty"`
 }
 
 // GetProofLen and GetProofAt are the app-facing accessors for the merkle

api_sn_test.go

@@ -51,6 +51,9 @@ func TestApiSubnetHeadlessBindings(t *testing.T) {
 			if args.ColdkeySs58 != "coldkey" {
 				t.Errorf("wallet coldkey = %q, want coldkey", args.ColdkeySs58)
 			}
+			if args.ClientId == nil || args.ClientId.IdStr != clientId.IdStr {
+				t.Errorf("wallet client id = %+v, want %s", args.ClientId, clientId.IdStr)
+			}
 			fmt.Fprint(w, `{}`)
 		case "/sn/pool/claim":
 			if r.Method != http.MethodGet {
@@ -60,7 +63,7 @@ func TestApiSubnetHeadlessBindings(t *testing.T) {
 			if got := r.URL.Query().Get("epoch"); got != "42" {
 				t.Errorf("pool claim epoch = %q, want 42", got)
 			}
-			fmt.Fprint(w, `{"epoch":42,"no_id":"AQI=","coldkey":"AwQ=","share_bps":2500,"proof":["BQY="],"payout_root":"Bw==","contract_address":"0xabc","chain_id":9,"claim_open_block":100}`)
+			fmt.Fprint(w, `{"epoch":42,"no_id":"AQI=","coldkey":"AwQ=","share_bps":2500,"proof":["BQY="],"payout_root":"Bw==","contract_address":"0xabc","chain_id":9,"claim_open_block":100,"artifact_hash":"sha256:0123","artifact_uri":"https://no.example/sn/artifacts/sha256:0123","settlement_vault_address":"0xvault","error":{"message":"claim not open"}}`)
 		case "/sn/epoch":
 			if r.Method != http.MethodGet {
 				t.Errorf("epoch method = %s, want GET", r.Method)
@@ -95,7 +98,7 @@ func TestApiSubnetHeadlessBindings(t *testing.T) {
 		t.Fatalf("verify keys result = %+v, want decoded key 7", keysResult.Keys)
 	}
 
-	walletResult, err := api.SnSetWalletSyncWithContext(ctx, &SnSetWalletArgs{ColdkeySs58: "coldkey"})
+	walletResult, err := api.SnSetWalletSyncWithContext(ctx, &SnSetWalletArgs{ColdkeySs58: "coldkey", ClientId: clientId})
 	if err != nil {
 		t.Fatal(err)
 	}
@@ -110,6 +113,12 @@ func TestApiSubnetHeadlessBindings(t *testing.T) {
 	if claimResult.Epoch != 42 || claimResult.ShareBps != 2500 || claimResult.ContractAddress != "0xabc" || claimResult.ChainId != 9 {
 		t.Fatalf("pool claim result = %+v", claimResult)
 	}
+	if claimResult.ArtifactHash != "sha256:0123" || claimResult.ArtifactUri != "https://no.example/sn/artifacts/sha256:0123" || claimResult.SettlementVaultAddress != "0xvault" {
+		t.Fatalf("pool claim artifact fields = %+v", claimResult)
+	}
+	if claimResult.Error == nil || claimResult.Error.Message != "claim not open" {
+		t.Fatalf("pool claim error = %+v", claimResult.Error)
+	}
 	if string(claimResult.NoId) != string([]byte{1, 2}) || len(claimResult.Proof) != 1 || string(claimResult.Proof[0]) != string([]byte{5, 6}) {
 		t.Fatalf("pool claim byte fields were not decoded: %+v", claimResult)
 	}

device_local.go

@@ -504,6 +504,13 @@ type DeviceLocalSettings struct {
 	//gomobile:noexport connect.MultiClientIdentityStore is an interface from
 	// another package, which gomobile does not bind. Go/headless hosts only.
 	MultiClientIdentityStore connect.MultiClientIdentityStore
+	// ProviderDialContextSettings, when set, is applied only to the exit NAT's
+	// TCP and UDP sockets. Headless integration harnesses use it to bind each
+	// provider to a distinct loopback source address while exercising the real
+	// tunnel stack on one host. Ordinary applications leave it nil.
+	//
+	//gomobile:noexport Go-only network dial seam.
+	ProviderDialContextSettings *connect.DialContextSettings
 	// FIXME remove EnableRpc. Turn on RPC when RPC connections are set (receive net.Conn, send net.Conn)
 	EnableRpc bool
 	// KeyMaterial, when set, is applied to `ClientSettings` at construction
@@ -3181,9 +3188,19 @@ func (self *DeviceLocal) applyProvideMemorySharesWithLock(provideActive bool) {
 	}
 }
 
-func providerLocalUserNatSettings(memoryTargetByteCount ByteCount, log connect.Logger) *connect.LocalUserNatSettings {
+func providerLocalUserNatSettings(
+	memoryTargetByteCount ByteCount,
+	log connect.Logger,
+	dialContextSettings ...*connect.DialContextSettings,
+) *connect.LocalUserNatSettings {
 	localUserNatSettings := connect.DefaultProviderLocalUserNatSettingsWithMemoryTarget(memoryTargetByteCount)
 	localUserNatSettings.Log = log
+	if len(dialContextSettings) != 0 && dialContextSettings[0] != nil {
+		// Both protocols must expose the same address identity. ICMP uses a
+		// platform-specific packet backend and is not involved in /verify.
+		localUserNatSettings.TcpBufferSettings.DialContextSettings = dialContextSettings[0]
+		localUserNatSettings.UdpBufferSettings.DialContextSettings = dialContextSettings[0]
+	}
 	return localUserNatSettings
 }
 
@@ -3221,7 +3238,11 @@ func (self *DeviceLocal) setProvideModeWithLock(provideMode ProvideMode) (change
 				// this avoid connection disruptions
 				if self.remoteUserNatProviderLocalUserNat == nil {
 					_, _, providerShareByteCount := deviceMemoryShares(self.settings)
-					localUserNatSettings := providerLocalUserNatSettings(providerShareByteCount, self.log)
+					localUserNatSettings := providerLocalUserNatSettings(
+						providerShareByteCount,
+						self.log,
+						self.settings.ProviderDialContextSettings,
+					)
 					self.remoteUserNatProviderLocalUserNat = connect.NewLocalUserNat(client.Ctx(), self.clientId.String(), localUserNatSettings)
 				}
 				if self.remoteUserNatProvider == nil {

device_local_memory_test.go

@@ -2,7 +2,9 @@ package sdk
 
 import (
 	"context"
+	"errors"
 	"math"
+	"net"
 	"runtime/debug"
 	"testing"
 
@@ -306,6 +308,20 @@ func TestProviderLocalUserNatSettings(t *testing.T) {
 	connect.AssertEqual(t, settings.TcpBufferSettings.GlobalLimit, 0)
 }
 
+func TestProviderLocalUserNatSettingsAppliesExitDialerOnlyToTCPAndUDP(t *testing.T) {
+	dial := &connect.DialContextSettings{DialContext: func(context.Context, string, string) (net.Conn, error) {
+		return nil, errors.New("test dial")
+	}}
+	settings := providerLocalUserNatSettings(0, connect.NewNoopLogger(), dial)
+	if settings.TcpBufferSettings.DialContextSettings != dial || settings.UdpBufferSettings.DialContextSettings != dial {
+		t.Fatal("provider exit dialer was not applied to TCP and UDP")
+	}
+	plain := providerLocalUserNatSettings(0, connect.NewNoopLogger())
+	if plain.TcpBufferSettings.DialContextSettings != nil || plain.UdpBufferSettings.DialContextSettings != nil {
+		t.Fatal("ordinary provider settings unexpectedly install a custom dialer")
+	}
+}
+
 // TestDeviceLocalProvideMemoryRealloc verifies the provider share of the
 // device memory target follows the provide state: while providing is off it
 // backs the client pair; enabling provide moves it to the provider pair and