Interface TraderConstructorArgs

Constructor arguments for creating a Trader instance.

interface TraderConstructorArgs {
    account: Account;
    authClient: PromiseClient<{
        methods: {
            authenticate: {
                I: typeof Empty;
                O: typeof H160;
                kind: Unary;
                name: "Authenticate";
            };
            geofenced: {
                I: typeof Empty;
                O: typeof BoolValue;
                kind: Unary;
                name: "Geofenced";
            };
            nonce: {
                I: typeof Empty;
                O: typeof NonceText;
                kind: Unary;
                name: "Nonce";
            };
            session: {
                I: typeof Empty;
                O: typeof SiweSession;
                kind: Unary;
                name: "Session";
            };
            signOut: {
                I: typeof Empty;
                O: typeof Empty;
                kind: Unary;
                name: "SignOut";
            };
            verify: {
                I: typeof VerifyText;
                O: typeof H160;
                kind: Unary;
                name: "Verify";
            };
        };
        typeName: "valorem.trade.v1.Auth";
    }>;
    chain: Chain;
    feesClient?: PromiseClient<{
        methods: {
            getFeeStructure: {
                I: typeof Empty;
                O: typeof FeeStructure;
                kind: Unary;
                name: "getFeeStructure";
            };
        };
        typeName: "valorem.trade.v1.Fees";
    }>;
    rfqClient: PromiseClient<{
        methods: {
            maker: {
                I: typeof QuoteResponse;
                O: typeof QuoteRequest;
                kind: BiDiStreaming;
                name: "Maker";
            };
            taker: {
                I: typeof QuoteRequest;
                O: typeof QuoteResponse;
                kind: BiDiStreaming;
                name: "Taker";
            };
            webTaker: {
                I: typeof QuoteRequest;
                O: typeof QuoteResponse;
                kind: ServerStreaming;
                name: "WebTaker";
            };
        };
        typeName: "valorem.trade.v1.RFQ";
    }>;
    spotClient?: PromiseClient<{
        methods: {
            getSpotPrice: {
                I: typeof SpotPriceRequest;
                O: typeof SpotPriceInfo;
                kind: ServerStreaming;
                name: "GetSpotPrice";
            };
        };
        typeName: "valorem.trade.v1.Spot";
    }>;
}

Hierarchy (view full)

ValoremGRPCClients
- TraderConstructorArgs

Index

Properties

account authClient chain feesClient? rfqClient spotClient?

Properties

account

account: Account

authClient

authClient: PromiseClient<{
    methods: {
        authenticate: {
            I: typeof Empty;
            O: typeof H160;
            kind: Unary;
            name: "Authenticate";
        };
        geofenced: {
            I: typeof Empty;
            O: typeof BoolValue;
            kind: Unary;
            name: "Geofenced";
        };
        nonce: {
            I: typeof Empty;
            O: typeof NonceText;
            kind: Unary;
            name: "Nonce";
        };
        session: {
            I: typeof Empty;
            O: typeof SiweSession;
            kind: Unary;
            name: "Session";
        };
        signOut: {
            I: typeof Empty;
            O: typeof Empty;
            kind: Unary;
            name: "SignOut";
        };
        verify: {
            I: typeof VerifyText;
            O: typeof H160;
            kind: Unary;
            name: "Verify";
        };
    };
    typeName: "valorem.trade.v1.Auth";
}>

Type declaration

