coinbase-api 1.1.0 → 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +12 -6
  2. package/llms.txt +10101 -0
  3. package/package.json +3 -2
package/README.md CHANGED
@@ -119,7 +119,7 @@ const advancedTradeCdpAPIKey = {
119
119
  '-----BEGIN EC PRIVATE KEY-----\nADFGHmkgnjdfg16k165kuu1kdtyudtyjdtyjytj/ADFGHmkgnjdfg16k165kuu1kdtyudtyjdtyjytj+oAoGCCqGSM49\nAwEHoUQDQgAEhtAep/ADFGHmkgnjdfg16k165kuu1kdtyudtyjdtyjytj+bzduY3iYXEmj/KtCk\nADFGHmkgnjdfg16k165kuu1kdtyudtyjdtyjytj\n-----END EC PRIVATE KEY-----\n',
120
120
  };
121
121
 
122
- /*
122
+ /*
123
123
  * You can add ECDSA keys like the example above, or ED25519 keys like the example below.
124
124
  * Client will recognize both types of keys automatically.
125
125
  * ED25519:
@@ -127,7 +127,7 @@ const advancedTradeCdpAPIKey = {
127
127
  * name: 'your-api-key-id',
128
128
  * privateKey: 'yourExampleApiSecretEd25519Version==',
129
129
  * }
130
- */
130
+ */
131
131
 
132
132
  const client = new CBAdvancedTradeClient({
133
133
  // Either pass the full JSON object that can be downloaded when creating your API keys
@@ -168,7 +168,7 @@ const CBAppKeys = {
168
168
  '-----BEGIN EC PRIVATE KEY-----\nADFGHmkgnjdfg16k165kuu1kdtyudtyjdtyjytj/ADFGHmkgnjdfg16k165kuu1kdtyudtyjdtyjytj+oAoGCCqGSM49\nAwEHoUQDQgAEhtAep/ADFGHmkgnjdfg16k165kuu1kdtyudtyjdtyjytj+bzduY3iYXEmj/KtCk\nADFGHmkgnjdfg16k165kuu1kdtyudtyjdtyjytj\n-----END EC PRIVATE KEY-----\n',
169
169
  };
170
170
 
171
- /*
171
+ /*
172
172
  * You can add ECDSA keys like the example above, or ED25519 keys like the example below.
173
173
  * Client will recognize both types of keys automatically.
174
174
  * ED25519:
@@ -176,7 +176,7 @@ const CBAppKeys = {
176
176
  * name: 'your-api-key-id',
177
177
  * privateKey: 'yourExampleApiSecretEd25519Version==',
178
178
  * }
179
- */
179
+ */
180
180
 
181
181
  const client = new CBAppClient({
182
182
  // Either pass the full JSON object that can be downloaded when creating your API keys
@@ -320,7 +320,7 @@ const advancedTradeCdpAPIKey = {
320
320
  '-----BEGIN EC PRIVATE KEY-----\nADFGHmkgnjdfg16k165kuu1kdtyudtyjdtyjytj/ADFGHmkgnjdfg16k165kuu1kdtyudtyjdtyjytj+oAoGCCqGSM49\nAwEHoUQDQgAEhtAep/ADFGHmkgnjdfg16k165kuu1kdtyudtyjdtyjytj+bzduY3iYXEmj/KtCk\nADFGHmkgnjdfg16k165kuu1kdtyudtyjdtyjytj\n-----END EC PRIVATE KEY-----\n',
321
321
  };
322
322
 
323
- /*
323
+ /*
324
324
  * You can add ECDSA keys like the example above, or ED25519 keys like the example below.
325
325
  * Client will recognize both types of keys automatically.
326
326
  * ED25519:
@@ -328,7 +328,7 @@ const advancedTradeCdpAPIKey = {
328
328
  * name: 'your-api-key-id',
329
329
  * privateKey: 'yourExampleApiSecretEd25519Version==',
330
330
  * }
331
- */
331
+ */
332
332
 
333
333
  const client = new WebsocketClient({
334
334
  // Either pass the full JSON object that can be downloaded when creating your API keys
@@ -496,6 +496,12 @@ const ws = new WebsocketClient(
496
496
  );
497
497
  ```
498
498
 
499
+ ## Use with LLMs & AI
500
+
501
+ This SDK includes a bundled `llms.txt` file in the root of the repository. If you're developing with LLMs, use the included `llms.txt` with your LLM - it will significantly improve the LLMs understanding of how to correctly use this SDK.
502
+
503
+ This file contains AI optimised structure of all the functions in this package, and their parameters for easier use with any learning models or artificial intelligence.
504
+
499
505
  ---
500
506
 
501
507
  <!-- template_contributions -->