Readonly methods: {
    authenticate: {
        I: typeof Empty;
        O: typeof H160;
        kind: Unary;
        name: "Authenticate";
    };
    geofenced: {
        I: typeof Empty;
        O: typeof BoolValue;
        kind: Unary;
        name: "Geofenced";
    };
    nonce: {
        I: typeof Empty;
        O: typeof NonceText;
        kind: Unary;
        name: "Nonce";
    };
    session: {
        I: typeof Empty;
        O: typeof SiweSession;
        kind: Unary;
        name: "Session";
    };
    signOut: {
        I: typeof Empty;
        O: typeof Empty;
        kind: Unary;
        name: "SignOut";
    };
    verify: {
        I: typeof VerifyText;
        O: typeof H160;
        kind: Unary;
        name: "Verify";
    };
}
- Readonly authenticate: {
      I: typeof Empty;
      O: typeof H160;
      kind: Unary;
      name: "Authenticate";
  }
  Used to check if a given connection is authenticated, returns the address which is authenticated for a nonce cookie
  
  Generated
  from rpc valorem.trade.v1.Auth.Authenticate
  - Readonly I: typeof Empty
  - Readonly O: typeof H160
  - Readonly kind: Unary
  - Readonly name: "Authenticate"
- Readonly geofenced: {
      I: typeof Empty;
      O: typeof BoolValue;
      kind: Unary;
      name: "Geofenced";
  }
  Used to check if a given connection is geofenced. If access is restricted, returns true, otherwise false.
  
  Generated
  from rpc valorem.trade.v1.Auth.Geofenced
  - Readonly I: typeof Empty
  - Readonly O: typeof BoolValue
  - Readonly kind: Unary
  - Readonly name: "Geofenced"
- Readonly nonce: {
      I: typeof Empty;
      O: typeof NonceText;
      kind: Unary;
      name: "Nonce";
  }
  Returns an EIP-4361 nonce for session and invalidates existing session
  
  Generated
  from rpc valorem.trade.v1.Auth.Nonce
  - Readonly I: typeof Empty
  - Readonly O: typeof NonceText
  - Readonly kind: Unary
  - Readonly name: "Nonce"
- Readonly session: {
      I: typeof Empty;
      O: typeof SiweSession;
      kind: Unary;
      name: "Session";
  }
  Returns the SIWE Session for the request's sessionId
  
  Generated
  from rpc valorem.trade.v1.Auth.Session
  - Readonly I: typeof Empty
  - Readonly O: typeof SiweSession
  - Readonly kind: Unary
  - Readonly name: "Session"
- Readonly signOut: {
      I: typeof Empty;
      O: typeof Empty;
      kind: Unary;
      name: "SignOut";
  }
  Invalidates the session for the request's sessionId
  
  Generated
  from rpc valorem.trade.v1.Auth.SignOut
  - Readonly I: typeof Empty
  - Readonly O: typeof Empty
  - Readonly kind: Unary
  - Readonly name: "SignOut"
- Readonly verify: {
      I: typeof VerifyText;
      O: typeof H160;
      kind: Unary;
      name: "Verify";
  }
  Verifies the SignedMessage is valid and returns the verified address
  
  Generated
  from rpc valorem.trade.v1.Auth.Verify
  - Readonly I: typeof VerifyText
  - Readonly O: typeof H160
  - Readonly kind: Unary
  - Readonly name: "Verify"
Readonly typeName: "valorem.trade.v1.Auth"

chain

chain: Chain

`Optional` feesClient

feesClient?: PromiseClient<{
    methods: {
        getFeeStructure: {
            I: typeof Empty;
            O: typeof FeeStructure;
            kind: Unary;
            name: "getFeeStructure";
        };
    };
    typeName: "valorem.trade.v1.Fees";
}>

Type declaration

Readonly methods: {
    getFeeStructure: {
        I: typeof Empty;
        O: typeof FeeStructure;
        kind: Unary;
        name: "getFeeStructure";
    };
}
- Readonly getFeeStructure: {
      I: typeof Empty;
      O: typeof FeeStructure;
      kind: Unary;
      name: "getFeeStructure";
  }
  Returns the Valorem Fee structure.
  
  Generated
  from rpc valorem.trade.v1.Fees.getFeeStructure
  - Readonly I: typeof Empty
  - Readonly O: typeof FeeStructure
  - Readonly kind: Unary
  - Readonly name: "getFeeStructure"
Readonly typeName: "valorem.trade.v1.Fees"

rfqClient

rfqClient: PromiseClient<{
    methods: {
        maker: {
            I: typeof QuoteResponse;
            O: typeof QuoteRequest;
            kind: BiDiStreaming;
            name: "Maker";
        };
        taker: {
            I: typeof QuoteRequest;
            O: typeof QuoteResponse;
            kind: BiDiStreaming;
            name: "Taker";
        };
        webTaker: {
            I: typeof QuoteRequest;
            O: typeof QuoteResponse;
            kind: ServerStreaming;
            name: "WebTaker";
        };
    };
    typeName: "valorem.trade.v1.RFQ";
}>

Type declaration

Readonly methods: {
    maker: {
        I: typeof QuoteResponse;
        O: typeof QuoteRequest;
        kind: BiDiStreaming;
        name: "Maker";
    };
    taker: {
        I: typeof QuoteRequest;
        O: typeof QuoteResponse;
        kind: BiDiStreaming;
        name: "Taker";
    };
    webTaker: {
        I: typeof QuoteRequest;
        O: typeof QuoteResponse;
        kind: ServerStreaming;
        name: "WebTaker";
    };
}
- Readonly maker: {
      I: typeof QuoteResponse;
      O: typeof QuoteRequest;
      kind: BiDiStreaming;
      name: "Maker";
  }
  Send quotes to takers via a stream of QuoteResponse messages and receive a stream of QuoteRequest messages.
  
  Generated
  from rpc valorem.trade.v1.RFQ.Maker
  - Readonly I: typeof QuoteResponse
  - Readonly O: typeof QuoteRequest
  - Readonly kind: BiDiStreaming
  - Readonly name: "Maker"
- Readonly taker: {
      I: typeof QuoteRequest;
      O: typeof QuoteResponse;
      kind: BiDiStreaming;
      name: "Taker";
  }
  Request quotes from makers via a stream of QuoteRequest messages and receive a stream of QuoteResponse messages.
  
  Generated
  from rpc valorem.trade.v1.RFQ.Taker
  - Readonly I: typeof QuoteRequest
  - Readonly O: typeof QuoteResponse
  - Readonly kind: BiDiStreaming
  - Readonly name: "Taker"
- Readonly webTaker: {
      I: typeof QuoteRequest;
      O: typeof QuoteResponse;
      kind: ServerStreaming;
      name: "WebTaker";
  }
  Request quotes from makers via a single QuoteRequest message and receive a stream of QuoteResponse messages for use by gRPC-web clients.
  
  Generated
  from rpc valorem.trade.v1.RFQ.WebTaker
  - Readonly I: typeof QuoteRequest
  - Readonly O: typeof QuoteResponse
  - Readonly kind: ServerStreaming
  - Readonly name: "WebTaker"
Readonly typeName: "valorem.trade.v1.RFQ"

`Optional` spotClient

spotClient?: PromiseClient<{
    methods: {
        getSpotPrice: {
            I: typeof SpotPriceRequest;
            O: typeof SpotPriceInfo;
            kind: ServerStreaming;
            name: "GetSpotPrice";
        };
    };
    typeName: "valorem.trade.v1.Spot";
}>

Type declaration

Readonly methods: {
    getSpotPrice: {
        I: typeof SpotPriceRequest;
        O: typeof SpotPriceInfo;
        kind: ServerStreaming;
        name: "GetSpotPrice";
    };
}
- Readonly getSpotPrice: {
      I: typeof SpotPriceRequest;
      O: typeof SpotPriceInfo;
      kind: ServerStreaming;
      name: "GetSpotPrice";
  }
  GetSpotPriceStream is a server-streaming RPC. It provides real-time spot prices for a list of tokens across multiple chains.
  
  Parameters: SpotPriceRequest: Contains information about which tokens' spot prices should be fetched on their respective chains. Returns: stream of SpotPriceResponse: Continuously streams data about the spot prices of the requested tokens on their respective chains as updates are available.
  
  Generated
  from rpc valorem.trade.v1.Spot.GetSpotPrice
  - Readonly I: typeof SpotPriceRequest
  - Readonly O: typeof SpotPriceInfo
  - Readonly kind: ServerStreaming
  - Readonly name: "GetSpotPrice"
Readonly typeName: "valorem.trade.v1.Spot"

Interface TraderConstructorArgs

Hierarchy (view full)

Index

Properties

Properties

account

authClient

Type declaration

Readonly authenticate: { I: typeof Empty; O: typeof H160; kind: Unary; name: "Authenticate"; }

Generated

Readonly I: typeof Empty

Readonly O: typeof H160

Readonly kind: Unary

Readonly name: "Authenticate"

Readonly geofenced: { I: typeof Empty; O: typeof BoolValue; kind: Unary; name: "Geofenced"; }

Generated

Readonly I: typeof Empty

Readonly O: typeof BoolValue

Readonly kind: Unary

Readonly name: "Geofenced"

Readonly nonce: { I: typeof Empty; O: typeof NonceText; kind: Unary; name: "Nonce"; }

Generated

Readonly I: typeof Empty

Readonly O: typeof NonceText

Readonly kind: Unary

Readonly name: "Nonce"

Readonly session: { I: typeof Empty; O: typeof SiweSession; kind: Unary; name: "Session"; }

Generated

Readonly I: typeof Empty

Readonly O: typeof SiweSession

Readonly kind: Unary

Readonly name: "Session"

Readonly signOut: { I: typeof Empty; O: typeof Empty; kind: Unary; name: "SignOut"; }

Generated

Readonly I: typeof Empty

Readonly O: typeof Empty

Readonly kind: Unary

Readonly name: "SignOut"

Readonly verify: { I: typeof VerifyText; O: typeof H160; kind: Unary; name: "Verify"; }

Generated

Readonly I: typeof VerifyText

Readonly O: typeof H160

Readonly kind: Unary

Readonly name: "Verify"

Readonly typeName: "valorem.trade.v1.Auth"

chain

Optional feesClient

Type declaration

Readonly methods: { getFeeStructure: { I: typeof Empty; O: typeof FeeStructure; kind: Unary; name: "getFeeStructure"; }; }

Readonly getFeeStructure: { I: typeof Empty; O: typeof FeeStructure; kind: Unary; name: "getFeeStructure"; }

Generated

Readonly I: typeof Empty

Readonly O: typeof FeeStructure

Readonly kind: Unary

Readonly name: "getFeeStructure"

Readonly typeName: "valorem.trade.v1.Fees"

rfqClient

Type declaration

Readonly maker: { I: typeof QuoteResponse; O: typeof QuoteRequest; kind: BiDiStreaming; name: "Maker"; }

Generated

Readonly I: typeof QuoteResponse

Readonly O: typeof QuoteRequest

Readonly kind: BiDiStreaming

Readonly name: "Maker"

Readonly taker: { I: typeof QuoteRequest; O: typeof QuoteResponse; kind: BiDiStreaming; name: "Taker"; }

Generated

Readonly I: typeof QuoteRequest

Readonly O: typeof QuoteResponse

Readonly kind: BiDiStreaming

Readonly name: "Taker"

Readonly webTaker: { I: typeof QuoteRequest; O: typeof QuoteResponse; kind: ServerStreaming; name: "WebTaker"; }

Generated

Readonly I: typeof QuoteRequest

Readonly O: typeof QuoteResponse

Readonly kind: ServerStreaming

Readonly name: "WebTaker"

Readonly typeName: "valorem.trade.v1.RFQ"

Optional spotClient

Type declaration

Readonly methods: { getSpotPrice: { I: typeof SpotPriceRequest; O: typeof SpotPriceInfo; kind: ServerStreaming; name: "GetSpotPrice"; }; }

`Readonly` authenticate: {
I: typeof Empty;
O: typeof H160;
kind: Unary;
name: "Authenticate";
}

`Readonly` I: typeof Empty

`Readonly` O: typeof H160

`Readonly` kind: Unary

`Readonly` name: "Authenticate"

`Readonly` geofenced: {
I: typeof Empty;
O: typeof BoolValue;
kind: Unary;
name: "Geofenced";
}

`Readonly` I: typeof Empty

`Readonly` O: typeof BoolValue

`Readonly` kind: Unary

`Readonly` name: "Geofenced"

`Readonly` nonce: {
I: typeof Empty;
O: typeof NonceText;
kind: Unary;
name: "Nonce";
}

`Readonly` I: typeof Empty

`Readonly` O: typeof NonceText

`Readonly` kind: Unary

`Readonly` name: "Nonce"

`Readonly` session: {
I: typeof Empty;
O: typeof SiweSession;
kind: Unary;
name: "Session";
}

`Readonly` I: typeof Empty

`Readonly` O: typeof SiweSession

`Readonly` kind: Unary

`Readonly` name: "Session"

`Readonly` signOut: {
I: typeof Empty;
O: typeof Empty;
kind: Unary;
name: "SignOut";
}

`Readonly` I: typeof Empty

`Readonly` O: typeof Empty

`Readonly` kind: Unary

`Readonly` name: "SignOut"

`Readonly` verify: {
I: typeof VerifyText;
O: typeof H160;
kind: Unary;
name: "Verify";
}

`Readonly` I: typeof VerifyText

`Readonly` O: typeof H160

`Readonly` kind: Unary

`Readonly` name: "Verify"

`Readonly` typeName: "valorem.trade.v1.Auth"

`Optional` feesClient

`Readonly` methods: {
getFeeStructure: {
I: typeof Empty;
O: typeof FeeStructure;
kind: Unary;
name: "getFeeStructure";
};
}

`Readonly` getFeeStructure: {
I: typeof Empty;
O: typeof FeeStructure;
kind: Unary;
name: "getFeeStructure";
}

`Readonly` I: typeof Empty

`Readonly` O: typeof FeeStructure

`Readonly` kind: Unary

`Readonly` name: "getFeeStructure"

`Readonly` typeName: "valorem.trade.v1.Fees"

`Readonly` maker: {
I: typeof QuoteResponse;
O: typeof QuoteRequest;
kind: BiDiStreaming;
name: "Maker";
}

`Readonly` I: typeof QuoteResponse

`Readonly` O: typeof QuoteRequest

`Readonly` kind: BiDiStreaming

`Readonly` name: "Maker"

`Readonly` taker: {
I: typeof QuoteRequest;
O: typeof QuoteResponse;
kind: BiDiStreaming;
name: "Taker";
}

`Readonly` I: typeof QuoteRequest

`Readonly` O: typeof QuoteResponse

`Readonly` kind: BiDiStreaming

`Readonly` name: "Taker"

`Readonly` webTaker: {
I: typeof QuoteRequest;
O: typeof QuoteResponse;
kind: ServerStreaming;
name: "WebTaker";
}

`Readonly` I: typeof QuoteRequest

`Readonly` O: typeof QuoteResponse

`Readonly` kind: ServerStreaming

`Readonly` name: "WebTaker"

`Readonly` typeName: "valorem.trade.v1.RFQ"

`Optional` spotClient

`Readonly` methods: {
getSpotPrice: {
I: typeof SpotPriceRequest;
O: typeof SpotPriceInfo;
kind: ServerStreaming;
name: "GetSpotPrice";
};
}

`Readonly` getSpotPrice: {
I: typeof SpotPriceRequest;
O: typeof SpotPriceInfo;
kind: ServerStreaming;
name: "GetSpotPrice";
}

`Readonly` I: typeof SpotPriceRequest

`Readonly` O: typeof SpotPriceInfo

`Readonly` kind: ServerStreaming

`Readonly` name: "GetSpotPrice"

`Readonly` typeName: "valorem.trade.v1.Spot"